jsdoc-template/commitlint.config.js at main · braintree/jsdoc-template · 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
'use strict';

module.exports = {
  'extends': ['@commitlint/config-conventional'],

  // Customize rules
  rules: {
    // Type must be one of the specified values
    'type-enum': [
      2, // Error level (0=off, 1=warn, 2=error)
      'always',
      [
        'feat', // New feature
        'fix', // Bug fix
        'review',
        'docs', // Documentation
        'style', // Formatting
        'refactor', // Code restructuring
        'perf', // Performance
        'test', // Tests
        'build', // Build system
        'dx', // Developer experience
        'ci', // CI configuration
        'chore', // Maintenance
        'revert' // Revert commit
      ]
    ],

    'scope-enum': [
      2,
      'always',
      [
        'american-express',
        'apple-pay',
        'client',
        'data-collector',
        'fastlane',
        'google-payment',
        'hosted-fields',
        'instant-verification',
        'local-payment',
        'payment-ready',
        'payment-request',
        'paypal-checkout',
        'paypal-checkout-v6',
        'sepa',
        'three-d-secure',
        'us-bank-account',
        'vault-manager',
        'venmo',
        'deps',
        'dev-deps',
        'other'
      ]
    ],
    // Scope is optional but recommended
    'scope-empty': [1, 'never'],

    // Subject configuration
    'subject-empty': [2, 'never'],
    'subject-case': [0, 'always', 'sentence-case'],
    'subject-full-stop': [1, 'never', '.'],
    'subject-max-length': [2, 'always', 85],

    // Body configuration
    'body-max-line-length': [2, 'always', 100],

    // Footer configuration
    'footer-max-line-length': [2, 'always', 100]
  }
};