Reference may not be empty

Expected Behavior

➜ echo "feat(code): KON-69 fix navbar style"  | npx commitlint
⧗   input: feat(code): KON-69 fix navbar style
✔   found 0 problems, 0 warnings

Current Behavior

➜ echo "feat(code): KON-69 fix navbar style"  | npx commitlint
⧗   input: feat(code): KON-69 fix navbar style
✖   references may not be empty [references-empty]
✖   found 1 problems, 0 warnings

~/code/1k/frontend develop

code/1k/frontend on  develop 
➜ echo "feat(code): KON-69 change navbar style"  | npx commitlint
⧗   input: feat(code): KON-69 change navbar style
✔   found 0 problems, 0 warnings


~/code/1k/frontend develop

code/1k/frontend on  develop 
➜ echo "feat(code): KON-69 update navbar style"  | npx commitlint
⧗   input: feat(code): KON-69 update navbar style
✔   found 0 problems, 0 warnings

Affected packages

• [x ] cli

commitlint.config.js

/**
 * If you need to add your own validated
 * scope for git commit message, just add a new value to scope-enum
 * as shown below
 * code - this is general scope
 * deployment - when devops team does something related to CI/CD
 * see this: https://github.com/marionebl/commitlint/blob/master/%40commitlint/config-conventional/index.js
 * this solution require JIRA project prefix defined in issuePrefixes
 * and then reference-empty rule
 */
module.exports = {
  extends:      ['@commitlint/config-conventional'],
  parserPreset: {
    parserOpts: {
      issuePrefixes: ['KON-'],
    },
  },
  rules: {
    'header-max-length': [ 1, 'always', 72 ],
    'scope-enum':        [ 1, 'always', [
      'code',
      'deployment',
      'tests',
    ] ],
    'references-empty': [ 2, 'never' ],
  },

Your Environment

Executable	Version
commitlint --version	6.1.3
git --version	2.7.1
node --version	8.7.0

[viktorsec]

This is because fix is a reserved word that expects to be followed by issue number. GitHub will then automatically close that issue after merging such commit into the default branch.

[marionebl]

@viktorsec is right, this is indeed correct yet a bit surprising behavior driven by conventional-commits-parser’s defaults:.

You could work around this by passing an empty referenceActions array to conventional changelog:

// commitlint.config.js
parserPreset: {
  parserOpts: {
    referenceActions: [],
    issuePrefixes: ['KON-'],
  },
},