https://github.com/sleavely/eslint-pullrequest
Run ESLint only on files affected by a PR
https://github.com/sleavely/eslint-pullrequest
bitbucket cli eslint github pull-requests
Last synced: about 1 month ago
JSON representation
Run ESLint only on files affected by a PR
- Host: GitHub
- URL: https://github.com/sleavely/eslint-pullrequest
- Owner: Sleavely
- License: mit
- Created: 2023-02-21T15:28:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-02T08:22:26.000Z (over 3 years ago)
- Last Synced: 2025-01-12T16:12:28.801Z (over 1 year ago)
- Topics: bitbucket, cli, eslint, github, pull-requests
- Language: JavaScript
- Homepage:
- Size: 194 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# eslint-pullrequest
Run ESLint only on files affected by a PR
[  ](https://npmjs.org/package/eslint-pullrequest "View this project on npm") [  ](https://github.com/Sleavely/eslint-pullrequest/issues)
## Usage
In your Bitbucket Pipeline or Github Action, instead of `npx eslint .`:
```
npx eslint-pullrequest
```
Note that _eslint-pullrequest_ assumes your project already has ESLint installed.
### Arguments
Any flags passed to _eslint-pullrequest_ will be passed to ESLint. See [ESLint CLI reference](https://eslint.org/docs/latest/use/command-line-interface) for inspiration.
For example:
```
npx eslint-pullrequest --format compact
```
### Environment variables
#### `LINTABLE_EXTENSIONS`
_eslint-pullrequest_ will use your existing ESLint configuration, but because of how ESLint file matching works it will only attempt to lint files involved in the pull request that have the extensions defined in the `LINTABLE_EXTENSIONS` environment variable. The default value is `.js,.ts,.jsx,.tsx`.
#### `MAX_EXEC_BUFFER_MB`
The size of the buffer that holds ESLints terminal output. Normally you shouldn't have to change this value unless you have hundreds or thousands of linting errors. The default is `10`.
## Using _eslint-pullrequest_ to introduce new linting rules
Let's say you've got a TypeScript project that you want to enable `@typescript-eslint/no-explicit-any` on, but you don't want to rewrite the entire codebase in order to get the linting to pass. We can use a separate configuration for _eslint-pullrequest_ that enforces the boyscout rule of cleaning up as you go.
Start by creating a new ESLint config next to your existing `.eslintrc.js`, lets call it `.eslintrc-newcode.js`:
```js
module.exports = {
extends: [
'./.eslintrc.js',
],
rules: {
'@typescript-eslint/no-explicit-any': ['error'],
},
}
```
Tweak the _eslint-pullrequest_ command by adding [`-c`](https://eslint.org/docs/latest/use/command-line-interface#-c---config) to use our new config:
```
npx eslint-pullrequest -c .eslintrc-newcode.js
```
## License
This project uses the MIT license. See [LICENSE.md](./LICENSE.md)