https://github.com/cascornelissen/stylelint-bare-webpack-plugin

Stylelint plugin for webpack
https://github.com/cascornelissen/stylelint-bare-webpack-plugin

stylelint webpack webpack-plugin

Last synced: 3 months ago
JSON representation

Stylelint plugin for webpack

• Host: GitHub
• URL: https://github.com/cascornelissen/stylelint-bare-webpack-plugin
• Owner: cascornelissen
• License: mit
• Created: 2016-07-28T08:54:11.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-05T20:28:57.000Z (4 months ago)
• Last Synced: 2024-10-18T08:34:53.539Z (3 months ago)
• Topics: stylelint, webpack, webpack-plugin
• Language: JavaScript
• Homepage:
• Size: 612 KB
• Stars: 13
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Stylelint Bare Webpack Plugin

[![npm](https://img.shields.io/npm/v/stylelint-bare-webpack-plugin.svg?style=flat-square)](https://www.npmjs.com/package/stylelint-bare-webpack-plugin)

[![npm](https://img.shields.io/npm/dm/stylelint-bare-webpack-plugin.svg?style=flat-square)](https://www.npmjs.com/package/stylelint-bare-webpack-plugin)

[![license](https://img.shields.io/github/license/cascornelissen/stylelint-bare-webpack-plugin.svg?style=flat-square)](LICENSE.md)

This [webpack](https://webpack.github.io/) plugin allows you to lint your CSS/SASS/SCSS/LESS etc. files through any version of [Stylelint](http://stylelint.io/). It is heavily inspired by [`stylelint-webpack-plugin`](https://www.npmjs.com/package/stylelint-webpack-plugin) with the key difference being that `stylelint` isn't included in this package, allowing you to use any version you want instead of waiting on the webpack plugin to be updated to the newest version.

**Compatibility**  

Version `^1.0.0` of this plugin is compatible with webpack `^4.0.0`. If you're using an older version of webpack, make sure to install the `^0.1.0` (`npm install stylelint-bare-webpack-plugin@^0.1.0`) release of this plugin.

## Installation

```shell

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

```

## Usage

```js

// webpack.config.js

const StylelintBarePlugin = require('stylelint-bare-webpack-plugin');

module.exports = {

    // ...

    plugins: [

        new StylelintBarePlugin({

            // Optional options object

        })

    ]

}

```

## Options

You can pass an object containing several options to `StylelintBarePlugin()`, this object can contain the following keys and any key that can be [passed to stylelint](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/node-api.md#options) as well.

| Option        | Default                          | Description                                                                                                                                                          

| ------------- | -------------------------------- | ------------

| `files`       | `'**/*.s?(c\|a)ss'`              | [`glob`](http://npmjs.com/package/glob) used for finding the files that will be linted                                                                               

| `emitErrors`  | `true`                           | Whether to emit webpack errors or only warnings, note that all stylelint errors will still be shown when disabling this

| `failOnError` | `false`                          | Whether to stop the entire Webpack process when a stylelint error is found

| `formatter`   | `stringFormatter` from Stylelint | [Formatter](http://stylelint.io/developer-guide/formatters/) used to display warnings/errors in console                                                              

## License

This project is [licensed](LICENSE.md) under the [MIT](https://opensource.org/licenses/MIT) license.