rollup-plugin-eslint-bundle

rollup-plugin-eslint-bundle

🍣 A Rollup plugin to lint and fix bundled code with ESLint.

Requirements

This plugin requires an LTS Node version (v14.13.1+), Rollup v2.x and ESLint >=8.x

Install

npm i -D rollup-plugin-eslint-bundle

Usage

// rollup.config.js ESM
import { rollup } from 'rollup';
import { eslintBundle } from 'rollup-plugin-eslint-bundle';

const root = path.dirname(url.fileURLToPath(import.meta.url))

export default {
  input: path.resolve(root, './main.js'),

  plugins: [
    eslintBundle({
      eslintOptions: {
        fix: true,
      },
      throwOnWarning: true,
      throwOnError: true,
      formatter: 'compact'
    }),
  ],

  output: {
    file: path.resolve(root, './dist/bundle.js'),
    format: 'es',
  },
};

// Rollup JavaScript API
import { rollup } from 'rollup';
import { eslintBundle } from 'rollup-plugin-eslint-bundle';

// ...

const bundle = await rollup.rollup({
  input: 'main.js',
  plugins: [
    eslintBundle({
      eslintOptions: {
        fix: true,
      },
      throwOnWarning: true,
      throwOnError: true,
      formatter: 'compact'
    })
  ]
});

await bundle.write({
  file: 'dist/bundle.js',
  format: 'es',
});

await bundle.close();

Options

eslintOptions

ESLint class options object.

throwOnWarning

Type: boolean

Default: false

If true, will throw an error if any warnings were found.

throwOnError

Type: boolean

Default: false

If true, will throw an error if any errors were found.

formatter

Type: string

Default: undefined

Value to be passed to eslint.loadFormatter()

License

MIT License (MIT)

Contributing

If you find a bug or think about enhancement, feel free to contribute and submit an issue or a pull request.

Changelog

7.0.0 - 2022-05-08

Changed

• Update dependencies

BREAKING CHANGES

• Switch to ES modules. But still provide CJS bundle in dist
• Require Node.js version >= 14
• Update eslint peer dependency to >=8.x