https://github.com/olegskl/gulp-stylelint
Gulp plugin for running Stylelint results through various reporters.
https://github.com/olegskl/gulp-stylelint
css gulp-plugin gulp-stylelint linter stylelint
Last synced: about 1 year ago
JSON representation
Gulp plugin for running Stylelint results through various reporters.
- Host: GitHub
- URL: https://github.com/olegskl/gulp-stylelint
- Owner: olegskl
- License: mit
- Created: 2015-12-21T18:41:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T07:41:33.000Z (about 2 years ago)
- Last Synced: 2025-03-27T12:05:20.631Z (about 1 year ago)
- Topics: css, gulp-plugin, gulp-stylelint, linter, stylelint
- Language: JavaScript
- Size: 553 KB
- Stars: 150
- Watchers: 6
- Forks: 30
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-stylelint
[](https://www.npmjs.org/package/gulp-stylelint)
[](https://travis-ci.org/olegskl/gulp-stylelint)
[](https://david-dm.org/olegskl/gulp-stylelint)
[](https://gitter.im/olegskl/gulp-stylelint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
A [Gulp](http://gulpjs.com/) plugin that runs [stylelint](https://github.com/stylelint/stylelint) results through a list of reporters.
## Installation
```bash
npm install stylelint gulp-stylelint --save-dev
```
## Quick start
Once you have [configured stylelint](http://stylelint.io/user-guide/configuration/) (e.g. you have a *.stylelintrc* file), start with the following code. You will find additional configuration [options](#options) below.
```js
const gulp = require('gulp');
gulp.task('lint-css', function lintCssTask() {
const gulpStylelint = require('gulp-stylelint');
return gulp
.src('src/**/*.css')
.pipe(gulpStylelint({
reporters: [
{formatter: 'string', console: true}
]
}));
});
```
## Formatters
Below is the list of currently available stylelint formatters. Some of them are bundled with stylelint by default and exposed on `gulpStylelint.formatters` object. Others need to be installed. You can [write a custom formatter](http://stylelint.io/developer-guide/formatters/) to tailor the reporting to your needs.
- `"string"` (same as `gulpStylelint.formatters.string`) – bundled with stylelint
- `"verbose"` (same as `gulpStylelint.formatters.verbose`) – bundled with stylelint
- `"json"` (same as `gulpStylelint.formatters.json`) – bundled with stylelint
- [stylelint-checkstyle-formatter](https://github.com/davidtheclark/stylelint-checkstyle-formatter) – requires installation
## Options
gulp-stylelint supports all [stylelint options](http://stylelint.io/user-guide/node-api/#options) except [`files`](http://stylelint.io/user-guide/node-api/#files) and [`formatter`](http://stylelint.io/user-guide/node-api/#formatter) and accepts a custom set of options listed below:
```js
const gulp = require('gulp');
gulp.task('lint-css', function lintCssTask() {
const gulpStylelint = require('gulp-stylelint');
const myStylelintFormatter = require('my-stylelint-formatter');
return gulp
.src('src/**/*.css')
.pipe(gulpStylelint({
failAfterError: true,
reportOutputDir: 'reports/lint',
reporters: [
{formatter: 'verbose', console: true},
{formatter: 'json', save: 'report.json'},
{formatter: myStylelintFormatter, save: 'my-custom-report.txt'}
],
debug: true
}));
});
```
#### `failAfterError`
When set to `true`, the process will end with non-zero error code if any error-level warnings were raised. Defaults to `true`.
#### `reportOutputDir`
Base directory for lint results written to filesystem. Defaults to current working directory.
#### `reporters`
List of reporter configuration objects (see below). Defaults to an empty array.
```js
{
// stylelint results formatter (required):
// - pass a function for imported, custom or exposed formatters
// - pass a string ("string", "verbose", "json") for formatters bundled with stylelint
formatter: myFormatter,
// save the formatted result to a file (optional):
save: 'text-report.txt',
// log the formatted result to console (optional):
console: true
}
```
#### `debug`
When set to `true`, the error handler will print an error stack trace. Defaults to `false`.
## Autofix
The `fix: true` option instructs stylelint to try to fix as many issues as possible. The fixes are applied to the gulp stream. The fixed content can be saved to file using `gulp.dest`.
```js
const gulp = require('gulp');
gulp.task('fix-css', function fixCssTask() {
const gulpStylelint = require('gulp-stylelint');
return gulp
.src('src/**/*.css')
.pipe(gulpStylelint({
fix: true
}))
.pipe(gulp.dest('src'));
});
```
## License
[MIT License](http://opensource.org/licenses/MIT)