Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 4.28 KB

readme.md

File metadata and controls

90 lines (59 loc) · 4.28 KB

@rbnlffl/rollup-plugin-eslint

latest version on npm npm downloads a month required node version eslint peer dependency rollup peer dependency package license

Lint your Rollup bundles with ESLint. 🐝

Nicely integrates the most recent version of eslint into a rollup plugin.

How

npm i -D @rbnlffl/rollup-plugin-eslint
import eslint from '@rbnlffl/rollup-plugin-eslint';

export default {
  // ..
  plugins: [
    eslint()
    // ..
  ]
};

Config

This plugin respects your ESLint configuration as per default. It also takes a configuration object intended for the ESLint constructor with the addition of a throwOnWarning, throwOnError, filterInclude and filterExclude prop. The most popular configuration options are as follows:

fix

Type: boolean
Default: false
Utilized by: ESLint constructor

Controls whether to enable or disable the autofix feature of ESLint.

extensions

Type: string[]
Default: null
Utilized by: ESLint constructor

Controls what type of files ESLint should look at. The default of null is equal to [ '.js' ].

throwOnWarning

Type: boolean
Default: false
Utilized by: The plugin itself

Controls whether or not to throw an error and exit the process when ESLint reports any warnings.

throwOnError

Type: boolean
Default: false
Utilized by: The plugin itself

Controls whether or not to throw an error and exit the process when ESLint reports any errors.

filterInclude

Type: FilterPattern
Default: undefined
Utilized by: @rollup/pluginutils

A single picomatch pattern or an array of patterns controlling which files this plugin should explicitly include. Gets forwarded to the createFilter method of @rollup/pluginutils.

filterExclude

Type: FilterPattern
Default: 'node_modules/**'
Utilized by: @rollup/pluginutils

A single picomatch pattern or an array of patterns controlling which files this plugin should explicitly exclude. Gets forwarded to the createFilter method of @rollup/pluginutils.

Why a new plugin?

Because rollup-plugin-eslint seems to be dead and relies on eslint^6.0.0, which resolves to v6.8.0, resulting in unexpected errors when using rules introduced in versions 7 and up.

License

MIT