Skip to content
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

docs: Improve ignores documentation #17239

Merged
merged 3 commits into from Jun 8, 2023
Merged

docs: Improve ignores documentation #17239

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebc8cbb
docs: Improve `ignores` documentation
fasttime Jun 4, 2023
e4a31db
Another note about `dir/` vs. `dir/**` in non-global patterns
fasttime Jun 5, 2023
a9c00d7
Update docs/src/use/configure/configuration-files-new.md
fasttime Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/src/use/configure/configuration-files-new.md
View file
Open in desktop
Expand Up @@ -116,7 +116,9 @@ export default [

Here, the configuration object excludes files ending with `.config.js` except for `eslint.config.js`. That file still has `semi` applied.

If `ignores` is used without `files` and any other setting, then the configuration object applies to all files except the ones specified in `ignores`, for example:
Non-global `ignores` patterns can only match file names. A pattern like `"dir-to-exclude/"` will not ignore anything. To ignore everything in a particular directory, a pattern like `"dir-to-exclude/**"` should be used instead.

If `ignores` is used without `files` and there are other keys (such as `rules`), then the configuration object applies to all files except the ones specified in `ignores`, for example:

```js
export default [
Expand Down Expand Up @@ -145,6 +147,9 @@ export default [

This configuration specifies that all of the files in the `.config` directory should be ignored. This pattern is added after the default patterns, which are `["**/node_modules/**", ".git/**"]`.

Note that only global `ignores` patterns can ignore or unignore whole directories.
fasttime marked this conversation as resolved.
Show resolved Hide resolved
`ignores` patterns that are specific to a configuration will only match file names.

#### Cascading configuration objects

When more than one configuration object matches a given filename, the configuration objects are merged with later objects overriding previous objects when there is a conflict. For example:
Expand Down