eslint-overlook

eslint-overlook

Trying to add a linter to a legacy project can be though. eslint-overlook let's you pretend the existing errors don't exists and you can start from a clean slate.

Getting Started

Install eslint-overlook

npm install --save-dev eslint eslint-overlook

If you already have ESlint setup update the lint scripts in package.json

{
  "scripts": {
-   "lint": "eslint ."
+   "lint": "eslint-overlook .",
+   "lint:update-baseline": "eslint-overlook --update-baseline ."
  }
}

Run the script to create a baseline

npm run lint

There should be a file .eslint-overlook.json that contains all current lint errors. Subsequent runs of npm run lint will only show new errors.

To update the baseline run

npm run lint:update-baseline

Known limitations

• The heuristic to detect already known errors is based on the location of the error. Editing a file with errors might move those errors to a different location and thus will show them as "new" in the output. As a workaround you have to update the baseline.

Changelog

0.3.0

Minor Changes

• #3 8ba481a Thanks @lukahartwig! - Added a few more eslint plugins and fixed the errors in the code.