Skip to content

Conversation

mao-sz
Copy link
Contributor

@mao-sz mao-sz commented Jul 4, 2025

Prerequisites checklist

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

[x] 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)

The odd sentence was missed in #19487. This PR brings those parts in line with the current examples which use globalIgnores().

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

@mao-sz mao-sz requested a review from a team as a code owner July 4, 2025 20:41
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Jul 4, 2025
@eslint-github-bot
Copy link

Hi @MaoShizhong!, 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 length of the commit message must be less than or equal to 72

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

Copy link

netlify bot commented Jul 4, 2025

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit de657ff
🔍 Latest deploy log https://app.netlify.com/projects/docs-eslint/deploys/68683c5dbee7af00081ac8f9
😎 Deploy Preview https://deploy-preview-19914--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 project configuration.

@mao-sz mao-sz changed the title docs: fix globalIgnores() paragraphs referencing original ignores approach docs: fix mismatch between globalHelpers() code and text Jul 4, 2025
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Jul 4, 2025
@mao-sz
Copy link
Contributor Author

mao-sz commented Jul 4, 2025

Lines 114-117

::: important
Note that only global `ignores` patterns can match directories.
`ignores` patterns that are specific to a configuration will only match file names.
:::

I believe this note could also be removed from the page in this PR, since the page only concerns globalIgnores() and not the ignores config object property. Just want to double check first if that seems appropriate? If so, I'll remove it too.

@nzakas nzakas changed the title docs: fix mismatch between globalHelpers() code and text docs: fix mismatch between globalIgnores() code and text Jul 7, 2025
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@nzakas nzakas merged commit 40dbe2a into eslint:main Jul 7, 2025
31 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Complete in Triage Jul 7, 2025
@mao-sz mao-sz deleted the global-ignore branch July 7, 2025 18:38
@mao-sz
Copy link
Contributor Author

mao-sz commented Jul 7, 2025

Just realised the title typo, oops!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to ESLint's documentation
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

2 participants