jmurzy / gulp-jest-cli

Gulp plugin for Jest

Gulp Jest CLI

Gulp plugin for Jest.

Installation

Using npm:

$ npm install gulp-jest-cli jest-cli --save-dev

Using yarn:

$ yarn add gulp-jest-cli jest-cli --dev

Usage

import plugin from 'gulp-jest-cli';

gulp.task('jest', () => gulp
  /*
   * Jest's `rootDir` will be set to the directory specified in `gulp.src`
   * unless a `rootDir` is explicitly configured via configuration options
   */
  .src('src')
  .pipe(plugin({
    config: {
      /* Configuration options */
      {
        coverageReporters: [
          'text',
          'text-summary',
          'json',
          'lcov',
        ],
        collectCoverageFrom: [
          '**/*.js',
          '!**/*test*',
        ]
      }
    },
    /* CLI options*/
    coverage: true,
    onlyChanged: true,
  }))
);

Jest docs for configuration options can be found here.

Configuration options via external file

import plugin from 'gulp-jest-cli';

gulp.task('jest', () => gulp
  .src('src')
  .pipe(plugin({
    config: '.jestrc',
    /* CLI options */
    coverage: true,
    onlyChanged: true,
  }))
);

Configuration options via package.json

import plugin from 'gulp-jest-cli';

gulp.task('jest', () => gulp
  .src('src')
  .pipe(plugin({
    /* Jest will fallback to package.json for configuration when `config` is omitted */
    /* CLI options */
    coverage: true,
    onlyChanged: true,
  }))
);

Questions?

Feel free to reach out to me on Twitter @jmurzy.

Contributing

Contributions are very welcome: bug fixes, features, documentation, tests. Just make sure the CI is 👌.

#### License All pull requests that get merged will be made available under [the MIT license](https://github.com/jmurzy/gulp-jest-cli/blob/master/LICENSE.md), as the rest of the repository.

gulp-jest-cli's Issues

Incompatibility with Jest 20

When using gulp-jest-cli with Jest version 20+, an error occurs projects.map is not a function. This is due to runCLI expecting an array as the second argument.