https://github.com/macklinu/danger-plugin-jest

Danger plugin for Jest
https://github.com/macklinu/danger-plugin-jest

danger danger-plugin jest

Last synced: about 1 month ago
JSON representation

Danger plugin for Jest

• Host: GitHub
• URL: https://github.com/macklinu/danger-plugin-jest
• Owner: macklinu
• License: mit
• Created: 2017-05-24T14:43:15.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-02T13:27:43.000Z (over 4 years ago)
• Last Synced: 2024-10-08T12:07:17.537Z (3 months ago)
• Topics: danger, danger-plugin, jest
• Language: TypeScript
• Homepage:
• Size: 1.77 MB
• Stars: 23
• Watchers: 3
• Forks: 9
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-danger - danger-plugin-jest - Danger plugin for Jest. (Plugins / TypeScript (danger-js))

README

        
# danger-plugin-jest

[![Build Status](https://travis-ci.org/macklinu/danger-plugin-jest.svg?branch=master)](https://travis-ci.org/macklinu/danger-plugin-jest)

[![npm version](https://badge.fury.io/js/danger-plugin-jest.svg)](https://badge.fury.io/js/danger-plugin-jest)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

> [Danger](https://github.com/danger/danger-js) plugin for Jest

## Usage

### Setup Jest

This Danger plugin relies on modifying your Jest configuration slightly on CI to also output a JSON file of the results.

You need to make the `yarn jest` command include: `--outputFile test-results.json --json`. This will run your tests

like normal, but will also create a file with the full test results after.

> You may also want to add the JSON output file to your `.gitignore`, since it doesn't need to be checked into source control.

### Setup Danger

Install this Danger plugin:

```sh

yarn add danger-plugin-jest --dev

```

By default, this package will assume you've set the filename as `test-results.json`, but you can use any path.

```js

// dangerfile.js

import path from 'path'

import jest from 'danger-plugin-jest'

// Default

jest()

// Custom path

jest({ testResultsJsonPath: path.resolve(__dirname, 'tests/results.json') })

```

See [`src/index.ts`](https://github.com/macklinu/danger-plugin-jest/blob/master/src/index.ts) for more details.

## Changelog

See the GitHub [release history](https://github.com/macklinu/danger-plugin-jest/releases).

## Development

Install [Yarn](https://yarnpkg.com/en/), and install the dependencies - `yarn install`.

Run the [Jest](https://facebook.github.io/jest/) test suite with `yarn test`.

This project uses [semantic-release](https://github.com/semantic-release/semantic-release) for automated NPM package publishing.

:heart: