@cordada/commitlint-config-cordada 0.1.3 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/index.js +6 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -30,6 +30,20 @@ for a list of available rules.
|
|
|
30
30
|
TODO 🚧
|
|
31
31
|
|
|
32
32
|
|
|
33
|
+
## Ignored Commits
|
|
34
|
+
|
|
35
|
+
Besides the default ignores of commitlint, such as merge and revert commits, the commits created by
|
|
36
|
+
Dependabot are not linted. Dependabot writes their titles itself, and those of its grouped updates,
|
|
37
|
+
such as `chore(deps): Bump the <group> group across 1 directory with <N> updates`, can exceed the
|
|
38
|
+
maximum length of the title. They are recognized by the trailer
|
|
39
|
+
`Signed-off-by: dependabot[bot] <support@github.com>`, which Dependabot adds to every commit it
|
|
40
|
+
creates. A commit pushed by a person to a pull request of Dependabot does not carry it, and is
|
|
41
|
+
linted as usual.
|
|
42
|
+
|
|
43
|
+
A configuration that extends this one and sets `ignores` of its own replaces this list instead of
|
|
44
|
+
adding to it, so it has to repeat this ignore to keep it.
|
|
45
|
+
|
|
46
|
+
|
|
33
47
|
## Publishing Node.js Package
|
|
34
48
|
|
|
35
49
|
```sh
|
package/index.js
CHANGED
|
@@ -1,9 +1,14 @@
|
|
|
1
1
|
module.exports = {
|
|
2
2
|
extends: ["@commitlint/config-conventional"],
|
|
3
|
+
ignores: [
|
|
4
|
+
// Dependabot writes the titles of its commits itself, and those of its grouped updates can
|
|
5
|
+
// exceed `header-max-length`. It adds this trailer to every commit it creates.
|
|
6
|
+
(message) => /^Signed-off-by: dependabot\[bot\] <support@github\.com>$/m.test(message),
|
|
7
|
+
],
|
|
3
8
|
rules: {
|
|
4
9
|
"body-leading-blank": [2, "always"],
|
|
5
10
|
"body-max-line-length": [1, "always", 100],
|
|
6
|
-
"footer-leading-blank": [1 "always"],
|
|
11
|
+
"footer-leading-blank": [1, "always"],
|
|
7
12
|
"footer-max-line-length": [1, "always", 100],
|
|
8
13
|
"header-max-length": [2, "always", 72],
|
|
9
14
|
"subject-case": [2, "always", ["sentence-case"]],
|