fix(prompt): small code refactor

Author: armano2

.eslintrc.js

@@ -51,6 +51,7 @@ module.exports = {
 				'@typescript-eslint/no-var-requires': 'off',
 				'@typescript-eslint/no-inferrable-types': 'off',
 				'@typescript-eslint/no-non-null-assertion': 'off',
+				'@typescript-eslint/triple-slash-reference': 'off',
 
 				// TODO: enable those rules?
 				'no-empty': 'off',

@commitlint/prompt/src/input.test.ts

@@ -1,6 +1,6 @@
 import {Answers, PromptModule, QuestionCollection} from 'inquirer';
+/// <reference path="./inquirer/inquirer.d.ts" />
 import input from './input';
-import InputCustomPrompt from './inquirer/InputCustomPrompt';
 import chalk from 'chalk';
 
 jest.mock(
@@ -75,15 +75,7 @@ function stub(config: Record<string, Record<string, unknown>>): PromptModule {
 			if (answer == null) {
 				throw new Error(`Unexpected config name: ${promptConfig.name}`);
 			}
-			let validate = promptConfig.validate;
-			if (promptConfig.type === 'input-custom') {
-				const customInput = new InputCustomPrompt(
-					promptConfig,
-					{write: () => true} as any,
-					result
-				) as any;
-				validate = customInput.opt.validate.bind(customInput);
-			}
+			const validate = promptConfig.validate;
 			if (validate) {
 				const validationResult = validate(answer, result);
 				if (validationResult !== true) {

@commitlint/prompt/src/inquirer/InputCustomPrompt.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path="./inquirer.d.ts" />
 import {Interface as ReadlineInterface, Key} from 'readline';
 
@@ -10,7 +9,6 @@ import type {Subscription} from 'rxjs/internal/Subscription';
 
 import Answers = inquirer.Answers;
 import InputCustomOptions = inquirer.InputCustomOptions;
-import Validator = inquirer.Validator;
 import SuccessfulPromptStateData = inquirer.prompts.SuccessfulPromptStateData;
 
 interface KeyDescriptor {
@@ -46,42 +44,13 @@ export default class InputCustomPrompt<
 		this.tabCompletion = (this.opt.tabCompletion || [])
 			.map((item) => item.value)
 			.sort((a, b) => a.localeCompare(b));
-
-		this.opt.validate = this.extendedValidate(this.opt.validate);
 	}
 
 	onEnd(state: SuccessfulPromptStateData): void {
 		this.lineSubscription.unsubscribe();
 		super.onEnd(state);
 	}
 
-	extendedValidate(validate?: Validator<TQuestion>): Validator<TQuestion> {
-		return (input, answers) => {
-			if (input.length > this.opt.maxLength(answers)) {
-				return 'Input contains too many characters!';
-			}
-			if (this.opt.required && input.trim().length === 0) {
-				// Show help if enum is defined and input may not be empty
-				return `⚠ ${chalk.bold(this.opt.name)} may not be empty.`;
-			}
-
-			if (
-				input.length > 0 &&
-				this.tabCompletion.length > 0 &&
-				!this.tabCompletion.includes(input)
-			) {
-				return `⚠ ${chalk.bold(
-					this.opt.name
-				)} must be one of ${this.tabCompletion.join(', ')}.`;
-			}
-
-			if (validate) {
-				return validate(input, answers);
-			}
-			return true;
-		};
-	}
-
 	/**
 	 * @see https://nodejs.org/api/readline.html#readline_rl_write_data_key
 	 * @see https://nodejs.org/api/readline.html#readline_rl_line

@commitlint/prompt/src/inquirer/inquirer.d.ts

@@ -12,7 +12,6 @@ declare module 'inquirer' {
 		 * @inheritdoc
 		 */
 		type?: 'input-custom';
-		required?: boolean;
 		log?(answers?: T): string;
 		tabCompletion?: InputCustomCompletionOption[];
 		maxLength(answers?: T): number;

@commitlint/prompt/src/library/get-prompt.ts

@@ -1,6 +1,5 @@
 import chalk from 'chalk';
-
-import {InputCustomOptions, InputQuestion, ListQuestion} from 'inquirer';
+import {InputCustomOptions} from 'inquirer';
 
 import type {InputSetting, RuleEntry, Result, ResultPart} from './types';
 
@@ -30,11 +29,7 @@ export default function getPrompt(
 	type: ResultPart,
 	rules: RuleEntry[] = [],
 	settings: InputSetting = {}
-):
-	| InputQuestion<Result>
-	| ListQuestion<Result>
-	| InputCustomOptions<Result>
-	| null {
+): InputCustomOptions<Result> | null {
 	const emptyRule = rules.filter(getHasName('empty')).find(ruleIsActive);
 
 	const mustBeEmpty = emptyRule ? ruleIsApplicable(emptyRule) : false;
@@ -55,23 +50,53 @@ export default function getPrompt(
 
 	const enumRule = rules.filter(getHasName('enum')).find(enumRuleIsActive);
 
+	const tabCompletion = enumRule
+		? enumRule[1][2].map((enumerable) => {
+				const enumSettings = (settings.enumerables || {})[enumerable] || {};
+				return {
+					value: forceLeadingBlankFn(forceCaseFn(enumerable)),
+					description: enumSettings.description || '',
+				};
+		  })
+		: [];
+
+	const maxLength = (res: Result) => {
+		let remainingHeaderLength = Infinity;
+		if (settings.header && settings.header.length) {
+			const header = format({
+				type: res.type,
+				scope: res.scope,
+				subject: res.subject,
+			});
+			remainingHeaderLength = settings.header.length - header.length;
+		}
+		return Math.min(inputMaxLength, remainingHeaderLength);
+	};
+
 	return {
 		type: 'input-custom',
 		name: type,
 		message: `${type}:`,
-		validate(): boolean | string {
+		validate(input, answers) {
+			if (input.length > maxLength(answers || {})) {
+				return 'Input contains too many characters!';
+			}
+			if (required && input.trim().length === 0) {
+				// Show help if enum is defined and input may not be empty
+				return `⚠ ${chalk.bold(type)} may not be empty.`;
+			}
+
+			const tabValues = tabCompletion.map((item) => item.value);
+			if (
+				input.length > 0 &&
+				tabValues.length > 0 &&
+				!tabValues.includes(input)
+			) {
+				return `⚠ ${chalk.bold(type)} must be one of ${tabValues.join(', ')}.`;
+			}
 			return true;
 		},
-		tabCompletion: enumRule
-			? enumRule[1][2].map((enumerable) => {
-					const enumSettings = (settings.enumerables || {})[enumerable] || {};
-					return {
-						value: forceLeadingBlankFn(forceCaseFn(enumerable)),
-						description: enumSettings.description || '',
-					};
-			  })
-			: [],
-		required,
+		tabCompletion,
 		log(answers?: Result) {
 			let prefix =
 				`${chalk.white('Please enter a')} ${chalk.bold(type)}: ${meta({
@@ -90,18 +115,7 @@ export default function getPrompt(
 			}
 			return prefix + EOL;
 		},
-		maxLength(res: Result) {
-			let remainingHeaderLength = Infinity;
-			if (settings.header && settings.header.length) {
-				const header = format({
-					type: res.type,
-					scope: res.scope,
-					subject: res.subject,
-				});
-				remainingHeaderLength = settings.header.length - header.length;
-			}
-			return Math.min(inputMaxLength, remainingHeaderLength);
-		},
+		maxLength,
 		transformer(value: string) {
 			return forceCaseFn(value);
 		},