docubook/commitlint.config.js at main · DocuBook/docubook · 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
/** @type {import('czg').GlobalOptions} */
const config = {
  extends: ["@commitlint/config-conventional"],
  rules: {
    "type-enum": [
      2,
      "always",
      [
        "feat",
        "fix",
        "docs",
        "style",
        "refactor",
        "perf",
        "test",
        "build",
        "ci",
        "chore",
        "revert",
      ],
    ],
    "subject-case": [2, "never", ["sentence-case", "start-case", "pascal-case", "upper-case"]],
    "header-max-length": [2, "always", 100],
  },
  prompt: {
    alias: {
      fd: "docs: fix typos",
      af: "fix: fix something",
    },
    customScopesAlign: {
      when: "always",
      value: [
        "docs",
        "app",
        "packages",
        "cli",
        "core",
        "mdx-content",
        "template",
        "components",
        "utils",
        "hooks",
        "types",
        "configs",
        "scripts",
      ],
    },
    defaultScopes: ["packages"],
    allowEmptyScopes: true,
    emptyScopesAlias: "empty",
    upperCaseSubject: false,
  },
};

export default config;