Merge branch 'master' into refactor/prompt2

Author: armano2

@commitlint/config-patternplate/README.md

@@ -19,7 +19,7 @@ Additionally these rules apply:
 
 ### Problems
 
-The following rules are considered problems for `@commitlint/config-patterplate` and will yield a non-zero exit code when not met.
+The following rules are considered problems for `@commitlint/config-patternplate` and will yield a non-zero exit code when not met.
 
 #### scope-enum
 

@commitlint/format/src/format.ts

@@ -66,7 +66,7 @@ export function formatResult(
 	const problems = [...errors, ...warnings].map((problem) => {
 		const sign = signs[problem.level] || '';
 		const color: ChalkColor = colors[problem.level] || ('white' as const);
-		const decoration = enabled ? ((chalk as any)[color] as any)(sign) : sign;
+		const decoration = enabled ? chalk[color](sign) : sign;
 		const name = enabled
 			? chalk.grey(`[${problem.name}]`)
 			: `[${problem.name}]`;
@@ -76,7 +76,7 @@ export function formatResult(
 	const sign = selectSign(result);
 	const color = selectColor(result);
 
-	const deco = enabled ? (chalk[color] as any)(sign) : sign;
+	const deco = enabled ? chalk[color](sign) : sign;
 	const el = errors.length;
 	const wl = warnings.length;
 	const hasProblems = problems.length > 0;
@@ -109,7 +109,7 @@ function selectSign(result: FormattableResult): string {
 	return (result.warnings || []).length ? '⚠' : '✔';
 }
 
-function selectColor(result: FormattableResult): keyof typeof chalk {
+function selectColor(result: FormattableResult): ChalkColor {
 	if ((result.errors || []).length > 0) {
 		return 'red';
 	}

@commitlint/load/src/utils/load-plugin.test.ts

@@ -1,4 +1,5 @@
 import loadPlugin from './load-plugin';
+import {AsyncRule, Plugin, Rule, SyncRule} from '@commitlint/types';
 
 jest.mock('commitlint-plugin-example', () => ({example: true}), {
 	virtual: true,
@@ -8,6 +9,39 @@ jest.mock('@scope/commitlint-plugin-example', () => ({scope: true}), {
 	virtual: true,
 });
 
+jest.mock(
+	'commitlint-plugin-rule',
+	(): Plugin => {
+		const rule: Rule<number> = (_parsed, when, _value) => {
+			return [when === 'never'];
+		};
+		return {rules: {rule}};
+	},
+	{virtual: true}
+);
+
+jest.mock(
+	'commitlint-plugin-sync-rule',
+	(): Plugin => {
+		const syncRule: SyncRule<number> = (_parsed, when, _value) => {
+			return [when === 'never'];
+		};
+		return {rules: {syncRule}};
+	},
+	{virtual: true}
+);
+
+jest.mock(
+	'commitlint-plugin-async-rule',
+	(): Plugin => {
+		const asyncRule: AsyncRule<number> = (_parsed, when, _value) => {
+			return new Promise(() => [when === 'never']);
+		};
+		return {rules: {asyncRule}};
+	},
+	{virtual: true}
+);
+
 test('should load a plugin when referenced by short name', () => {
 	const plugins = loadPlugin({}, 'example');
 	expect(plugins['example']).toBe(require('commitlint-plugin-example'));
@@ -18,6 +52,21 @@ test('should load a plugin when referenced by long name', () => {
 	expect(plugins['example']).toBe(require('commitlint-plugin-example'));
 });
 
+test('should load a plugin with a rule', () => {
+	const plugins = loadPlugin({}, 'commitlint-plugin-rule');
+	expect(plugins['rule']).toBe(require('commitlint-plugin-rule'));
+});
+
+test('should load a plugin with a sync rule', () => {
+	const plugins = loadPlugin({}, 'commitlint-plugin-sync-rule');
+	expect(plugins['sync-rule']).toBe(require('commitlint-plugin-sync-rule'));
+});
+
+test('should load a plugin with an async rule', () => {
+	const plugins = loadPlugin({}, 'commitlint-plugin-async-rule');
+	expect(plugins['async-rule']).toBe(require('commitlint-plugin-async-rule'));
+});
+
 test('should throw an error when a plugin has whitespace', () => {
 	expect(() => loadPlugin({}, 'whitespace ')).toThrow(
 		"Whitespace found in plugin name 'whitespace '"

@commitlint/rules/src/index.test.ts

@@ -1,4 +1,5 @@
 import path from 'path';
+import fs from 'fs';
 import globby from 'globby';
 import rules from '.';
 
@@ -13,6 +14,19 @@ test('rules export functions', () => {
 	expect(actual.every((rule) => typeof rule === 'function')).toBe(true);
 });
 
+test('all rules are present in documentation', () => {
+	const file = fs.readFileSync(
+		path.join(__dirname, '../../../docs/reference-rules.md'),
+		'utf-8'
+	);
+	const results = file
+		.split(/(\n|\r)/)
+		.filter((s) => s.startsWith('####') && !s.includes('`deprecated`'))
+		.map((s) => s.replace('#### ', ''));
+
+	expect(Object.keys(rules)).toEqual(expect.arrayContaining(results));
+});
+
 async function glob(pattern: string | string[]) {
 	const files = await globby(pattern, {
 		ignore: ['**/index.ts', '**/*.test.ts'],

@commitlint/types/src/format.ts

@@ -26,7 +26,7 @@ export interface FormattableReport {
 	results?: (FormattableResult & WithInput)[];
 }
 
-export type ChalkColor = keyof typeof chalk;
+export type ChalkColor = typeof chalk.Color | typeof chalk.Modifiers;
 
 export interface FormatOptions {
 	color?: boolean;

@commitlint/types/src/load.ts

@@ -1,10 +1,16 @@
-import {Rule, RulesConfig, RuleConfigQuality} from './rules';
+import {
+	Rule,
+	RulesConfig,
+	RuleConfigQuality,
+	AsyncRule,
+	SyncRule,
+} from './rules';
 
 export type PluginRecords = Record<string, Plugin>;
 
 export interface Plugin {
 	rules: {
-		[ruleName: string]: Rule<unknown>;
+		[ruleName: string]: Rule | AsyncRule | SyncRule;
 	};
 }
 

README.md

@@ -60,7 +60,7 @@ fix(server): send cors headers
 feat(blog): add comment section
 ```
 
-Common types according to [commitlint-config-conventional (based on the the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum) can be:
+Common types according to [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum) can be:
 
 - build
 - ci

docs/reference-rules.md

@@ -57,6 +57,11 @@ Rule configurations are either of type `array` residing on a key with the rule's
 - **condition**: `body` begins with blank line
 - **rule**: `always`
 
+#### body-empty
+
+- **condition**: `body` is empty
+- **rule**: `never`
+
 #### body-max-length
 
 - **condition**: `body` has `value` or less characters
@@ -87,11 +92,41 @@ Infinity
 0
 ```
 
+#### body-case
+
+- **condition**: `header` is in case `value`
+- **rule**: `always`
+- **value**
+
+```
+'lower-case'
+```
+
+- **possible values**
+
+```
+[
+  'lower-case', // default
+  'upper-case', // UPPERCASE
+  'camel-case', // camelCase
+  'kebab-case', // kebab-case
+  'pascal-case', // PascalCase
+  'sentence-case', // Sentence case
+  'snake-case', // snake_case
+  'start-case' // Start Case
+]
+```
+
 #### footer-leading-blank
 
 - **condition**: `footer` begins with blank line
 - **rule**: `always`
 
+#### footer-empty
+
+- **condition**: `footer` is empty
+- **rule**: `never`
+
 #### footer-max-length
 
 - **condition**: `footer` has `value` or less characters
@@ -129,7 +164,7 @@ Infinity
 - **value**
 
 ```
-'lowerCase'
+'lower-case'
 ```
 
 - **possible values**
@@ -198,7 +233,7 @@ Infinity
 - **value**
 
 ```
-'lowerCase'
+'lower-case'
 ```
 
 - **possible values**
@@ -248,7 +283,7 @@ Infinity
 - **value**
 
 ```
-'lowerCase'
+'lower-case'
 ```
 
 - **possible values**

package.json

@@ -81,7 +81,7 @@
     "@babel/preset-env": "^7.12.11",
     "@lerna/project": "3.21.0",
     "@types/jest": "26.0.20",
-    "@types/node": "12.19.14",
+    "@types/node": "12.19.15",
     "@typescript-eslint/eslint-plugin": "^4.1.0",
     "@typescript-eslint/parser": "^4.1.0",
     "docsify-cli": "^4.4.0",