Skip to content

Commit

Permalink
docs: mention about name field in flat config (#18252)
Browse files Browse the repository at this point in the history
* docs: mention about `name` field in flat config

* Update docs/src/use/configure/configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Update docs/src/use/configure/configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Update docs/src/use/configure/configuration-files.md

* chore: update examples

* Update docs/src/use/configure/configuration-files.md

Co-authored-by: Tanuj Kanti <86398394+Tanujkanti4441@users.noreply.github.com>

* Update configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Update docs/src/use/configure/configuration-files.md

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* docs: update convention about uniqueness

* docs: wording

* Apply suggestions from code review

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

---------

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Tanuj Kanti <86398394+Tanujkanti4441@users.noreply.github.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
  • Loading branch information
4 people committed Apr 4, 2024
1 parent 1765c24 commit 94178ad
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs/src/use/configure/configuration-files.md
Expand Up @@ -56,6 +56,7 @@ module.exports = [

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:

* `name` - A name for the configuration object. This is used in error messages and config inspector to help identify which configuration object is being used. ([Naming Convention](#configuration-naming-conventions))
* `files` - An array of glob patterns indicating the files that the configuration object should apply to. If not specified, the configuration object applies to all files matched by any other configuration object.
* `ignores` - An array of glob patterns indicating the files that the configuration object should not apply to. If not specified, the configuration object applies to all files matched by `files`.
* `languageOptions` - An object containing settings related to how JavaScript is configured for linting.
Expand Down Expand Up @@ -342,6 +343,57 @@ Here, the `js.configs.recommended` predefined configuration is applied first and

For more information on how to combine predefined configs with your preferences, please see [Combine Configs](combine-configs).

### Configuration Naming Conventions

The `name` property is optional, but it is recommended to provide a name for each configuration object, especially when you are creating shared configurations. The name is used in error messages and the config inspector to help identify which configuration object is being used.

The name should be descriptive of the configuration object's purpose and scoped with the configuration name or plugin name using `/` as a separator. ESLint does not enforce the names to be unique at runtime, but it is recommended that unique names be set to avoid confusion.

For example, if you are creating a configuration object for a plugin named `eslint-plugin-example`, you might add `name` to the configuration objects with the `example/` prefix:

```js
export default {
configs: {
recommended: {
name: "example/recommended",
rules: {
"no-unused-vars": "warn"
}
},
strict: {
name: "example/strict",
rules: {
"no-unused-vars": "error"
}
}
}
};
```

When exposing arrays of configuration objects, the `name` may have extra scoping levels to help identify the configuration object. For example:

```js
export default {
configs: {
strict: [
{
name: "example/strict/language-setup",
languageOptions: {
ecmaVersion: 2024
}
},
{
name: "example/strict/sub-config",
file: ["src/**/*.js"],
rules: {
"no-unused-vars": "error"
}
}
]
}
}
```

## Using a Shareable Configuration Package

A sharable configuration is an npm package that exports a configuration object or array. This package should be installed as a dependency in your project and then referenced from inside of your `eslint.config.js` file. For example, to use a shareable configuration named `eslint-config-example`, your configuration file would look like this:
Expand Down

0 comments on commit 94178ad

Please sign in to comment.