feat(cz-commitlint): add prompt field to commitlint config file, add tests for cz-commitlint

prompt field is working for prompt config, settled in commitlint config file, can be defined by shared configurations.

Author: curly210102

.gitignore

@@ -11,3 +11,4 @@ lib/
 package.json.lerna_backup
 /*.iml
 tsconfig.tsbuildinfo
+coverage

@commitlint/config-conventional/index.js

@@ -33,4 +33,102 @@ module.exports = {
 			],
 		],
 	},
+	prompt: {
+		questions: {
+			type: {
+				description: "Select the type of change that you're committing:",
+				enum: {
+					feat: {
+						description: 'A new feature',
+						title: 'Features',
+						emoji: '✨',
+					},
+					fix: {
+						description: 'A bug fix',
+						title: 'Bug Fixes',
+						emoji: '🐛',
+					},
+					docs: {
+						description: 'Documentation only changes',
+						title: 'Documentation',
+						emoji: '📚',
+					},
+					style: {
+						description:
+							'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
+						title: 'Styles',
+						emoji: '💎',
+					},
+					refactor: {
+						description:
+							'A code change that neither fixes a bug nor adds a feature',
+						title: 'Code Refactoring',
+						emoji: '📦',
+					},
+					perf: {
+						description: 'A code change that improves performance',
+						title: 'Performance Improvements',
+						emoji: '🚀',
+					},
+					test: {
+						description: 'Adding missing tests or correcting existing tests',
+						title: 'Tests',
+						emoji: '🚨',
+					},
+					build: {
+						description:
+							'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
+						title: 'Builds',
+						emoji: '🛠',
+					},
+					ci: {
+						description:
+							'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
+						title: 'Continuous Integrations',
+						emoji: '⚙️',
+					},
+					chore: {
+						description: "Other changes that don't modify src or test files",
+						title: 'Chores',
+						emoji: '♻️',
+					},
+					revert: {
+						description: 'Reverts a previous commit',
+						title: 'Reverts',
+						emoji: '🗑',
+					},
+				},
+			},
+			scope: {
+				description:
+					'What is the scope of this change (e.g. component or file name)',
+			},
+			subject: {
+				description: 'Write a short, imperative tense description of the change',
+			},
+			body: {
+				description: 'Provide a longer description of the change',
+			},
+			isBreaking: {
+				description: 'Are there any breaking changes?',
+			},
+			breakingBody: {
+				description:
+					'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself',
+			},
+			breaking: {
+				description: 'Describe the breaking changes',
+			},
+			isIssueAffected: {
+				description: 'Does this change affect any open issues?',
+			},
+			issuesBody: {
+				description:
+					'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself',
+			},
+			issues: {
+				description: 'Add issue references (e.g. "fix #123", "re #123".)',
+			},
+		},
+	}
 };

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

@@ -0,0 +1,36 @@
+import {QualifiedRules, UserPromptConfig} from '@commitlint/types';
+import {Inquirer} from 'inquirer';
+import {
+	combineCommitMessage as combineBody,
+	getQuestions as getBodyQuestions,
+} from './SectionBody';
+import {
+	combineCommitMessage as combineFooter,
+	getQuestions as getFooterQuestions,
+} from './SectionFooter';
+import {
+	combineCommitMessage as combineHeader,
+	getQuestions as getHeaderQuestions,
+} from './SectionHeader';
+import {setPromptConfig} from './store/prompts';
+import {setRules} from './store/rules';
+
+export default async function (
+	rules: QualifiedRules,
+	prompts: UserPromptConfig,
+	inquirer: Inquirer
+): Promise<string> {
+	setRules(rules);
+	setPromptConfig(prompts);
+	const questions = [
+		...getHeaderQuestions(),
+		...getBodyQuestions(),
+		...getFooterQuestions(),
+	];
+	const answers = await inquirer.prompt(questions);
+	const header = combineHeader(answers);
+	const body = combineBody(answers);
+	const footer = combineFooter(answers);
+
+	return [header, body, footer].filter(Boolean).join('\n');
+}