https://github.com/dustinspecker/gulp-alex

Gulp plugin for Alex
https://github.com/dustinspecker/gulp-alex

Last synced: 2 days ago
JSON representation

Gulp plugin for Alex

• Host: GitHub
• URL: https://github.com/dustinspecker/gulp-alex
• Owner: dustinspecker
• License: mit
• Created: 2015-09-07T01:54:59.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-31T21:40:41.000Z (over 7 years ago)
• Last Synced: 2024-10-07T14:36:47.283Z (about 1 month ago)
• Language: JavaScript
• Size: 84 KB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# gulp-alex

[![NPM version](https://badge.fury.io/js/gulp-alex.svg)](https://badge.fury.io/js/gulp-alex) [![Build Status](https://travis-ci.org/dustinspecker/gulp-alex.svg)](https://travis-ci.org/dustinspecker/gulp-alex) [![Coverage Status](https://img.shields.io/coveralls/dustinspecker/gulp-alex.svg)](https://coveralls.io/r/dustinspecker/gulp-alex?branch=master)

[![Dependencies](https://david-dm.org/dustinspecker/gulp-alex.svg)](https://david-dm.org/dustinspecker/gulp-alex/#info=dependencies&view=table) [![DevDependencies](https://david-dm.org/dustinspecker/gulp-alex/dev-status.svg)](https://david-dm.org/dustinspecker/gulp-alex/#info=devDependencies&view=table)

> Gulp plugin for [Alex](https://github.com/wooorm/alex)

## Install

```

npm install --save-dev gulp-alex

```

## Usage

### ES2015

```javascript

// 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

```

![](assets/alex-error.png)

### ES5

```javascript

// 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](https://github.com/wooorm/alex#ignoring-messages).

## LICENSE

MIT © [Dustin Specker](https://github.com/dustinspecker)