Merge pull request #55 from conventional-changelog/master

ammar-ahmed-butt · web-flow · commit a8e8d390016d · 2024-05-30T08:10:14.000+05:00
[pull] master from conventional-changelog:master
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -63,7 +63,6 @@ jobs:
       - name: Install dependencies
         run: |
           apt update --yes
-          apt upgrade --yes
 
           # NOTE: do not change the below with an `actions/setup-node` step! or it
           # would make this CI job entirely pointless
@@ -72,6 +71,9 @@ jobs:
           npm install --global yarn
           yarn install
 
+      - name: Print versions
+        run: node --version && npm --version && yarn --version
+
       - name: Build
         run: yarn build
 
diff --git a/@alias/commitlint-config-nx-scopes/CHANGELOG.md b/@alias/commitlint-config-nx-scopes/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [19.3.1](https://github.com/conventional-changelog/commitlint/compare/v19.3.0...v19.3.1) (2024-05-13)
+
+**Note:** Version bump only for package commitlint-config-nx-scopes
+
+
+
+
+
 # [19.3.0](https://github.com/conventional-changelog/commitlint/compare/v19.2.2...v19.3.0) (2024-04-23)
 
 **Note:** Version bump only for package commitlint-config-nx-scopes
diff --git a/@alias/commitlint-config-nx-scopes/package.json b/@alias/commitlint-config-nx-scopes/package.json
@@ -1,7 +1,7 @@
 {
   "name": "commitlint-config-nx-scopes",
   "type": "module",
-  "version": "19.3.0",
+  "version": "19.3.1",
   "description": "Shareable commitlint config enforcing nx project names as scopes",
   "files": [
     "index.js"
@@ -31,7 +31,7 @@
     "node": ">=v18"
   },
   "dependencies": {
-    "@commitlint/config-nx-scopes": "^19.3.0"
+    "@commitlint/config-nx-scopes": "^19.3.1"
   },
   "devDependencies": {
     "@commitlint/utils": "^19.0.0"
diff --git a/@commitlint/config-nx-scopes/CHANGELOG.md b/@commitlint/config-nx-scopes/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [19.3.1](https://github.com/conventional-changelog/commitlint/compare/v19.3.0...v19.3.1) (2024-05-13)
+
+**Note:** Version bump only for package @commitlint/config-nx-scopes
+
+
+
+
+
 # [19.3.0](https://github.com/conventional-changelog/commitlint/compare/v19.2.2...v19.3.0) (2024-04-23)
 
 **Note:** Version bump only for package @commitlint/config-nx-scopes
diff --git a/@commitlint/config-nx-scopes/package.json b/@commitlint/config-nx-scopes/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@commitlint/config-nx-scopes",
   "type": "module",
-  "version": "19.3.0",
+  "version": "19.3.1",
   "description": "Shareable commitlint config enforcing nx project names as scopes",
   "main": "index.js",
   "files": [
@@ -29,7 +29,7 @@
   },
   "homepage": "https://commitlint.js.org/",
   "peerDependencies": {
-    "nx": "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0"
+    "nx": ">=14.0.0"
   },
   "peerDependenciesMeta": {
     "nx": {
diff --git a/@commitlint/prompt-cli/CHANGELOG.md b/@commitlint/prompt-cli/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [19.3.1](https://github.com/conventional-changelog/commitlint/compare/v19.3.0...v19.3.1) (2024-05-13)
+
+**Note:** Version bump only for package @commitlint/prompt-cli
+
+
+
+
+
 # [19.3.0](https://github.com/conventional-changelog/commitlint/compare/v19.2.2...v19.3.0) (2024-04-23)
 
 **Note:** Version bump only for package @commitlint/prompt-cli
diff --git a/@commitlint/prompt-cli/package.json b/@commitlint/prompt-cli/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@commitlint/prompt-cli",
   "type": "module",
-  "version": "19.3.0",
+  "version": "19.3.1",
   "description": "commit prompt using commitlint.config.js",
   "main": "cli.js",
   "files": [
@@ -38,7 +38,7 @@
     "@commitlint/utils": "^19.0.0"
   },
   "dependencies": {
-    "@commitlint/prompt": "^19.3.0",
+    "@commitlint/prompt": "^19.3.1",
     "execa": "^8.0.1",
     "inquirer": "^9.2.15"
   },
diff --git a/@commitlint/prompt/CHANGELOG.md b/@commitlint/prompt/CHANGELOG.md
@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [19.3.1](https://github.com/conventional-changelog/commitlint/compare/v19.3.0...v19.3.1) (2024-05-13)
+
+
+### Bug Fixes
+
+* **prompt:** prompt does not respect [body-leading-blank] setting ([#4066](https://github.com/conventional-changelog/commitlint/issues/4066)) ([3f1f44d](https://github.com/conventional-changelog/commitlint/commit/3f1f44d9cbb93438d01cfd79f9b71659411e126d))
+
+
+
+
+
 # [19.3.0](https://github.com/conventional-changelog/commitlint/compare/v19.2.2...v19.3.0) (2024-04-23)
 
 **Note:** Version bump only for package @commitlint/prompt
diff --git a/@commitlint/prompt/package.json b/@commitlint/prompt/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@commitlint/prompt",
   "type": "module",
-  "version": "19.3.0",
+  "version": "19.3.1",
   "description": "commitizen prompt using commitlint.config.js",
   "main": "./lib/index.js",
   "files": [
diff --git a/@commitlint/prompt/src/input.test.ts b/@commitlint/prompt/src/input.test.ts
@@ -1,18 +1,46 @@
 /// <reference path="./inquirer/inquirer.d.ts" />
 
-import {test, expect, vi} from 'vitest';
+import {expect, test, vi} from 'vitest';
 // @ts-expect-error -- no typings
 import config from '@commitlint/config-angular';
 import chalk from 'chalk';
-import {Answers, DistinctQuestion, PromptModule} from 'inquirer';
+import {
+	Answers,
+	DistinctQuestion,
+	InputCustomOptions,
+	PromptModule,
+} from 'inquirer';
 
 import {input} from './input.js';
 
+const testConfig = {
+	parserPreset: config.parserPreset,
+	rules: {
+		...config.rules,
+	},
+};
+
 vi.mock('@commitlint/load', () => ({
-	default: () => config,
+	default: () => testConfig,
 }));
 
 test('should work with all fields filled', async () => {
+	const prompt = stub({
+		'input-custom': {
+			type: 'fix',
+			scope: 'test',
+			subject: 'subject',
+			body: 'body',
+			footer: 'footer',
+		},
+	});
+	const message = await input(prompt);
+	expect(message).toEqual('fix(test): subject\n' + '\nbody\n' + '\nfooter');
+});
+
+test('should not add leading blank line to body and footer if rules are disabled', async () => {
+	testConfig.rules['body-leading-blank'] = ['1', 'never'];
+	testConfig.rules['footer-leading-blank'] = ['1', 'never'];
 	const prompt = stub({
 		'input-custom': {
 			type: 'fix',
@@ -24,6 +52,10 @@ test('should work with all fields filled', async () => {
 	});
 	const message = await input(prompt);
 	expect(message).toEqual('fix(test): subject\n' + 'body\n' + 'footer');
+	// reset config mock
+	testConfig.rules['body-leading-blank'] = config.rules['body-leading-blank'];
+	testConfig.rules['footer-leading-blank'] =
+		config.rules['footer-leading-blank'];
 });
 
 test('should work without scope', async () => {
@@ -37,7 +69,7 @@ test('should work without scope', async () => {
 		},
 	});
 	const message = await input(prompt);
-	expect(message).toEqual('fix: subject\n' + 'body\n' + 'footer');
+	expect(message).toEqual('fix: subject\n' + '\nbody\n' + '\nfooter');
 });
 
 test('should fail without type', async () => {
@@ -72,7 +104,7 @@ function stub(config: Record<string, Record<string, unknown>>): PromptModule {
 			if (!questions) {
 				throw new Error(`Unexpected config type: ${configType}`);
 			}
-			const answer = questions[promptConfig.name!];
+			let answer = questions[promptConfig.name!];
 			if (answer == null) {
 				throw new Error(`Unexpected config name: ${promptConfig.name}`);
 			}
@@ -83,7 +115,11 @@ function stub(config: Record<string, Record<string, unknown>>): PromptModule {
 					throw new Error(validationResult || undefined);
 				}
 			}
-
+			const forceLeadingBlankFn = (promptConfig as InputCustomOptions)
+				.forceLeadingBlankFn;
+			if (forceLeadingBlankFn) {
+				answer = forceLeadingBlankFn(answer as string);
+			}
 			result[promptConfig.name!] = answer;
 		}
 		return result;
diff --git a/@commitlint/prompt/src/inquirer/InputCustomPrompt.ts b/@commitlint/prompt/src/inquirer/InputCustomPrompt.ts
@@ -46,6 +46,8 @@ export default class InputCustomPrompt<
 
 	onEnd(state: SuccessfulPromptStateData): void {
 		this.lineSubscription.unsubscribe();
+		// Add or remove leading blank if rule is active.
+		state.value = this.opt.forceLeadingBlankFn(state.value);
 		super.onEnd(state);
 	}
 
diff --git a/@commitlint/prompt/src/inquirer/inquirer.d.ts b/@commitlint/prompt/src/inquirer/inquirer.d.ts
@@ -15,6 +15,7 @@ declare module 'inquirer' {
 		log?(answers?: T): string;
 		tabCompletion?: InputCustomCompletionOption[];
 		maxLength(answers?: T): number;
+		forceLeadingBlankFn(input: string): string;
 	}
 
 	interface QuestionMap<T extends Answers = Answers> {
diff --git a/@commitlint/prompt/src/library/get-prompt.ts b/@commitlint/prompt/src/library/get-prompt.ts
@@ -119,5 +119,6 @@ export default function getPrompt(
 		transformer(value: string) {
 			return forceCaseFn(value);
 		},
+		forceLeadingBlankFn,
 	};
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [19.3.1](https://github.com/conventional-changelog/commitlint/compare/v19.3.0...v19.3.1) (2024-05-13)
+
+
+### Bug Fixes
+
+* **prompt:** prompt does not respect [body-leading-blank] setting ([#4066](https://github.com/conventional-changelog/commitlint/issues/4066)) ([3f1f44d](https://github.com/conventional-changelog/commitlint/commit/3f1f44d9cbb93438d01cfd79f9b71659411e126d))
+* update dependency ajv to v8.13.0 ([#4057](https://github.com/conventional-changelog/commitlint/issues/4057)) ([4e5957f](https://github.com/conventional-changelog/commitlint/commit/4e5957fcb120fbf31c2bdc5c5affe35eb556d3dc))
+* update dependency import-meta-resolve to v4.1.0 ([#4055](https://github.com/conventional-changelog/commitlint/issues/4055)) ([6cd9d76](https://github.com/conventional-changelog/commitlint/commit/6cd9d76b4f7d867c6085a5f99eab9b6ad15ab789))
+* update dependency inquirer to v9.2.20 ([#4047](https://github.com/conventional-changelog/commitlint/issues/4047)) ([b2a75c8](https://github.com/conventional-changelog/commitlint/commit/b2a75c881b8fa69501d93c4d29118aeaf0c989cd))
+* update dependency semver to v7.6.2 ([#4080](https://github.com/conventional-changelog/commitlint/issues/4080)) ([de28f20](https://github.com/conventional-changelog/commitlint/commit/de28f209db4d8aba4eb6e57e9f1fc0517143398d))
+* update dependency tar-fs to v3.0.6 ([#4048](https://github.com/conventional-changelog/commitlint/issues/4048)) ([4003205](https://github.com/conventional-changelog/commitlint/commit/40032050570e4f5a8c8ab4f390cee7611a92935e))
+
+
+### Features
+
+* **container:** add arm64 build ([#4049](https://github.com/conventional-changelog/commitlint/issues/4049)) ([28bed3f](https://github.com/conventional-changelog/commitlint/commit/28bed3f8453bf12062b938aa0247e24d56f183d6)), closes [#3926](https://github.com/conventional-changelog/commitlint/issues/3926)
+
+
+
+
+
 # [19.3.0](https://github.com/conventional-changelog/commitlint/compare/v19.2.2...v19.3.0) (2024-04-23)
 
 
diff --git a/docs/api/lint.md b/docs/api/lint.md
@@ -45,7 +45,7 @@ lint(message: string, rules: {[ruleName: string]: Rule}, opts?: Options) => Prom
 ### Import
 
 ```js
-import lint '@commitlint/lint';
+import lint from '@commitlint/lint';
 ```
 
 ### Usage without config
diff --git a/docs/guides/local-setup.md b/docs/guides/local-setup.md
@@ -20,6 +20,9 @@ You can find complete setup instructions on the [official documentation](https:/
 > The following instructions are meant to `husky@v9` if you are using a different version
 > consult the official documentation of your version.
 
+> [!WARNING]
+> For Windows users: ensure all `husky` files are `UTF-8` enconded. If any other format is used an error may be thrown at runtime such as [cannot execute binary file](https://github.com/typicode/husky/issues/1426).
+
 ---
 
 :::tabs
diff --git a/lerna.json b/lerna.json
@@ -2,5 +2,5 @@
   "lerna": "4",
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "19.3.0"
+  "version": "19.3.1"
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@commitlint/prompt",`
`3`	`3`	`"type": "module",`
`4`		`- "version": "19.3.0",`
	`4`	`+ "version": "19.3.1",`
`5`	`5`	`"description": "commitizen prompt using commitlint.config.js",`
`6`	`6`	`"main": "./lib/index.js",`
`7`	`7`	`"files": [`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,8 @@ export default class InputCustomPrompt<`
`46`	`46`
`47`	`47`	`onEnd(state: SuccessfulPromptStateData): void {`
`48`	`48`	`this.lineSubscription.unsubscribe();`
	`49`	`+ // Add or remove leading blank if rule is active.`
	`50`	`+ state.value = this.opt.forceLeadingBlankFn(state.value);`
`49`	`51`	`super.onEnd(state);`
`50`	`52`	`}`
`51`	`53`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ declare module 'inquirer' {`
`15`	`15`	`log?(answers?: T): string;`
`16`	`16`	`tabCompletion?: InputCustomCompletionOption[];`
`17`	`17`	`maxLength(answers?: T): number;`
	`18`	`+ forceLeadingBlankFn(input: string): string;`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`interface QuestionMap<T extends Answers = Answers> {`
Original file line number	Diff line number	Diff line change
`@@ -119,5 +119,6 @@ export default function getPrompt(`
`119`	`119`	`transformer(value: string) {`
`120`	`120`	`return forceCaseFn(value);`
`121`	`121`	`},`
	`122`	`+ forceLeadingBlankFn,`
`122`	`123`	`};`
`123`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"lerna": "4",`
`3`	`3`	`"npmClient": "yarn",`
`4`	`4`	`"useWorkspaces": true,`
`5`		`- "version": "19.3.0"`
	`5`	`+ "version": "19.3.1"`
`6`	`6`	`}`