@xmgh/stylelint-webpack-plugin
A stylelint plugin for webpack
Last updated a year ago by maqiang1816 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @xmgh/stylelint-webpack-plugin 
SYNC missed versions from official npm registry.

@xmgh/stylelint-webpack-plugin

A Stylelint plugin for webpack

Requirements

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

Getting Started

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

 npm install @xmgh/stylelint-webpack-plugin --save-dev

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

// webpack.config.js
const StyleLintPlugin = require('@xmgh/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 forked by webpack-contrib/stylelint-webpack-plugin, and update peerDependencies stylelint to ^10.0.0

Current Tags

  • 1.0.5                                ...           latest (7 months ago)

6 Versions

  • 1.0.5                                ...           7 months ago
  • 1.0.4                                ...           a year ago
  • 1.0.3                                ...           a year ago
  • 1.0.2                                ...           a year ago
  • 1.0.1                                ...           a year ago
  • 1.0.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (4)
Dev Dependencies (28)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |