File tree 4 files changed +18
-13
lines changed
4 files changed +18
-13
lines changed Original file line number Diff line number Diff line change 1
- 18
1
+ 20
Original file line number Diff line number Diff line change 1
1
# HDNET commitlint-config
2
2
3
- This packages defines the strict implementation of the HDNET Commit Message Guidelines
4
- from the HDNET Standard Recommendations
3
+ This packages defines the strict implementation of the HDNET Commit Message Guidelines
4
+ from the HDNET Standard Recommendations
5
5
([ HSR-3] ( https://wiki.hdnet.de/display/OPS/HSR-3%3A+Git+Commit-Messages ) ) as npm package
6
- using [ commitlint] ( https://commitlint.js.org/ )
7
- through a [ shareable config] ( https://commitlint.js.org/#/concepts-shareable-config ) .
6
+ using [ commitlint] ( https://commitlint.js.org/ )
7
+ through a [ shareable config] ( https://commitlint.js.org/#/concepts-shareable-config ) .
8
8
9
9
## Getting started
10
10
11
- 1 . Make sure you setup node >= 14 .
11
+ 1 . Ideally, setup Node.js >= 20 .
12
12
13
13
2 . Install dependencies
14
14
``` bash
15
- Node.js < 18
16
- $ npm i -D @commitlint/cli@17 @hdnet/commitlint-config
17
-
18
- Node.js > = 18
19
15
$ npm i -D @commitlint/cli @hdnet/commitlint-config
16
+
17
+ For Node.js < 18:
18
+ $ npm i -D @commitlint/cli@17 @hdnet/commitlint-config@0
19
+
20
+ For Node.js < 20:
21
+ $ npm i -D @commitlint/cli@18 @hdnet/commitlint-config@0
20
22
```
21
23
22
24
3 . Create commitlint config (i.e. ` commitlint.config.js ` ) and extend from @hdnet/commitlint-config :
@@ -38,5 +40,5 @@ module.exports = {
38
40
39
41
## Contribute
40
42
41
- To setup current node version, you can use [ nvm] ( https://github.com/nvm-sh/nvm )
43
+ To setup current node version, you can use [ nvm] ( https://github.com/nvm-sh/nvm )
42
44
(in this project a [ .nvmrc] ( ./.nvmrc ) file is maintained).
Original file line number Diff line number Diff line change 3
3
"version" : " 0.2.0" ,
4
4
"description" : " HDNET commitlint-config, implementing HSR-3" ,
5
5
"author" : " HDNET" ,
6
+ "engines" : {
7
+ "node" : " >=20.11.0"
8
+ },
6
9
"keywords" : [
7
10
" commitlint" ,
8
11
" hdnet" ,
Original file line number Diff line number Diff line change 1
- # [ package.json] ( https://docs.npmjs.com/cli/v7 /configuring-npm/package-json )
1
+ # [ package.json] ( https://docs.npmjs.com/cli/v10 /configuring-npm/package-json )
2
2
3
3
> This document serves as a replacement for comments in ` package.json ` , since it includes a lot of configuration often
4
4
> requiring explanation.
5
5
6
- - [ scripts] ( https://docs.npmjs.com/cli/v7 /configuring-npm/package-json#scripts )
6
+ - [ scripts] ( https://docs.npmjs.com/cli/v10 /configuring-npm/package-json#scripts )
7
7
- ` prepare ` Installs git hooks with husky. In production and CI, it omits an error
8
8
(i.e. husky can not be found when installed with ` npm install --omit=dev ` )
9
9
through husky's suggested disabled ci settings
You can’t perform that action at this time.
0 commit comments