@grvcoelho/lint-diff

:nail_care: Run eslint only in the changed parts of the code

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1006Sep 23, 2019Apr 12, 2018Minified + gzip package size for @grvcoelho/lint-diff in KB

Readme

lint-diff

Build Status

:nail_care: Run eslint only in the changed parts of the code

Why

ESLint is a great tool to enforce code style in your code, but it has some limitations: it can only lint entire files. When working with legacy code, we often have to make changes to very large files (which would be too troublesome to fix all lint errors)and thus it would be good to lint only the lines changed and not the entire file.

lint-diff receives a commit range and uses ESLint to lint the changed files and filter only the errors introduced in the commit range (and nothing more).

State of the art

  • lint-staged is a similar tool that lints only the staged changes. It's very helpful for adding a precommit hook, but it cannot be used to enforce the styleguide on a Continuous Integration service like Travis, because the changes are already commited.

Usage

  1. Install it:
npm install @grvcoelho/lint-diff
  1. Install eslint and add your eslint configuration file.

  2. Use it:

# This will lint the last commit
lint-diff lint HEAD^..HEAD

Examples

  1. Lint the last 3 commits:
lint-diff lint HEAD~3..HEAD
  1. Lint local changes that are not yet commited (similar to what lint-staged do):
lint-diff lint HEAD
  1. Lint all commits from a build in Travis:
# This environment variable will be available in any Travis build
lint-diff lint $TRAVIS_COMMIT_RANGE

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.