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

A Stylelint plugin for webpack

Requirements

This module requires a minimum of Node v6.9.0 and webpack v4.0.0.

Differences With stylelint-loader

Both stylelint-loader and this module have their uses. stylelint-loader lints the files you require (or the ones you define as an entry in your webpack config). However, @imports in files are not followed, meaning only the main file for each require/entry is linted.

stylelint-webpack-plugin allows defining a glob pattern matching the configuration and use of stylelint.

Getting Started

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

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

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

file.ext

import file from 'file.ext';

// webpack.config.js
const StyleLintPlugin = require('stylelint-webpack-plugin');

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

And run webpack via your preferred method.

Options

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

configFile

Type: String Default: undefined

Specify the config file location to be used by stylelint.

Note: By default this is handled by stylelint via cosmiconfig.

context

Type: String Default: compiler.context

A String indicating the root of your SCSS files.

emitErrors

Type: Boolean Default: true

If true, pipes stylelint error severity messages to the webpack compiler's error message handler.

Note: When this property is disabled all stylelint messages are piped to the webpack compiler's warning message handler.

failOnError

Type: Boolean Default: false

If true, throws a fatal error in the global build process. This will end the build process on any stylelint error.

files

Type: String|Array[String] Default: '**/*.s?(a|c)ss'

Specify the glob pattern for finding files. Must be relative to options.context.

formatter

Type: Object Default: require('stylelint').formatters.string

Specify a custom formatter to format errors printed to the console.

lintDirtyModulesOnly

Type: Boolean Default: false

Lint only changed files, skip lint on start.

syntax

Type: String Default: undefined

See the styelint user guide for more info. e.g. use 'scss' to lint .scss files.

Error Reporting

By default the plugin will dump full reporting of errors. Set failOnError to true if you want webpack build process breaking with any stylelint error. You can use the quiet option to avoid error output to the console.

Acknowledgement

This project was inspired by, and is a heavily modified version of sasslint-webpack-plugin.

Thanks to Javier (@vieron) for authoring this plugin.

License

MIT