Awesome

gulp-nice-package

Opinionated package.json validator. Uses package.json-validator under the covers

Install

npm install gulp-nice-package --save-dev

Usage

// gulpfile.js
var gulp = require('gulp');
var validate = require('gulp-nice-package');

gulp.task('validate-json', function () {
  return gulp.src('package.json')
    .pipe(validate());
});

Options

Any options defined are simply passed along to package.json-validator

// gulpfile.js
var gulp = require('gulp');
var validate = require('gulp-nice-package');

gulp.task('validate-json', function () {
  return gulp.src('package.json')
    .pipe(validate('npm', {
      warnings: false,
      recommendations: false
    }));
});

Failing your build

The below will both print errors to the console and exit the gulp process with an appropriate error code for properly failing builds.

var gulp = require('gulp'),
  validate = require('gulp-nice-package'),
  mapstream = require('map-stream');

process.on('exit', function () {
  process.nextTick(function () {
    process.exit(1);
  });
});

gulp.task('validate-json', function () {
  var isValid = true;
  return gulp.src('package.json')
    .pipe(validate())
    .pipe(mapstream(function (file, cb) {
      isValid = file.nicePackage.valid;
      cb(null, file);
    }))
    .on('end', function() {
      if (!isValid) {
        process.emit('exit');
      }
    });
});