docs: specifying files with arbitrary or no extension #18539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mdjermanovic
reviewed
Jun 3, 2024
|
|
||
| #### Specifying files without extension | ||
|
|
||
| No simple glob pattern can be used to target only files without extension. |
There was a problem hiding this comment.
A pattern like **/!(*.*) would match only files without extension I believe.
There was a problem hiding this comment.
I think you're right, that seems to do the job 👍🏻
|
ci failing has been fixed in the main branch, can you please rebase it, thanks! |
|
@aladdin-add I rebased to main but the browser test is still failing: https://github.com/eslint/eslint/actions/runs/9352097110/job/25739399981?pr=18539. Any clues? |
|
yes, It's not 100% reproducible, I filed a new issue: #18548 |
nzakas
reviewed
Jun 3, 2024
| @@ -79,7 +79,7 @@ Each configuration object contains all of the information ESLint needs to execut | |||
| Patterns specified in `files` and `ignores` use [`minimatch`](https://www.npmjs.com/package/minimatch) syntax and are evaluated relative to the location of the `eslint.config.js` file. If using an alternate config file via the `--config` command line option, then all patterns are evaluated relative to the current working directory. | |||
| ::: | |||
|
|
|||
| You can use a combination of `files` and `ignores` to determine which files should apply the configuration object and which should not. By default, ESLint matches `**/*.js`, `**/*.cjs`, and `**/*.mjs`. Because config objects that don't specify `files` or `ignores` apply to all files that have been matched by any other configuration object, those config objects apply to any JavaScript files passed to ESLint by default. For example: | |||
| You can use a combination of `files` and `ignores` to determine which files should apply the configuration object and which should not. By default, ESLint matches `**/*.js`, `**/*.cjs`, and `**/*.mjs`. Because config objects that don't specify `files` or `ignores` apply to all files that have been matched by any other configuration object, only JavaScript files are linted by default. For example: | |||
There was a problem hiding this comment.
That last sentence doesn't seem correct to me. JavaScript linted by default isn't a result of config objects without files or ignores. Maybe this?
Suggested change
| You can use a combination of `files` and `ignores` to determine which files should apply the configuration object and which should not. By default, ESLint matches `**/*.js`, `**/*.cjs`, and `**/*.mjs`. Because config objects that don't specify `files` or `ignores` apply to all files that have been matched by any other configuration object, only JavaScript files are linted by default. For example: | |
| You can use a combination of `files` and `ignores` to determine which files should apply the configuration object and which should not. By default, ESLint matches `**/*.js`, `**/*.cjs`, and `**/*.mjs`. so those are always matched unless you explicitly exclude them using `ignores`. Because config objects that don't specify `files` or `ignores` apply to all files that have been matched by any other configuration object, they will apply to all JavaScript files. For example: |
There was a problem hiding this comment.
Yeah, actually it's a result of the default patterns being what they are and also the fact that config objects without files or ignores apply to all linted files. I will elaborate.
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
fasttime
commented
Jun 4, 2024
|
Thanks for the suggestions @nzakas. I did a few changes, please check if it's okay now. |
This was referenced Jul 9, 2024
This was referenced Aug 29, 2024
This was referenced Sep 1, 2024
This was referenced Sep 3, 2024
This was referenced Sep 8, 2024
This was referenced Sep 14, 2024
This was referenced Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Fixes #18475
What changes did you make? (Give an overview)
Added two sections to the configuration files docs explaining how to lint files with a given extension or without extension.
Clarified other parts of the documentation about
filesandignores.Is there anything you'd like reviewers to focus on?