Merge branch 'master' into feat/validate-configs

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/load/package.json

@@ -37,7 +37,8 @@
     "@commitlint/test": "^12.0.0",
     "@commitlint/utils": "^12.0.0",
     "@types/lodash": "4.14.168",
-    "execa": "^5.0.0"
+    "execa": "^5.0.0",
+    "conventional-changelog-atom": "^2.0.8"
   },
   "dependencies": {
     "@commitlint/execute-rule": "^12.0.0",

@commitlint/load/src/load.test.ts

@@ -7,7 +7,6 @@ jest.mock('@scope/commitlint-plugin-example', () => scopedPlugin, {
 });
 
 import path from 'path';
-import execa from 'execa';
 import resolveFrom from 'resolve-from';
 import {fix, git, npm} from '@commitlint/test';
 
@@ -417,10 +416,9 @@ test('recursive resolves parser preset from conventional atom', async () => {
 	const cwd = await gitBootstrap(
 		'fixtures/recursive-parser-preset-conventional-atom'
 	);
-	// the package file is nested in 2 folders, `npm.bootstrap` cant do that
-	await execa('npm', ['install'], {
-		cwd: path.resolve(cwd, 'first-extended', 'second-extended'),
-	});
+	await npm.installModules(
+		path.resolve(cwd, 'first-extended', 'second-extended')
+	);
 
 	const actual = await load({}, {cwd});
 
@@ -430,7 +428,7 @@ test('recursive resolves parser preset from conventional atom', async () => {
 	expect((actual.parserPreset!.parserOpts as any).headerPattern).toEqual(
 		/^(:.*?:) (.*)$/
 	);
-}, 10000);
+});
 
 test('resolves parser preset from conventional commits without factory support', async () => {
 	const cwd = await npmBootstrap(

@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/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;
 	};
 }
 

@packages/test/src/npm.ts

@@ -4,8 +4,7 @@ import resolvePkg from 'resolve-pkg';
 
 import * as git from './git';
 
-export async function bootstrap(fixture: string, directory?: string) {
-	const cwd = await git.bootstrap(fixture, directory);
+export async function installModules(cwd: string) {
 	const manifestPath = path.join(cwd, 'package.json');
 	const targetModulesPath = path.join(cwd, 'node_modules');
 
@@ -36,7 +35,11 @@ export async function bootstrap(fixture: string, directory?: string) {
 			})
 		);
 	}
+}
 
+export async function bootstrap(fixture: string, directory?: string) {
+	const cwd = await git.bootstrap(fixture, directory);
+	await installModules(cwd);
 	return cwd;
 }
 

docs/reference-configuration.md

@@ -8,39 +8,57 @@ The file is expected
 - export a configuration object
 - adhere to the schema outlined below
 
-```ts
-type Config = {
+## Configuration object example
+
+### JavaScript
+
+```js
+const Configuration = {
   /*
-   * Resolveable ids to commitlint configurations to extend
+   * Resolve and load @commitlint/config-conventional from node_modules.
+   * Referenced packages must be installed
    */
-  extends?: string[];
+  extends: ['@commitlint/config-conventional'],
   /*
-   * Resolveable id to conventional-changelog parser preset to import and use
+   * Resolve and load conventional-changelog-atom from node_modules.
+   * Referenced packages must be installed
    */
-  parserPreset?: string;
+  parserPreset: 'conventional-changelog-atom',
   /*
-   * Resolveable id to package, from node_modules, which formats the output.
+   * Resolve and load @commitlint/format from node_modules.
+   * Referenced package must be installed
    */
-  formatter: string;
+  formatter: '@commitlint/format',
   /*
-   * Rules to check against
+   * Any rules defined here will override rules from @commitlint/config-conventional
    */
-  rules?: {[name: string]: Rule};
+  rules: {
+    'type-enum': [2, 'always', ['foo']],
+  },
   /*
    * Functions that return true if commitlint should ignore the given message.
    */
-  ignores?: ((message: string) => boolean)[];
+  ignores: [(commit) => commit === ''],
   /*
    * Whether commitlint uses the default ignore rules.
    */
-  defaultIgnores?: boolean;
+  defaultIgnores: true,
   /*
    * Custom URL to show upon failure
    */
-  helpUrl?: string;
+  helpUrl:
+    'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',
 };
 
-const Configuration: Config = {
+module.exports = Configuration;
+```
+
+### TypeScript
+
+```ts
+import type {UserConfig} from '@commitlint/types';
+
+const Configuration: UserConfig = {
   /*
    * Resolve and load @commitlint/config-conventional from node_modules.
    * Referenced packages must be installed

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**