https://github.com/guidesmiths/dangerjs-wrapper

Apply cultural rules during your CI process
https://github.com/guidesmiths/dangerjs-wrapper

Last synced: 22 days ago
JSON representation

Apply cultural rules during your CI process

• Host: GitHub
• URL: https://github.com/guidesmiths/dangerjs-wrapper
• Owner: guidesmiths
• License: mit
• Created: 2020-12-07T09:31:53.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-05T13:52:36.000Z (over 3 years ago)
• Last Synced: 2024-12-18T09:45:20.282Z (29 days ago)
• Language: TypeScript
• Size: 982 KB
• Stars: 0
• Watchers: 13
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Dangerjs-wrapper

Apply cultural rules during your CI process.

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

> Plugin to Apply cultural rules during your CI process.

## Usage

- Install:

```sh

npm i -D dangerjs-wrapper

```

- Create a `dangerfile.js`

- Create the config file following this interface:

````typescript

interface DangerConfig {

  giphyApiKey: string

  minReviewersRequired: number

  ticketLinkRegExp: RegExp

  changedFilesLimit: number

  testFilesRegExp?: RegExp

  docFilesRegExp?: RegExp

}

````

- Call the function `checkPullRequest` passing the config as a param

```js

const { checkPullRequest } = require('dangerjs-wrapper')

const dangerConfig = {

  giphyApiKey: 'irrelevant',

  docFilesRegExp: /./g,

  changedFilesLimit: 4,

  minReviewersRequired: 2,

  ticketLinkRegExp: /https:\/\/dev.example.com/g,

}

checkPullRequest(dangerConfig)

```

## Changelog

See the GitHub [release history](https://github.com/guidesmiths/dangerjs-wrapper/releases).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).