customizing helpUrl

[naimo84]

it seems, that the helpUrl is hardcoded in the cli

Expected Behavior

Current Behavior

Affected packages

• cli
• core
• prompt
• config-angular

Possible Solution

const output = format(report, {
color: flags.color,
verbose: flags.verbose,
helpUrl: flags.helpUrl
});

Context

We have some custom rules for our commit rules in our confluence, so I'd like to reference it in the helpUrl

Executable	Version
commitlint --version	8.1.0
git --version	2.23.0.windows.1
node --version	10.15.0

[arvinzzq]

Is there any doc about customizing helpUrl?
All I found is to set

{
  formatter: '@commitlint/format',
}

in commitlint.config.js, but the value of property formatter should be type of string. It confused me that how to use the solution above:

  const output = format(report, {
      color: flags.color,
      verbose: flags.verbose,
      helpUrl: flags.helpUrl
  });

[escapedcat]

Hey @zz1211, you're right, it's not yet mentioned in the docs. It should be.
helpUrl is a flag you can set for the commitlint command in your package.json like this:

"husky": {
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS --help-url='https://github.com'"
  }
},

Does this help?

[arvinzzq]

Hey @zz1211, you're right, it's not yet mentioned in the docs. It should be.
helpUrl is a flag you can set for the commitlint command in your package.json like this:

"husky": {
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS --help-url='https://github.com'"
  }
},

Does this help?

Hi @escapedcat , thanks, it helps me 😊