ProposalOS/commitlint.config.js at main · danishxsethi/ProposalOS · 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      [
        'build',
        'chore',
        'ci',
        'docs',
        'feat',
        'fix',
        'perf',
        'refactor',
        'revert',
        'style',
        'test',
        'config',
        'audit',
        'remediation',
      ],
    ],
    'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
    'subject-empty': [2, 'never'],
    'subject-full-stop': [2, 'never', '.'],
    'subject-max-length': [2, 'always', 72],
    'body-max-line-length': [2, 'always', 100],
    'body-leading-blank': [2, 'always'],
    'footer-leading-blank': [2, 'always'],
    'footer-max-line-length': [2, 'always', 100],
  },
  prompt: {
    questions: {
      type: {
        description: "Select the type of change you're committing",
        enum: {
          build: {
            description: 'Affects the build system or external dependencies',
            title: 'Build',
          },
          chore: {
            description: 'Other changes that do not modify src or test files',
            title: 'Chore',
          },
          ci: {
            description: 'Changes to CI configuration files and scripts',
            title: 'CI',
          },
          docs: {
            description: 'Documentation only changes',
            title: 'Docs',
          },
          feat: {
            description: 'A new feature',
            title: 'Feat',
          },
          fix: {
            description: 'A bug fix',
            title: 'Fix',
          },
          perf: {
            description: 'A code change that improves performance',
            title: 'Perf',
          },
          refactor: {
            description: 'A code change that neither fixes a bug nor adds a feature',
            title: 'Refactor',
          },
          revert: {
            description: 'Reverts a previous commit',
            title: 'Revert',
          },
          style: {
            description: 'Changes that do not affect the meaning of the code',
            title: 'Style',
          },
          test: {
            description: 'Adding missing tests or correcting existing tests',
            title: 'Test',
          },
          config: {
            description: 'Configuration changes for tools and linters',
            title: 'Config',
          },
          audit: {
            description: 'Audit-related changes and reports',
            title: 'Audit',
          },
          remediation: {
            description: 'Code quality remediation and cleanup',
            title: 'Remediation',
          },
        },
      },
      scope: {
        description: 'What is the scope of this change (e.g., component or file name)',
      },
      subject: {
        description: 'Write a short, imperative tense description of the change',
      },
      body: {
        description: 'Provide a longer description of the change',
      },
      isBreaking: {
        description: 'Are there any breaking changes?',
      },
      breakingBody: {
        description: 'A BREAKING CHANGE commit requires a body',
      },
      breaking: {
        description: 'Describe the breaking changes',
      },
      isIssueAffected: {
        description: 'Does this change affect any open issues?',
      },
      issuesBody: {
        description: 'An issue affected commit requires a body',
      },
      issues: {
        description: 'Add issue references (e.g., "fix #123", "re #123")',
      },
    },
  },
};