https://github.com/grvcoelho/lint-diff
:nail_care: Run eslint only in the changed parts of the code
https://github.com/grvcoelho/lint-diff
ci lint travis
Last synced: about 1 year ago
JSON representation
:nail_care: Run eslint only in the changed parts of the code
- Host: GitHub
- URL: https://github.com/grvcoelho/lint-diff
- Owner: grvcoelho
- License: mit
- Created: 2018-04-12T10:11:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T20:12:00.000Z (over 3 years ago)
- Last Synced: 2025-03-31T10:05:38.078Z (over 1 year ago)
- Topics: ci, lint, travis
- Language: JavaScript
- Size: 401 KB
- Stars: 114
- Watchers: 2
- Forks: 23
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lint-diff
[](https://travis-ci.org/grvcoelho/lint-diff)
:nail_care: Run eslint only in the changed parts of the code
## Why
[ESLint](https://github.com/eslint/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](https://github.com/grvcoelho/lint-diff) receives a commit range and
uses [ESLint](https://github.com/eslint/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](https://github.com/okonet/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:
```sh
$ npm install lint-diff
```
2. Install `eslint` and add your eslint configuration file.
3. Use it:
```sh
# This will lint the last commit
$ lint-diff HEAD^..HEAD
```
## Examples
1. Lint the last 3 commits:
```sh
$ lint-diff HEAD~3..HEAD
```
2. Lint local changes that are not yet commited (similar to what [lint-staged](https://github.com/okonet/lint-staged) do):
```sh
$ lint-diff HEAD
# or
$ lint-diff
```
3. Lint all commits from a build in [Travis](https://travis-ci.org):
```sh
# This environment variable will be available in any Travis build
$ lint-diff $TRAVIS_COMMIT_RANGE
```