Skip to content

docs: better global ignores instruction #19297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mdjermanovic merged 31 commits into from
Jan 17, 2025
Merged

docs: better global ignores instruction #19297

mdjermanovic merged 31 commits into from
Jan 17, 2025

Conversation

@tresorama
Copy link
Contributor

@tresorama tresorama commented Dec 31, 2024 •
edited
Loading

Overview

Fixes #18304

This PR aims to solve the confusion of the global ignores behavior of eslint.
When someone install eslint, one of the first step he does is to ignore some dirs/files.
Myself, on first try, I wasn't able to do it.
global ignores is tricky, and docs should do a better job.

IMPORTANT - For reviewers

I used some assumption on some eslint behaviors that i'm not sure they are real. I need that a person who knows eslint internal review my text. You can find this in comments
Edit 2025-01-07: addressed all

Out of the scope of this PR but useful

I think that we should merge all section of documentation that explain "ignoring files and directory" to a same page.
Now user need to read both Configuration Files and Ignore page.
Having a single page instead of multiple ones would simplify "links" from other pages of the docs, and avoid duplicating docs updates.
Edit 2025-01-07: we don't do it in this PR, we will maybe do it in a future PR

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

  • Documentation update
  • Bug fix (template)
  • New rule (template)
  • Changes an existing rule (template)
  • Add autofix to a rule
  • Add a CLI option
  • Add something to the core
  • Other, please explain:

What changes did you make? (Give an overview)

  • explain that user must use global ignores features if he wants to ignore files/dir and control the definition in a single place
  • added example

Is there anything you'd like reviewers to focus on?

@eslint-github-bot
Copy link

eslint-github-bot bot commented Dec 31, 2024

Hi @tresorama!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 31, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@netlify
Copy link

netlify bot commented Dec 31, 2024 •
edited
Loading

✅ Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit ca4b806
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/678309ed7fc6800008a95a89
😎 Deploy Preview https://deploy-preview-19297--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@eslint-github-bot
Copy link

eslint-github-bot bot commented Dec 31, 2024

Hi @tresorama!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

1 similar comment
@eslint-github-bot
Copy link

eslint-github-bot bot commented Dec 31, 2024

Hi @tresorama!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@eslint-github-bot
Copy link

eslint-github-bot bot commented Dec 31, 2024

Hi @tresorama!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
  • There should be a space following the initial tag and colon, for example 'feat: Message'.

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@tresorama tresorama changed the title docs/better global ignores instruction docs: better global ignores instruction Dec 31, 2024
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Dec 31, 2024
@tresorama tresorama marked this pull request as ready for review December 31, 2024 19:07
@tresorama tresorama requested a review from a team as a code owner December 31, 2024 19:07
@Tanujkanti4441
Copy link
Contributor

Tanujkanti4441 commented Jan 1, 2025

Hi @tresorama, thanks for the PR, can you also sign the CLA?