eslint-pullrequest

Run ESLint only on files affected by a PR

 

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.

$3

Any flags passed to _eslint-pullrequest_ will be passed to ESLint. See ESLint CLI reference for inspiration.

For example:

`
npx eslint-pullrequest --format compact
`

$3

#### 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 to use our new config:

`
npx eslint-pullrequest -c .eslintrc-newcode.js
``

License

This project uses the MIT license. See LICENSE.md