feat(cli): use special errorCode for missing rules/config #4142

@commitlint/cli/src/cli-error.ts

@@ -1,10 +1,25 @@
+export enum ExitCode {
+	Normal = 0,
+	UncaughtFatalException = 1,
+	ReservedByBash = 2,
+	InternalJavaScriptParseError = 3,
+	InternalJavaScriptEvaluationFailure = 4,
+	FatalError = 5,
+	NonFunctionInternalExceptionHandler = 6,
+	InvalidArgument = 9,
+}
+
 export class CliError extends Error {
 	__proto__ = Error;
 
 	public type: string;
-	public error_code: number;
+	public error_code: ExitCode;
 
-	constructor(message: string, type: string, error_code = 1) {
+	constructor(
+		message: string,
+		type: string,
+		error_code = ExitCode.UncaughtFatalException
+	) {
 		super(message);
 
 		this.type = type;

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

@@ -107,7 +107,7 @@ test('should produce help for empty config', async () => {
 	const result = cli([], {cwd})('foo: bar');
 	const output = await result;
 	expect(output.stdout.trim()).toContain('Please add rules');
-	expect(result.exitCode).toBe(1);
+	expect(result.exitCode).toBe(9);
 });
 
 test('should produce help for problems', async () => {
@@ -137,7 +137,7 @@ test('should fail for input from stdin without rules', async () => {
 	const cwd = await gitBootstrap('fixtures/empty');
 	const result = cli([], {cwd})('foo: bar');
 	await result;
-	expect(result.exitCode).toBe(1);
+	expect(result.exitCode).toBe(9);
 });
 
 test('should succeed for input from stdin with rules', async () => {

@commitlint/cli/src/cli.ts

@@ -20,7 +20,7 @@ import yargs, {type Arguments} from 'yargs';
 
 import {CliFlags} from './types.js';
 
-import {CliError} from './cli-error.js';
+import {CliError, ExitCode} from './cli-error.js';
 
 const require = createRequire(import.meta.url);
 
@@ -316,6 +316,7 @@ async function main(args: MainArgs): Promise<void> {
 		messages.map((message) => lint(message, loaded.rules, opts))
 	);
 
+	let isRulesEmpty = false;
 	if (Object.keys(loaded.rules).length === 0) {
 		let input = '';
 
@@ -340,6 +341,8 @@ async function main(args: MainArgs): Promise<void> {
 			warnings: [],
 			input,
 		});
+
+		isRulesEmpty = true;
 	}
 
 	const report = results.reduce<{
@@ -378,12 +381,19 @@ async function main(args: MainArgs): Promise<void> {
 
 	if (flags.strict) {
 		if (report.errorCount > 0) {
-			throw new CliError(output, pkg.name, 3);
+			throw new CliError(
+				output,
+				pkg.name,
+				ExitCode.InternalJavaScriptParseError
+			);
 		}
 		if (report.warningCount > 0) {
-			throw new CliError(output, pkg.name, 2);
+			throw new CliError(output, pkg.name, ExitCode.ReservedByBash);
 		}
 	}
+	if (isRulesEmpty) {
+		throw new CliError(output, pkg.name, ExitCode.InvalidArgument);
+	}
 	if (!report.valid) {
 		throw new CliError(output, pkg.name);
 	}