https://github.com/macklinu/danger-plugin-no-test-shortcuts

Danger plugin to prevent merging test shortcuts (.only and .skip)
https://github.com/macklinu/danger-plugin-no-test-shortcuts

ci danger danger-plugin nodejs

Last synced: about 1 month ago
JSON representation

Danger plugin to prevent merging test shortcuts (.only and .skip)

• Host: GitHub
• URL: https://github.com/macklinu/danger-plugin-no-test-shortcuts
• Owner: macklinu
• License: mit
• Created: 2017-05-03T15:02:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-10-04T08:20:06.000Z (about 6 years ago)
• Last Synced: 2024-08-11T00:02:35.054Z (4 months ago)
• Topics: ci, danger, danger-plugin, nodejs
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/danger-plugin-no-test-shortcuts
• Size: 1.14 MB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-danger - danger-plugin-no-test-shortcuts - Danger plugin to prevent merging test shortcuts (.only and .skip). (Plugins / TypeScript (danger-js))

README

        
# danger-plugin-no-test-shortcuts

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

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

[![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)

[![Greenkeeper badge](https://badges.greenkeeper.io/macklinu/danger-plugin-no-test-shortcuts.svg)](https://greenkeeper.io/)

[Danger](https://github.com/danger/danger-js) plugin to prevent merging test shortcuts (.only and .skip)

## Usage

Import and invoke the `noTestShortcuts()` function in your Dangerfile:

```js

// dangerfile.js

import noTestShortcuts from 'danger-plugin-no-test-shortcuts'

noTestShortcuts({

  testFilePredicate: (filePath) => filePath.endsWith('.test.js'),

})

```

By default, Danger will fail the build if a new or modified test file contains `.only()` - this prevents merging changes that will prevent your entire test suite from running on each pull request.

This plugin takes an optional config object with a couple of options:

```js

noTestShortcuts({

  // A required predicate for determining where your test files live.

  testFilePredicate: (filePath) => filePath.endsWith('.test.js'),

  // Defines the behavior for handling skipped tests (e.g. test.skip()).

  // Defaults to 'ignore'.

  // Valid values: 'ignore', 'fail', 'warn'.

  skippedTests: 'fail',

  // Defines any (additional) patterns you want to test for

  // Defaults to no extra patterns

  // Here you can add patterns specific to how your test framework does skips/onlys

  patterns: {

    only: ['customOnly'],

    skip: ['sk.ip']

  }

})

```

## Development

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

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

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

The main caveat: instead of running `git commit`, run `yarn commit` and follow the prompts to input a conventional changelog message via [commitizen](https://github.com/commitizen/cz-cli).