Gulp Prettier Plus

A Gulp plugin which allows the users to use Prettier.

Prettier is an opinionated JavaScript formatter inspired by refmt with advanced support for language features from ES2017, JSX, and Flow. It removes all original styling and ensures that all outputted JavaScript conforms to a consistent style. (See this blog post)

NOTE: To ensure this plugin continues to serve its usefulness, I've added @TheDancingCode as the active collaborator. He will be the active maintainer - BRP (April 26, 2018)

Install

npm install gulp-prettier --save-dev

Usage

Simply pipe the input, and pass in arguments that you would to the regular format function.

const gulp = require('gulp');
const prettier = require('gulp-prettier');

gulp.task('default', () => {
  return gulp.src('*.js')
    .pipe(prettier({ singleQuote: true }))
    .pipe(gulp.dest('./dist'));
});

To check whether or not your files adhere to Prettier's formatting, use prettier.check. This can be used as a validation step in CI scenarios.

const gulp = require('gulp');
const prettier = require('gulp-prettier');

gulp.task('validate', () => {
  return gulp.src('*.js')
    .pipe(prettier.check({ singleQuote: true }));
});

API

prettier([options])

Formats your files using Prettier.

options

Type: Object

Consult the Prettier options.

prettier.check([options])

Checks if your files have been formatted with Prettier and, if not, throws an error with a list of unformatted files. This is useful for running Prettier in CI scenarios.

options

Type: Object

Consult the Prettier options.

Collaborators

I'd like to take this oppertunity to thank all of the contributors to this project:

- @akella - @trusktr - @TheDancingCode

License

MIT License