This is an up to date fork from eslint-ignore-inserter which is no more maintained.

When moving to a new ESLint config, or when adopting ESLint for the first time, it's common to have tons of violations that you want to silence for now.

This library exposes a helpful utility, eslint-disable-inserter, that will do all the heavy lifting, and insert // eslint-disable-next-line ... comments into your code.

This utility is idempotent, so it can be used each time you add a new ESlint rule.

Say you have the following code, with an indentation violation:

function example() {
  console.log("Hello")
    console.log("World!")
}

Assuming you have the ESLint indent rule turned on, running this...

eslint --format json . | eslint-disable-inserter

... yields this:

function example() {
  console.log("Hello")
  // eslint-disable-next-line indent
    console.log("World!")
}

$ yarn add --dev eslint-disable-inserter

Then, in your package.json, you can do something like this:

{
  "scripts": {
    "eslint:insert-disbales": "eslint --format json . | eslint-disbale-inserter"
  }
}

Alternatively, you can install it globally and do the piping in your shell.

The --dry-run / -d flag will prevent any filesystem writes, and will instead print the modified files to stdout for you to inspect.

The --add-fix-me / -f flag will add // FIXME along with the // eslint-disable-next-line

MIT