gulp-stylelint-sourcemap
v3.4.2
Published
Gulp plugin for running Stylelint results through various reporters.
Downloads
36
Readme
gulp-stylelint-sourcemap
This repository is forked from olegskl/gulp-stylelint. It supports source map feature.
A Gulp plugin that runs stylelint results through a list of reporters.
Installation
npm install gulp-stylelint-sourcemap --save-dev
Quick start
Once you have configured stylelint (e.g. you have a .stylelintrc file), start with the following code. You will find additional configuration options below.
const gulp = require('gulp');
gulp.task('lint-css', function lintCssTask() {
const gulpStylelint = require('gulp-stylelint-sourcemap');
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 to tailor the reporting to your needs.
"string"
(same asgulpStylelint.formatters.string
) – bundled with stylelint"verbose"
(same asgulpStylelint.formatters.verbose
) – bundled with stylelint"json"
(same asgulpStylelint.formatters.json
) – bundled with stylelint- stylelint-checkstyle-formatter – requires installation
Options
gulp-stylelint-sourcemap supports all stylelint options except files
and formatter
and accepts a custom set of options listed below:
const gulp = require('gulp');
gulp.task('lint-css', function lintCssTask() {
const gulpStylelint = require('gulp-stylelint-sourcemap');
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.
{
// 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
.
Source map Support
The plugin supports source map feature.
Translate file name, line and column
If a vinyl file object has a sourcemap
field, this plugin translates file name, line and column of output.
Ignore files
When ignoreFiles
option is specified in stylelintrc, this plugin ignores the files.
ignoreFiles
should be specified as a glob for translated file name.