https://github.com/npm/eslint-config
a base eslint config used by the npm CLI team
https://github.com/npm/eslint-config
npm-cli
Last synced: 9 months ago
JSON representation
a base eslint config used by the npm CLI team
- Host: GitHub
- URL: https://github.com/npm/eslint-config
- Owner: npm
- License: other
- Created: 2021-08-26T20:42:34.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T20:43:20.000Z (over 1 year ago)
- Last Synced: 2025-01-30T13:34:47.339Z (over 1 year ago)
- Topics: npm-cli
- Language: JavaScript
- Homepage:
- Size: 222 KB
- Stars: 11
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
## @npmcli/eslint-config
This module contains eslint rules used by the npm CLI team. All rules are
listed in `index.js` at the root of this repo.
### Usage
To facilitate having a single `.eslintrc.js` that can live untouched in every
project, we prefer to use a default config like:
```js
const { readdirSync: readdir } = require('fs')
const localConfigs = readdir(__dirname)
.filter((file) => file.startsWith('.eslintrc.local.'))
.map((file) => `./${file}`)
module.exports = {
extends: [
'@npmcli',
...localConfigs,
],
}
```
This allows any overrides for a project to exist in a separate file, typically
`.eslintrc.local.json`.
#### `bin`
This module also contains a bin script that will run `eslint` with the bundled config.
```
npm i -D @npmcli/eslint-config
# lint with our style rules
npx @npmcli/eslint-config -- # any args to eslint go here...`