stylelint-webpack-plugin

What is stylelint-webpack-plugin?

The stylelint-webpack-plugin is a plugin for Webpack that integrates Stylelint, a popular CSS linter, into the Webpack build process. It helps developers enforce consistent coding styles and catch errors in CSS, SCSS, and other style files.

What are stylelint-webpack-plugin's main functionalities?

Linting CSS files

This feature allows you to lint all CSS files in your project. The plugin will check for style errors and enforce coding standards as defined in your Stylelint configuration.

const StylelintPlugin = require('stylelint-webpack-plugin');

module.exports = {
  plugins: [
    new StylelintPlugin({
      files: '**/*.css',
    }),
  ],
};

Linting SCSS files

This feature allows you to lint all SCSS files in your project. The plugin will check for style errors and enforce coding standards as defined in your Stylelint configuration.

const StylelintPlugin = require('stylelint-webpack-plugin');

module.exports = {
  plugins: [
    new StylelintPlugin({
      files: '**/*.scss',
    }),
  ],
};

Custom Stylelint configuration

This feature allows you to specify a custom Stylelint configuration file. The plugin will use the rules defined in the specified configuration file to lint your style files.

const StylelintPlugin = require('stylelint-webpack-plugin');

module.exports = {
  plugins: [
    new StylelintPlugin({
      configFile: '.stylelintrc.json',
    }),
  ],
};

Fixing errors automatically

This feature allows the plugin to automatically fix certain style errors. It can save time by correcting issues that can be automatically resolved according to the Stylelint rules.

const StylelintPlugin = require('stylelint-webpack-plugin');

module.exports = {
  plugins: [
    new StylelintPlugin({
      fix: true,
    }),
  ],
};

Other packages similar to stylelint-webpack-plugin

eslint-webpack-plugin

The eslint-webpack-plugin integrates ESLint into the Webpack build process. While ESLint is primarily used for JavaScript and TypeScript linting, it can also be configured to lint styles in JavaScript files. However, it is not as specialized for CSS and SCSS as stylelint-webpack-plugin.

postcss-loader

The postcss-loader is a Webpack loader that processes CSS with PostCSS. While it is not a linter, it can be used with PostCSS plugins like stylelint to achieve similar functionality. It offers more flexibility but requires additional configuration.

stylelint

Stylelint is the core linter that stylelint-webpack-plugin integrates with. It can be used directly in a project without Webpack, often through a task runner like Gulp or Grunt, or via command line. Using it directly offers more control but requires manual integration into the build process.

README

stylelint-webpack-plugin

This is stylelint-webpack-plugin 3.0 which works only with webpack 5. For the webpack 4, see the 2.x branch.

This plugin uses stylelint that helps you avoid errors and enforce conventions in your styles.

Getting Started

To begin, you'll need to install stylelint-webpack-plugin:

npm install stylelint-webpack-plugin --save-dev

or

yarn add -D install stylelint-webpack-plugin

or

pnpm add -D stylelint-webpack-plugin

Note: You also need to install stylelint >= 13 from npm, if you haven't already:

npm install stylelint --save-dev

or

yarn add -D stylelint

or

pnpm add -D stylelint

Note: If you are using Stylelint 13 rather than 14+, you might also need to install @types/stylelint as a dev dependency if getting stylelint related type errors.

Then add the plugin to your webpack config. For example:

const StylelintPlugin = require('stylelint-webpack-plugin');

module.exports = {
  // ...
  plugins: [new StylelintPlugin(options)],
  // ...
};

Options

See stylelint's options for the complete list of options available. These options are passed through to the stylelint directly.

configFile

• Type:

type context = string;

• Default: undefined

Specify the config file location to be used by stylelint.

Note: By default this is handled by stylelint.

context

• Type:

type context = string;

• Default: compiler.context

A string indicating the root of your files.

exclude

• Type:

type exclude = string | Array<string>;

• Default: ['node_modules', compiler.options.output.path]

Specify the files and/or directories to exclude. Must be relative to options.context.

extensions

• Type:

type extensions = string | Array<string>;

• Default: ['css', 'scss', 'sass']

Specify extensions that should be checked.

files

• Type:

type files = string | Array<string>;

• Default: null

Specify directories, files, or globs. Must be relative to options.context. Directories are traversed recursively looking for files matching options.extensions. File and glob patterns ignore options.extensions.

fix

• Type:

type fix = boolean;

• Default: false

If true, stylelint will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported. See Autofixing errors docs.

formatter

• Type:

type formatter = string | (
  results: Array<import('stylelint').LintResult>
) => string

• Default: 'string'

Specify the formatter that you would like to use to format your results. See formatter option.

lintDirtyModulesOnly

• Type:

type lintDirtyModulesOnly = boolean;

• Default: false

Lint only changed files, skip lint on start.

stylelintPath

• Type:

type stylelintPath = string;

• Default: stylelint

Path to stylelint instance that will be used for linting.

threads

• Type:

type threads = boolean | number;

• Default: false

Set to true for an auto-selected pool size based on number of cpus. Set to a number greater than 1 to set an explicit pool size. Set to false, 1, or less to disable and only run in main process.

Errors and Warning

By default the plugin will auto adjust error reporting depending on stylelint errors/warnings counts. You can still force this behavior by using emitError or emitWarning options:

emitError

• Type:

type emitError = boolean;

• Default: true

The errors found will always be emitted, to disable set to false.

emitWarning

• Type:

type emitWarning = boolean;

• Default: true

The warnings found will always be emitted, to disable set to false.

failOnError

• Type:

type failOnError = boolean;

• Default: true

Will cause the module build to fail if there are any errors, to disable set to false.

failOnWarning

• Type:

type failOnWarning = boolean;

• Default: false

Will cause the module build to fail if there are any warnings, if set to true.

quiet

• Type:

type quiet = boolean;

• Default: false

Will process and report errors only and ignore warnings, if set to true.

outputReport

• Type:

type outputReport =
  | boolean
  | {
      filePath?: string | undefined;
      formatter?:
        | (
            | string
            | ((results: Array<import('stylelint').LintResult>) => string)
          )
        | undefined;
    };

• Default: false

Write the output of the errors to a file, for example a json file for use for reporting. The filePath is relative to the webpack config: output.path. You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.

{
  filePath: 'path/to/file';
  formatter: 'json';
}

Changelog

Changelog

License

MIT

Changelog

3.2.0 (2022-03-21)

Features

• removed cjs wrapper (#265) (dc9a2e3)

Bug Fixes

• ignored file (#266) (ac50bf5)