charcole/commitlint.config.js at main · sheraz4196/charcole · GitHub

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
module.exports = {
  extends: ["@commitlint/config-conventional"],

  rules: {
    // ─── Type rules ──────────────────────────────────────────────────────────

    "type-enum": [
      2,
      "always",
      [
        "feat",
        "fix",
        "docs",
        "chore",
        "test",
        "refactor",
        "perf",
        "ci",
        "build",
        "revert",
      ],
    ],

    "type-case": [2, "always", "lower-case"],
    "type-empty": [2, "never"],

    // ─── Scope rules ─────────────────────────────────────────────────────────

    "scope-case": [2, "always", "lower-case"],
    "scope-enum": [
      1,
      "always",
      [
        "cli",
        "template",
        "payments",
        "swagger",
        "auth",
        "deps",
        "config",
        "ci",
        "docs",
        "tests",
        "release",
      ],
    ],

    // ─── Subject (the description after the colon) ───────────────────────────

    "subject-empty": [2, "never"],
    "subject-full-stop": [2, "never", "."],
    "subject-case": [2, "always", "lower-case"],
    "subject-min-length": [2, "always", 10],
    "subject-max-length": [2, "always", 72],

    // ─── Header (full first line) ────────────────────────────────────────────

    "header-max-length": [2, "always", 100],

    // ─── Body ──────────────────────────────────────────────────────────────

    "body-max-line-length": [2, "always", 100],

    // ─── Footer ──────────────────────────────────────────────────────────────

    "footer-max-line-length": [2, "always", 100],
  },

  helpUrl:
    "https://www.charcole.site/ — see CONTRIBUTING.md for commit format guide",
};

// Commit message format reference:
//
// type(scope): subject
//
// body (optional, explain WHY not WHAT)
//
// footer (optional, e.g. "Closes #42" or "BREAKING CHANGE: ...")