Function

Static Public Summary
public	gulpStylelint(options: Object): Stream Stylelint results processor.
public	reporterFactory(config: Object, options: Object): Function Creates a reporter from the given config.
public	writer(text: String, dest: String, destRoot: String): Promise Creates the output folder and writes formatted text to a file.

Static Public

import gulpStylelint from 'gulp-stylelint/src/index.js'

Stylelint results processor.

Name	Type	Attribute	Description
options	Object	optional	Plugin options.
options.reportOutputDir	String	optional	Common path for all reporters.
options.reporters	[Object]	optional	Reporter configurations.
options.debug	Boolean	optional	If true, error stack will be printed.

Stream

Object stream usable in Gulp pipes.

import reporterFactory from 'gulp-stylelint/src/reporter-factory.js'

Creates a reporter from the given config.

Reporter.

import writer from 'gulp-stylelint/src/writer.js'

Creates the output folder and writes formatted text to a file.

Name	Type	Attribute	Description
text	String		Text to write (may be color-coded).
dest	String		Destination path relative to destRoot.
destRoot	String	optional	Destination root folder, defaults to cwd.

Resolved when folder is created and file is written.