File tree Expand file tree Collapse file tree 12 files changed +35
-9
lines changed
commitlint-config-angular
commitlint-config-lerna-scopes
commitlint-config-patternplate Expand file tree Collapse file tree 12 files changed +35
-9
lines changed Original file line number Diff line number Diff line change @@ -9,4 +9,4 @@ npm install --save-dev @commitlint/cli @commitlint/config-angular
9
9
echo " module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint.config.js
10
10
```
11
11
12
- Consult [ docs/cli] ( ../../docs/ cli) for comprehensive documentation.
12
+ Consult [ docs/cli] ( http://marionebl.github.io/commitlint/#/reference- cli) for comprehensive documentation.
Original file line number Diff line number Diff line change
1
+ # commitlint-config-angular
2
+
3
+ > Mirror of [ @commitlint/config-angular ] ( ../config-angular )
Original file line number Diff line number Diff line change
1
+ # commitlint-config-lerna-scopes
2
+
3
+ > Mirror of [ @commitlint/config-lerna-scopes ] ( ../config-lerna-scopes )
Original file line number Diff line number Diff line change
1
+ # commitlint-config-patternplate
2
+
3
+ > Mirror of [ @commitlint/config-patternplate ] ( ../config-patternplate )
Original file line number Diff line number Diff line change 1
1
> Lint your commits, angular-style
2
2
3
3
# @commitlint/config-angular
4
+
4
5
Shareable ` commitlint ` config enforcing the angular commit convention.
6
+ Use with [ @commitlint/cli ] ( ../cli ) and [ @commitlint/prompt-cli ] ( ../prompt-cli ) .
5
7
6
8
## Getting started
7
9
@@ -14,6 +16,8 @@ echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint
14
16
### Problems
15
17
16
18
The following rules are considered problems for ` @commitlint/config-angular ` and will yield a non-zero exit code when not met.
19
+ Consult [ docs/rules] ( http://marionebl.github.io/commitlint/#/reference-rules ) for a list of available rules.
20
+
17
21
18
22
#### type-enum
19
23
* ** condition** : ` type ` is found in value
Original file line number Diff line number Diff line change 2
2
3
3
# @commitlint/config-lerna-scopes
4
4
Shareable ` commitlint ` config enforcing lerna package names as scopes.
5
+ Use with [ @commitlint/cli ] ( ../cli ) and [ @commitlint/prompt-cli ] ( ../prompt-cli ) .
5
6
6
7
## Getting started
7
8
``` sh
@@ -37,3 +38,5 @@ packages
37
38
⧗ input: chore: do some general maintenance
38
39
✔ found 0 problems, 0 warnings
39
40
```
41
+
42
+ Consult [ docs/rules] ( http://marionebl.github.io/commitlint/#/reference-rules ) for a list of available rules.
Original file line number Diff line number Diff line change 2
2
3
3
# @commitlint/config-patternplate
4
4
Shareable ` commitlint ` config enforcing the patternplate commit convention.
5
+ Use with [ @commitlint/cli ] ( ../cli ) and [ @commitlint/prompt-cli ] ( ../prompt-cli ) .
5
6
6
7
## Getting started
7
8
``` sh
@@ -10,7 +11,8 @@ echo "module.exports = {extends: ['@commitlint/config-patternplate']};" > .commi
10
11
```
11
12
12
13
## Rules
13
- ` @commitlint/config-patternplate ` extends the [ shareable angular config] ( ../config-angular#rules ) . Additionally these rules apply:
14
+ ` @commitlint/config-patternplate ` extends the [ shareable angular config] ( ../config-angular#rules ) .
15
+ Additionally these rules apply:
14
16
15
17
### Problems
16
18
The following rules are considered problems for ` @commitlint/config-patterplate ` and will yield a non-zero exit code when not met.
@@ -19,3 +21,5 @@ The following rules are considered problems for `@commitlint/config-patterplate`
19
21
* ** description** : ` scope ` is found in ` value `
20
22
* ** rule** : ` always `
21
23
* ** value** : determined based on pattern tree. ` system ` and all pattern ids present in ` patterns ` are allowed
24
+
25
+ Consult [ docs/rules] ( http://marionebl.github.io/commitlint/#/reference-rules ) for a list of available rules.
Original file line number Diff line number Diff line change 8
8
npm install --save-dev @commitlint/core
9
9
```
10
10
11
- Consult [ docs/api] ( ../../docs/ api) for comprehensive documentation.
11
+ Consult [ docs/api] ( http://marionebl.github.io/commitlint/#/reference- api) for comprehensive documentation.
Original file line number Diff line number Diff line change @@ -13,3 +13,5 @@ echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint
13
13
git add .
14
14
commit
15
15
```
16
+
17
+ A full usage guide is available at [ docs/prompt] ( http://marionebl.github.io/commitlint/#/guides-use-prompt ) .
Original file line number Diff line number Diff line change 2
2
3
3
# @commitlint/prompt
4
4
5
+ This is the library and commitizen adapter version of commitlint prompt.
6
+ A ready-to-use cli version is available at [ @commitlint/prompt-cli ] ( ../prompt-cli ) .
7
+ Learn how to use it at [ docs/prompt] ( http://marionebl.github.io/commitlint/#/guides-use-prompt ) .
8
+
5
9
## Getting started
6
10
7
11
``` bash
You can’t perform that action at this time.
0 commit comments