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: document lack of config file names #17442

Merged
merged 3 commits into from Aug 4, 2023
Merged

docs: document lack of config file names #17442

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8da1e40
docs: document lack of config file names
Zamiell Aug 1, 2023
20ef5b7
Update configuration-files-new.md
Zamiell Aug 1, 2023
11c396d
Update docs/src/use/configure/configuration-files-new.md
Zamiell Aug 2, 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
6 changes: 5 additions & 1 deletion docs/src/use/configure/configuration-files-new.md
View file
Open in desktop
Expand Up @@ -58,6 +58,10 @@ module.exports = (async () => {
})();
```

::: warning
ESLint only automatically looks for a config file named `eslint.config.js` and does not look for `eslint.config.cjs` or `eslint.config.mjs`. If you'd like to specify a different config filename than the default, use the `--config` command line option.
:::

## Configuration Objects

Each configuration object contains all of the information ESLint needs to execute on a set of files. Each configuration object is made up of these properties:
Expand Down Expand Up @@ -667,7 +671,7 @@ When ESLint is run on the command line, it first checks the current working dire
You can prevent this search for `eslint.config.js` by setting the `ESLINT_USE_FLAT_CONFIG` environment variable to `true` and using the `-c` or `--config` option on the command line to specify an alternate configuration file, such as:

```shell
ESLINT_USE_FLAT_CONFIG=true npx eslint -c some-other-file.js **/*.js
ESLINT_USE_FLAT_CONFIG=true npx eslint --config some-other-file.js **/*.js
Zamiell marked this conversation as resolved.
Show resolved Hide resolved
```

In this case, ESLint does not search for `eslint.config.js` and instead uses `some-other-file.js`.