@npmcli/eslint-config

@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:

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...`

Changelog

3.0.0 (2022-02-14)

⚠ BREAKING CHANGES

• this will report lint errors for all variable shadowing except for the common case of t used in tap tests

Features

• add no-shadow rule as an error (#11) (7af16a8)
• allow global/native extensions in tests (#9) (5ddad11)