https://github.com/nico-i/commitlint-plugin-spend

A commitlint plugin that requires the GitLab /spend or /spend_time directive in commit messages
https://github.com/nico-i/commitlint-plugin-spend

commitlint gitlab plugin spend time timetracking tracking

Last synced: 18 days ago
JSON representation

A commitlint plugin that requires the GitLab /spend or /spend_time directive in commit messages

• Host: GitHub
• URL: https://github.com/nico-i/commitlint-plugin-spend
• Owner: nico-i
• License: mit
• Created: 2024-02-04T22:29:31.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-07-09T17:42:39.000Z (4 months ago)
• Last Synced: 2024-10-17T16:06:13.684Z (28 days ago)
• Topics: commitlint, gitlab, plugin, spend, time, timetracking, tracking
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/commitlint-plugin-spend
• Size: 64.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# commitlint-plugin-spend

[Commitlint](https://commitlint.js.org/) plugin to enforce the use of [spend directives](https://docs.gitlab.com/ee/user/project/quick_actions.html#issues-merge-requests-and-epics) in commit messages.

## Available rules

### spend

- **condition**: `body` ends with a valid [spend directive](https://docs.gitlab.com/ee/user/project/quick_actions.html#issues-merge-requests-and-epics)

- **rule**: `always`

## Usage

1. Install the plugin:

```bash

npm i -D commitlint-plugin-spend

```

```bash

yarn add -D commitlint-plugin-spend

```

```bash

pnpm add -D commitlint-plugin-spend

```

```bash

bun add -d commitlint-plugin-spend

```

2. Add the plugin to your `commitlint` configuration:

```json

{

  "extends": ["@commitlint/config-conventional"],

  "plugins": ["commitlint-plugin-spend"]

}

```

3. Configure the `spend` rule in your `commitlint` configuration:

```json

{

  "rules": {

    "spend": [2, "always"]

  }

}

```

## License

[MIT](./LICENSE)