test(cz-commitlint): Add Util Function Tests

Author: curly210102

@commitlint/cz-commitlint/README.md

@@ -0,0 +1,88 @@
+> Commitizen adapter using the commitlint.config.js
+
+# @commitlint/cz-commitlint
+
+This is a commitizen adapter, using this adapter, commitizen works based on commitlint.config.js.
+
+Submit by commitizen, lint by commitlint, just need maintain one configuration file, Consistent and Scalable.
+
+The interactive process is inspired by [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog).
+
+## Getting started
+
+### Using commitizen adapter
+
+```bash
+npm install --save-dev @commitlint/cz-commitlint commitizen
+```
+
+In package.json
+
+```
+{
+  "scripts": {
+    "commit": "git-cz"
+  },
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/cz-commitlint"
+    }
+  }
+}
+```
+
+### Configure commitlint
+
+```bash
+# Install commitlint cli and conventional config
+npm install --save-dev @commitlint/config-conventional @commitlint/cli
+
+# Simple: config with conventional
+echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
+
+# commitlint configuration is shareable,
+# Install lerna-scopes
+npm install --save-dev @commitlint/config-lerna-scopes
+# Scalable: config with lerna-scopes in monorepo mode
+echo "module.exports = {extends: ['@commitlint/config-conventional', '@commitlint/config-lerna-scopes']};" > commitlint.config.js
+```
+
+### Set Git Hooks by husky
+
+```base
+
+# ------- using npm ----------
+# Install Husky
+npm install husky --save-dev
+# Active hooks
+npx husky install
+# Add commitlint hook
+npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
+# Add commitizen hook
+npx husky add .husky/prepare-commit-msg 'exec < /dev/tty && node_modules/.bin/cz --hook || true'
+
+
+# ------- using yarn ----------
+# Install Husky
+yarn add husky --dev
+# Active hooks
+yarn husky install
+# Add commitlint hook
+yarn husky add .husky/commit-msg 'yarn --no-install commitlint --edit $1'
+# Add commitizen hook
+yarn husky add .husky/prepare-commit-msg 'exec < /dev/tty && node_modules/.bin/cz --hook || true'
+
+```
+
+### Try it out
+
+```bash
+git add .
+npm run commit
+# or
+yarn run commit
+```
+
+## Related
+
+- [Commitlint Shared Configuration](https://github.com/conventional-changelog/commitlint#shared-configuration) - You can find more shared configurations are available to install and use with commitlint

@commitlint/cz-commitlint/TODO

@@ -0,0 +1,5 @@
+[] jest Test
+[] insert prompt settings to commitlint.config.js
+[] support emoji and title
+[] support multi line
+[] recognize "signed-off-by" and "references-empty" rules

@commitlint/cz-commitlint/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "cz-conventional-changelog",
+  "name": "cz-commitlint",
   "version": "1.0.0",
   "description": "Commitizen adapter using the commitlint.config.js",
   "main": "./lib/index.js",
@@ -30,9 +30,6 @@
     "lodash": "^4.17.21",
     "word-wrap": "^1.2.3"
   },
