@rollup/plugin-eslint v9.0.5
@rollup/plugin-eslint
š£ A Rollup plugin to lint entry points and all imported files with ESLint.
Requirements
This plugin requires an LTS Node version (v14.0.0+) and Rollup v1.20.0+.
Install
Using npm:
npm install @rollup/plugin-eslint --save-dev
# or
yarn add -D @rollup/plugin-eslint
Usage
import eslint from '@rollup/plugin-eslint';
export default {
input: 'main.js',
plugins: [
eslint({
/* your options */
})
]
};
Options
This plugin takes a configuration object intended for the ESLint constructor with the addition of a throwOnWarning
, throwOnError
, formatter
, include
and exclude
prop.
You can also use eslint configuration in the form of a .eslintrc.*
file in your project's root. It will be loaded automatically.
exclude
Type: String | String[]
Default: node_modules/**
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
.
fix
Type: Boolean
Default: false
If true, will auto fix source code.
formatter
Type: Function<String> | Function<Promise<String>> | String
Default: stylish
Custom error formatter, the name of a built-in formatter, or the path to a custom formatter.
include
Type: String | String[]
Default: []
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
.
throwOnError
Type: Boolean
Default: false
If true, will throw an error and exit the process when ESLint reports any errors.
throwOnWarning
Type: Boolean
Default: false
If true, will throw an error and exit the process when ESLint reports any warnings.