UNPKG

commitlint-plugin-spend

Version:

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

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

nico-i/commitlint-plugin-spend

104 lines (68 loc) • 1.87 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# 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. Note: Purposefully does not support ISO date suffixes or negative time values, since they do not make sense in the context of a commit message. ## 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"] } } ``` ## Examples ### Valid commit messages ```text feat: implement user authentication /spend 2h 30m ``` ```text fix: resolve database connection timeout /spend_time 1d 3h 15m ``` ```text refactor: optimize API response handling /spend 1mo 2w 3d 4h 5m ``` ### Invalid commit messages ```text feat: implement user authentication /spend ``` _Error: Spend directive must contain at least one time value_ ```text fix: resolve database connection timeout /spend 25h 70m ``` _Error: The time value "25h" exceeds the maximum value for "h" (max value: 23)_ ```text refactor: optimize API response handling /spend 30m 2h 1d ``` _Error: Time values are not in the correct order. Time values must be ordered from largest to smallest unit_ ## License [MIT](./LICENSE)