-  "devDependencies": {
-    "@types/inquirer": "^7.3.1"
-  },
   "peerDependencies": {
     "commitizen": "^4.0.3",
     "inquirer": "^8.0.0"

@commitlint/cz-commitlint/src/Prompter.ts

@@ -3,7 +3,7 @@ import {Answers, DistinctQuestion, Inquirer} from 'inquirer';
 import wrap from 'word-wrap';
 import Question, {QuestionConfig} from './Question';
 import {PromptConfig, PromptName, Rule, RuleField} from './types';
-import getForcedCaseFn from './utils/case-fn';
+import getCaseFn from './utils/case-fn';
 import getFullStopFn from './utils/full-stop-fn';
 import getLeadingBlankFn from './utils/leading-blank-fn';
 import {
@@ -96,60 +96,54 @@ export default class Prompter {
 			.filter((name) => name in this.prompts.questions)
 			.map((name) => {
 				const {questions, messages} = this.prompts;
-				const instance = new Question(name, {
+
+				const questionConfigs = {
 					messages: {
-						title: questions[name]?.description,
+						title: questions[name]?.description ?? '',
 						...messages,
 					},
 					maxLength: footerMaxLength,
 					minLength: footerMinLength,
-				});
-
-				const combineFooter = this.combineFooter.bind(this);
-				instance.onBeforeAsk = function (answers) {
-					const remainLength = footerMaxLength - combineFooter(answers).length;
-					this.maxLength = Math.min(this.maxLength, remainLength);
-					this.minLength = Math.max(this.minLength, footerMinLength);
 				};
 
 				if (name === 'isBreaking') {
-					instance.setQuestionProperty({
-						default: false,
+					Object.assign(questionConfigs, {
+						defaultValue: false,
 					});
 				}
 
 				if (name === 'breaking') {
-					instance.setQuestionProperty({
+					Object.assign(questionConfigs, {
 						when: (answers: Answers) => {
 							return answers.isBreaking;
 						},
 					});
 				}
 
 				if (name === 'breakingBody') {
-					instance.setQuestionProperty({
+					Object.assign(questionConfigs, {
 						when: (answers: Answers) => {
 							return answers.isBreaking && !answers.body;
 						},
 					});
 				}
 
 				if (name === 'isIssueAffected') {
-					instance.setQuestionProperty({
+					Object.assign(questionConfigs, {
 						default: false,
 					});
 				}
 
 				if (name === 'issues') {
-					instance.setQuestionProperty({
+					Object.assign(questionConfigs, {
 						when: (answers: Answers) => {
 							return answers.isIssueAffected;
 						},
 					});
 				}
 
 				if (name === 'issuesBody') {
-					instance.setQuestionProperty({
+					Object.assign(questionConfigs, {
 						when: (answers: Answers) => {
 							return (
 								answers.isIssueAffected &&
@@ -159,6 +153,13 @@ export default class Prompter {
 						},
 					});
 				}
+				const instance = new Question(name, questionConfigs);
+				const combineFooter = this.combineFooter.bind(this);
+				instance.onBeforeAsk = function (answers) {
+					const remainLength = footerMaxLength - combineFooter(answers).length;
+					this.maxLength = Math.min(this.maxLength, remainLength);
+					this.minLength = Math.max(this.minLength, footerMinLength);
+				};
 
 				return instance.getQuestion();
 			});
@@ -219,12 +220,12 @@ export default class Prompter {
 		return {
 			skip: canBeSkip,
 			enumList,
-			caseFn: getForcedCaseFn(this.getRule(rulePrefix, 'case')),
+			caseFn: getCaseFn(this.getRule(rulePrefix, 'case')),
 			fullStopFn: getFullStopFn(this.getRule(rulePrefix, 'full-stop')),
 			minLength: getMinLength(this.getRule(rulePrefix, 'min-length')),
 			maxLength: getMaxLength(this.getRule(rulePrefix, 'max-length')),
 			messages: {
-				title: questionSettings?.['description'],
+				title: questionSettings?.['description'] ?? '',
 				...messages,
 			},
 		};

@commitlint/cz-commitlint/src/Question.ts

@@ -1,32 +1,32 @@
 import chalk from 'chalk';
 import inquirer, {
 	Answers,
+	AsyncDynamicQuestionProperty,
 	ChoiceCollection,
 	DistinctQuestion,
-	Question as InquirerQuestion,
 } from 'inquirer';
 import {PromptName} from './types';
 import {CaseFn} from './utils/case-fn';
 import {FullStopFn} from './utils/full-stop-fn';
 
-// TODO Require 'title'
-type Messages = Partial<
-	Record<
-		| 'skip'
-		| 'title'
-		| 'max'
-		| 'min'
-		| 'emptyWarning'
-		| 'upperLimitWarning'
-		| 'lowerLimitWarning',
-		string
-	>
->;
+type Messages = Record<'title', string> &
+	Partial<
+		Record<
+			| 'skip'
+			| 'max'
+			| 'min'
+			| 'emptyWarning'
+			| 'upperLimitWarning'
+			| 'lowerLimitWarning',
+			string
+		>
+	>;
 export type QuestionConfig = {
 	messages: Messages;
 	maxLength: number;
 	minLength: number;
-	defaultValue?: string | boolean;
+	defaultValue?: string;
+	when?: AsyncDynamicQuestionProperty<boolean, Answers>;
 	skip?: boolean;
 	enumList?: ChoiceCollection<{
 		name: string;
@@ -48,10 +48,11 @@ export default class Question {
 	constructor(
 		name: PromptName,
 		{
-			defaultValue,
 			enumList,
 			messages,
-			skip,
+			defaultValue,
+			when,
+			skip = false,
 			fullStopFn = (_: string) => _,
 			caseFn = (_: string) => _,
 			maxLength = Infinity,
@@ -80,23 +81,18 @@ export default class Question {
 							},
 					  ]
 					: enumList,
-				default: defaultValue,
 			};
 		} else {
 			this.#data = {
 				type: /^is[A-Z]/.test(name) ? 'confirm' : 'input',
 				name: name,
 				message: this.decorateMessage,
-				default: defaultValue,
 				transformer: this.transformer,
 			};
 		}
 
-		Object.assign(this.#data, {
-			filter: this.filter,
-			validate: this.validate,
-		});
-
+		this.#data.default = defaultValue;
+		this.#data.when = when;
 		this.#data.filter = this.filter;
 		this.#data.validate = this.validate;
 	}
@@ -113,10 +109,6 @@ export default class Question {
 		return this.#data.name;
 	}
 
-	setQuestionProperty(property: InquirerQuestion): void {
-		Object.assign(this.#data, property);
-	}
-
 	validate: (input: string) => boolean | string = (input) => {
 		const filterSubject = this.filter(input);