Skip to content

docs: Clarify the nested config phrasing #721

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

Open
connorshea wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

docs: Clarify the nested config phrasing #721

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/docs/guide/usage/linter/nested-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ editLink: false

# Nested configuration files

It is possible to have multiple configuration files within the same project. Oxlint will automatically detect the presence of these files and use them in addition to the top-level configuration file. Config files must be named `.oxlintrc.json` for nested configuration to work.
It is possible to have multiple configuration files within the same project. Oxlint will automatically detect the presence of these files and use them for nearby files instead of the top-level configuration file. Config files must be named `.oxlintrc.json` for nested configuration to work.

For example, consider the following project structure:

Expand All @@ -27,7 +27,7 @@ Oxlint will always use the nearest configuration file to the file currently bein
- `package1/index.js` will be linted using `my-project/package1/.oxlintrc.json`
- `package2/index.js` will be linted using `my-project/package2/.oxlintrc.json`

Configuration files are not automatically merged, and the configuration in a child configuration file will not affect the parent configuration. However, options passed in the command-line will override any configuration file, regardless of whether it is in the parent or child directory. In addition, using the `--config` option to specify a single file for configuration will disable the use of nested configuration files.
Configuration files are **not automatically merged**, and the configuration in a child configuration file will not affect the parent configuration. However, options passed in the command-line will override any configuration file, regardless of whether it is in the parent or child directory. In addition, using the `--config` option to specify a single file for configuration will disable the use of nested configuration files.

## Extending configuration files

Expand Down
Loading