https://github.com/sandark7/rollup-plugin-stylint

Rollup plugin to lint stylus with stylint
https://github.com/sandark7/rollup-plugin-stylint

Last synced: 25 days ago
JSON representation

Rollup plugin to lint stylus with stylint

• Host: GitHub
• URL: https://github.com/sandark7/rollup-plugin-stylint
• Owner: sandark7
• License: mit
• Created: 2017-04-17T16:23:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-20T14:58:48.000Z (over 7 years ago)
• Last Synced: 2024-03-15T05:44:56.463Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 16.6 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - stylint - Lint Stylus files. (Plugins / Code Quality)

README

        
# rollup-plugin-stylint

[![NPM version](https://img.shields.io/npm/v/rollup-plugin-stylint.svg)](https://www.npmjs.com/package/rollup-plugin-stylint)

[![Dependency Status](https://img.shields.io/gemnasium/sandark7/rollup-plugin-stylint.svg)](https://gemnasium.com/sandark7/rollup-plugin-stylint)

[![Code Climate](https://codeclimate.com/github/sandark7/rollup-plugin-stylint/badges/gpa.svg)](https://codeclimate.com/github/sandark7/rollup-plugin-stylint)

[Rollup](https://www.npmjs.com/package/rollup) plugin to lint stylus with [stylint](https://www.npmjs.com/package/stylint)

## Installation

```

npm install rollup-plugin-stylint -D

```

## Usage

``` javascript

import { rollup } from 'rollup';

import stylint from 'rollup-plugin-stylint';

rollup({

  entry: 'index.js',

  plugins: [

    stylint()

  ]

});

```

## Options

### configFile

Specify path to `.stylintrc` file with stylint options.

``` javascript

import { rollup } from 'rollup';

import stylint from 'rollup-plugin-stylint';

rollup({

  entry: 'index.js',

  plugins: [

    stylint({

      configFile: './.stylintrc'

    })

  ]

});

```

### config

Or specify stylint options inline.

``` javascript

import { rollup } from 'rollup';

import stylint from 'rollup-plugin-stylint';

rollup({

  entry: 'index.js',

  plugins: [

    stylint({

      config: {

        brackets: 'always',

        namingConvention: 'BEM',

        semicolons: 'always'

      }

    })

  ]

});

```

Also `config` overrides `configFile` option.

### reporter

You can use custom reporter for better console output.

``` javascript

import { rollup } from 'rollup';

import stylint from 'rollup-plugin-stylint';

rollup({

  entry: 'index.js',

  plugins: [

    stylint({

      reporter: 'stylint-stylish'

    })

  ]

});

```

## License

[MIT](http://www.opensource.org/licenses/mit-license.php) © Andrew Smirnov