https://github.com/leebyron/grunt-jest

Grunt task for running jest tests.
https://github.com/leebyron/grunt-jest

Last synced: about 1 month ago
JSON representation

Grunt task for running jest tests.

• Host: GitHub
• URL: https://github.com/leebyron/grunt-jest
• Owner: leebyron
• Created: 2014-07-10T21:03:53.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-11-10T03:37:43.000Z (about 8 years ago)
• Last Synced: 2024-04-14T05:13:54.516Z (7 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 12
• Watchers: 3
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DEPRECATED

`grunt-jest` is deprecated as there are now much better ways to use Grunt and

Jest together.

Read [Jest getting started](https://facebook.github.io/jest/#getting-started)

describing adding an npm script which calls jest, then use the fantastic

[`grunt-run`](https://github.com/spalger/grunt-run) plugin to run Jest (or any

other npm script!) directly from your Grunt config.

# grunt-jest v0.1.0

Grunt task to run tests with [Jest](http://facebook.github.io/jest/).

## Getting Started

This plugin requires Grunt `~0.4.0`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

npm install grunt-jest --save-dev

```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js

grunt.loadNpmTasks('grunt-jest');

```

## Run tests

_Run this task with the `grunt jest` command._

Task options may be specified according to the grunt [Configuring tasks](http://gruntjs.com/configuring-tasks) guide.

### Options

#### config

Type: `String` srcpath

The path to a jest config file specifying how to find and execute tests.

#### testPathPattern

Type: `RegExp`

Default: `/.*/`

Only tests which match this pattern will execute.

#### coverage

Type: `Boolean`

Default: `false`

Indicates that test coverage information should be collected and reported in the output.

#### maxWorkers

Type: `Number`

Default: Number of cores available on this machine.

Specifies the maximum number of workers the worker-pool will spawn for running tests.

(it is usually best not to override this default)

#### onlyChanged

Type: `Boolean`

Default: `false`

Attempts to identify which tests to run based on which files have changed in

the current repository. Only works if you're running tests in a git repository at the moment.

#### runInBand

Type: `Boolean`

Default: `false`

Run all tests serially in the current process (rather than creating a worker pool of child

processes that run tests). This is sometimes useful for debugging, but such use cases are pretty rare.

### Usage Examples

```js

jest: {

  options: {

    coverage: true,

    testPathPattern: /.*-test.js/

  }

}

```