ctxport/commitlint.config.js at main · nicepkg/ctxport · 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
// @ts-check

/**
 * Commitlint configuration
 * @see https://commitlint.js.org/
 *
 * Follows Angular commit convention:
 * <type>(<scope>): <subject>
 *
 * Types:
 * - feat:     A new feature
 * - fix:      A bug fix
 * - docs:     Documentation only changes
 * - style:    Changes that do not affect the meaning of the code
 * - refactor: A code change that neither fixes a bug nor adds a feature
 * - perf:     A code change that improves performance
 * - test:     Adding missing tests or correcting existing tests
 * - build:    Changes that affect the build system or external dependencies
 * - ci:       Changes to CI configuration files and scripts
 * - chore:    Other changes that don't modify src or test files
 * - revert:   Reverts a previous commit
 *
 * Examples:
 * - feat(web): add dark mode toggle
 * - fix(api): handle null response from server
 * - docs: update README with installation instructions
 * - chore: update dependencies
 */

/** @type {import('@commitlint/types').UserConfig} */
export default {
  extends: ['@commitlint/config-conventional'],
  rules: {
    // Type must be one of the allowed types
    'type-enum': [
      2,
      'always',
      [
        'feat',
        'fix',
        'docs',
        'style',
        'refactor',
        'perf',
        'test',
        'build',
        'ci',
        'chore',
        'revert',
      ],
    ],
    // Type must be lowercase
    'type-case': [2, 'always', 'lower-case'],
    // Type cannot be empty
    'type-empty': [2, 'never'],
    // Subject cannot be empty
    'subject-empty': [2, 'never'],
    // Subject must not end with period
    'subject-full-stop': [2, 'never', '.'],
    // Header max length
    'header-max-length': [2, 'always', 100],
  },
};