feat(load): allow specifying helpUrl via config (#2180)

It can make configuration a bit more DRY if one can use the commitlint
configuration object to specify a custom help URL vs. having wrapper
scripts and similar things to make every invocation of `commitlint` run
with `--help-url` specified.

To allow this, `helpUrl` is added as an optional base configuration
property, and falls back to the original default URL if neither the CLI
flag nor config option is specified. The CLI option takes precedence
over the config object, if both are supplied.

Author: ellsclytn

@commitlint/cli/fixtures/help-url/commitlint.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+	rules: {
+		'type-enum': [2, 'never', ['foo']]
+	},
+	helpUrl: 'https://www.example.com/foo'
+};

@commitlint/cli/src/cli.test.ts

@@ -120,6 +120,13 @@ test('should fail for input from stdin with rule from js', async () => {
 	expect(actual.exitCode).toBe(1);
 });
 
+test('should output help URL defined in config file', async () => {
+	const cwd = await gitBootstrap('fixtures/help-url');
+	const actual = await cli([], {cwd})('foo: bar');
+	expect(actual.stdout).toContain('Get help: https://www.example.com/foo');
+	expect(actual.exitCode).toBe(1);
+});
+
 test('should produce no error output with --quiet flag', async () => {
 	const cwd = await gitBootstrap('fixtures/simple');
 	const actual = await cli(['--quiet'], {cwd})('foo: bar');

@commitlint/cli/src/cli.ts

@@ -229,12 +229,12 @@ async function main(options: CliFlags) {
 		}
 	);
 
+	const helpUrl = flags['help-url']?.trim() || loaded.helpUrl;
+
 	const output = format(report, {
 		color: flags.color,
 		verbose: flags.verbose,
-		helpUrl: flags['help-url']
-			? flags['help-url'].trim()
-			: 'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',
+		helpUrl,
 	});
 
 	if (!flags.quiet && output !== '') {

@commitlint/load/src/load.ts

@@ -112,6 +112,11 @@ export default async function load(
 		return registry;
 	}, {});
 
+	const helpUrl =
+		typeof config.helpUrl === 'string'
+			? config.helpUrl
+			: 'https://github.com/conventional-changelog/commitlint/#what-is-commitlint';
+
 	return {
 		extends: preset.extends!,
 		formatter: preset.formatter!,
@@ -120,5 +125,6 @@ export default async function load(
 		defaultIgnores: preset.defaultIgnores!,
 		plugins: preset.plugins!,
 		rules: qualifiedRules,
+		helpUrl,
 	};
 }

@commitlint/load/src/utils/pick-config.ts

@@ -10,5 +10,6 @@ export const pickConfig = (input: unknown): UserConfig =>
 		'parserPreset',
 		'formatter',
 		'ignores',
-		'defaultIgnores'
+		'defaultIgnores',
+		'helpUrl'
 	);

@commitlint/types/src/lint.ts

@@ -19,6 +19,7 @@ export interface LintOptions {
 	parserOpts?: ParserOptions;
 
 	plugins?: PluginRecords;
+	helpUrl?: string;
 }
 
 export interface LintOutcome {

@commitlint/types/src/load.ts

@@ -21,6 +21,7 @@ export interface UserConfig {
 	ignores?: ((commit: string) => boolean)[];
 	defaultIgnores?: boolean;
 	plugins?: (string | Plugin)[];
+	helpUrl?: string;
 }
 
 export interface UserPreset {
@@ -43,6 +44,7 @@ export interface QualifiedConfig {
 	ignores: ((commit: string) => boolean)[];
 	defaultIgnores: boolean;
 	plugins: PluginRecords;
+	helpUrl: string;
 }
 
 export interface ParserPreset {

docs/reference-api.md

@@ -203,6 +203,10 @@ type Seed = {
    * Initial map of rules to check against
    */
   rules?: {[ruleName: string]: Rule};
+  /**
+   * URL to print as help for reports with problems
+   */
+  helpUrl?: string;
 };
 
 type Config = {
@@ -218,6 +222,10 @@ type Config = {
    * Merged map of rules to check against
    */
   rules: {[ruleName: string]: Rule};
+  /**
+   * URL to print as help for reports with problems
+   */
+  helpUrl?: string;
 };
 
 type LoadOptions = {

docs/reference-configuration.md

@@ -34,6 +34,10 @@ type Config = {
    * Whether commitlint uses the default ignore rules.
    */
   defaultIgnores?: boolean;
+  /*
+   * Custom URL to show upon failure
+   */
+  helpUrl?: string;
 };
 
 const Configuration: Config = {
@@ -66,6 +70,11 @@ const Configuration: Config = {
    * Whether commitlint uses the default ignore rules.
    */
   defaultIgnores: true,
+  /*
+   * Custom URL to show upon failure
+   */
+  helpUrl:
+    'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',
 };
 
 module.exports = Configuration;