gulp-alex

Gulp plugin for Alex

Install

npm install --save-dev gulp-alex

Usage

ES2015

// gulpfile.babel.js
import alex from 'gulp-alex'
import gulp from 'gulp'

/* ./README.md */
// # Awesome project!
// Garbagemen versus Abe Lincoln!
gulp.task('alex', () =>
  gulp.src('./README.md')
    .pipe(alex())
    .pipe(alex.reporter()) // prints any issues Alex finds to the console
    .pipe(alex.reporter('fail')) // emits an error after the task is ran if there are errors in any files
    .pipe(alex.reporter('failImmediately')) // causes the task to fail right away if Alex finds any issues with a file
)
// `gulp alex` produces in console:
// README.md
//   2:1 `garbageman` may be insensitive, use `garbage collector`, `waste collector`, `trash collector` instead

ES5

// gulpfile.js
var alex = require('gulp-alex')
  , gulp = require('gulp')

/* ./README.md */
// # Awesome project!
// Garbagemen versus Abe Lincoln!
gulp.task('alex', function () {
  return gulp.src('./README.md')
    .pipe(alex())
    .pipe(alex.reporter()) // prints any issues Alex finds to the console
    .pipe(alex.reporter('fail')) // emits an error after the task is ran if there are errors in any files
    .pipe(alex.reporter('failImmediately')); // causes the task to fail right away if Alex finds any issues with a file
})
// `gulp alex` produces in console:
// README.md
//   2:1 `garbageman` may be insensitive, use `garbage collector`, `waste collector`, `trash collector` instead

Alex Config

gulp-alex uses .alexrc or package.json as described in Alex's Ignoring Messages.

LICENSE

MIT © Dustin Specker