Skip to content

Commit

Permalink
clarify scoped module example
Browse files Browse the repository at this point in the history
  • Loading branch information
bpmutter committed Feb 8, 2023
1 parent 9bf0e27 commit 150b6e6
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/src/extend/shareable-configs.md
Expand Up @@ -108,14 +108,22 @@ You can also omit the `eslint-config` and it is automatically assumed by ESLint:
}
```

The module name can also be customized, just note that when using [scoped modules](https://docs.npmjs.com/misc/scope) you cannot omit the `eslint-config-` prefix. Doing so results in package naming conflicts, and thus often in resolution errors. For example, if you have a package named `@scope/eslint-config-myconfig`, the configuration must be specified as:
The module name can also be customized. For example, if you have a package named `@scope/eslint-config-myconfig`, the configuration can be specified as:

```json
{
"extends": "@scope/eslint-config-myconfig"
}
```

You could also omit `eslint-config` to specify the configuration as:

```json
{
"extends": "@scope/myconfig"
}
```

### Overriding Settings from Shareable Configs

You can override settings from the shareable config by adding them directly into your `.eslintrc` file.
Expand Down

0 comments on commit 150b6e6

Please sign in to comment.