README

pipeline-validate-js

Information

Package	Description	Version
pipeline-validate-js	Pipeline to validate JavaScript files using ESLint	1.0.4

Overview

This is a Gulp pipeline that allows a team to validate the JS files within their project for syntax and style. As part of the Keystone project for Kenzan, this pipeline is opinionated to promote best practices as favored by the organization. It defines a module that contains a validateJS method that will use ESLint to complete the task.

A fixture has been provided in test/fixtures/ of Twitter Bootstrap's source, linted according to the rules. As changes are presented to the default ruleset, the rules will be reflected in this file as well, for easy visualiztion of rule set changes.

Install

npm install pipeline-validate-js --save-dev

Usage

In addition to the default rules established within this pipeline, there is support for using personalized linting rules. If you'd like to use other rules within your project you can define a .eslintrc file. You can also pass in a file path as a parameter or pass in an object with your custom rules. This pipeline will merge your rules, favoring your rules over the default configuration.

var gulp = require('gulp');
var validatePipeline = require('pipeline-validate-js');

gulp.task('default', function() {
  return gulp
    .src('src/**/*.js')
    .pipe(validatePipeline.validateJS());
});

//specify your own custom eslintrc, that gets merged into the default config
gulp.task('default', function() {
  return gulp
    .src('src/**/*.js')
    .pipe(validatePipeline.validateJS('/some/path/.eslintrcCustom'));
});

//specify your own custom rules object, that gets merged into the default config
gulp.task('default', function() {
  return gulp
    .src('src/**/*.js')
    .pipe(validatePipeline.validateJS({
      "rules": {
        "no-console": 0
      },
      "parserOptions": {
        "ecmaVersion": 6
      }
    });
});

Options

Note: If options are invalid it will throw a reference error.

Pipeline options:

config -> Object that contains the configuration. It offers a 1:1 mapping with the format of an eslintrc file
- parseOptions.ecmaVersion:__ Sets the ecmaScript version to be linted, set to '5' by default.
Default:
```
pipelineConfig = {
  parseOptions: {
    ecmaVersion: 5
  }
}
```

Custom Formatter

ESLint provides the ability to output the results in a variety of formats, thus, a custom formatter can be provided via the config object.

ESLint provided formatters: https://github.com/eslint/eslint/tree/master/lib/formatters

The custom formatter options will not conflict with the default ESLint options provided, so you can provide just a formatter while retaining the default ESLint option values.

var lintConfig = {
  formatter: 'name-of-eslint-formatter'
  // OR
  // formatter: function (arrayOfResults) {
    // output something here
  // }
}

gulp.task('lint', function() {
  return gulp
    .src('src/**/*.js')
    .pipe(validatePipeline.validateJS(lintConfig));
});

Failing on Errors

By default, this pipeline will exit on a validation error. To prevent this exit on failure, provide the following option to the pipeline.

var lintConfig = {
  failOnError: false
}

gulp.task('lint', function() {
  return gulp
    .src('src/**/*.js')
    .pipe(validatePipeline.validateJS(lintConfig));
});

As with the custom formatting option, this option will not conflict with the ESLint default configuration options.

Results

This pipeline returns an object. This object receives a stream with the files to validate. You can call the validateJS method to run the validation. The method will report if any issues were found during validation. If no issues are present, it will return the stream.

LICENSE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Usage no npm install needed!