conventional-changelog · May 16, 2022 · May 17, 2022 · May 17, 2022 · May 18, 2022 · May 18, 2022
diff --git a/@alias/commitlint-config-angular/CHANGELOG.md b/@alias/commitlint-config-angular/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.
 
+## [17.0.3](https://github.com/conventional-changelog/commitlint/compare/v17.0.2...v17.0.3) (2022-06-25)
+
+**Note:** Version bump only for package commitlint-config-angular
+
+
+
+
+
 # [17.0.0](https://github.com/conventional-changelog/commitlint/compare/v16.3.0...v17.0.0) (2022-05-16)
 
 

diff --git a/@alias/commitlint-config-angular/package.json b/@alias/commitlint-config-angular/package.json
@@ -1,6 +1,6 @@
 {
   "name": "commitlint-config-angular",
-  "version": "17.0.0",
+  "version": "17.0.3",
   "description": "Shareable commitlint config enforcing the angular commit convention",
   "files": [
     "index.js"
@@ -30,7 +30,7 @@
     "node": ">=v14"
   },
   "dependencies": {
-    "@commitlint/config-angular": "^17.0.0"
+    "@commitlint/config-angular": "^17.0.3"
   },
   "devDependencies": {
     "@commitlint/utils": "^17.0.0"

diff --git a/@alias/commitlint-config-lerna-scopes/CHANGELOG.md b/@alias/commitlint-config-lerna-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.
 
+## [17.0.2](https://github.com/conventional-changelog/commitlint/compare/v17.0.1...v17.0.2) (2022-06-01)
+
+**Note:** Version bump only for package commitlint-config-lerna-scopes
+
+
+
+
+
 # [17.0.0](https://github.com/conventional-changelog/commitlint/compare/v16.3.0...v17.0.0) (2022-05-16)
 
 

diff --git a/@alias/commitlint-config-lerna-scopes/package.json b/@alias/commitlint-config-lerna-scopes/package.json
@@ -1,6 +1,6 @@
 {
   "name": "commitlint-config-lerna-scopes",
-  "version": "17.0.0",
+  "version": "17.0.2",
   "description": "Shareable commitlint config enforcing lerna package names as scopes",
   "files": [
     "index.js"
@@ -30,7 +30,7 @@
     "node": ">=v14"
   },
   "dependencies": {
-    "@commitlint/config-lerna-scopes": "^17.0.0"
+    "@commitlint/config-lerna-scopes": "^17.0.2"
   },
   "devDependencies": {
     "@commitlint/utils": "^17.0.0"

diff --git a/@alias/commitlint-config-patternplate/CHANGELOG.md b/@alias/commitlint-config-patternplate/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.
 
+## [17.0.3](https://github.com/conventional-changelog/commitlint/compare/v17.0.2...v17.0.3) (2022-06-25)
+
+**Note:** Version bump only for package commitlint-config-patternplate
+
+
+
+
+
 # [17.0.0](https://github.com/conventional-changelog/commitlint/compare/v16.3.0...v17.0.0) (2022-05-16)
 
 

diff --git a/@alias/commitlint-config-patternplate/package.json b/@alias/commitlint-config-patternplate/package.json
@@ -1,6 +1,6 @@
 {
   "name": "commitlint-config-patternplate",
-  "version": "17.0.0",
+  "version": "17.0.3",
   "description": "Lint your commits, patternplate-style",
   "files": [
     "index.js"
@@ -30,7 +30,7 @@
     "node": ">=v14"
   },
   "dependencies": {
-    "@commitlint/config-patternplate": "^17.0.0"
+    "@commitlint/config-patternplate": "^17.0.3"
   },
   "devDependencies": {
     "@commitlint/utils": "^17.0.0"

diff --git a/@alias/commitlint/CHANGELOG.md b/@alias/commitlint/CHANGELOG.md
@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.0.3](https://github.com/conventional-changelog/commitlint/compare/v17.0.2...v17.0.3) (2022-06-25)
+
+**Note:** Version bump only for package commitlint
+
+
+
+
+
+## [17.0.2](https://github.com/conventional-changelog/commitlint/compare/v17.0.1...v17.0.2) (2022-06-01)
+
+**Note:** Version bump only for package commitlint
+
+
+
+
+
+## [17.0.1](https://github.com/conventional-changelog/commitlint/compare/v17.0.0...v17.0.1) (2022-05-25)
+
+**Note:** Version bump only for package commitlint
+
+
+
+
+
 # [17.0.0](https://github.com/conventional-changelog/commitlint/compare/v16.3.0...v17.0.0) (2022-05-16)
 
 

diff --git a/@alias/commitlint/package.json b/@alias/commitlint/package.json
@@ -1,6 +1,6 @@
 {
   "name": "commitlint",
-  "version": "17.0.0",
+  "version": "17.0.3",
   "description": "Lint your commit messages",
   "files": [
     "cli.js"
@@ -35,7 +35,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@commitlint/cli": "^17.0.0",
+    "@commitlint/cli": "^17.0.3",
     "@commitlint/types": "^17.0.0"
   },
   "devDependencies": {

diff --git a/@commitlint/cli/CHANGELOG.md b/@commitlint/cli/CHANGELOG.md
@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.0.3](https://github.com/conventional-changelog/commitlint/compare/v17.0.2...v17.0.3) (2022-06-25)
+
+**Note:** Version bump only for package @commitlint/cli
+
+
+
+
+
+## [17.0.2](https://github.com/conventional-changelog/commitlint/compare/v17.0.1...v17.0.2) (2022-06-01)
+
+**Note:** Version bump only for package @commitlint/cli
+
+
+
+
+
+## [17.0.1](https://github.com/conventional-changelog/commitlint/compare/v17.0.0...v17.0.1) (2022-05-25)
+
+
+### Bug Fixes
+
+* **cli:** use `core.commentChar` from git config with `--edit` flag ([#3191](https://github.com/conventional-changelog/commitlint/issues/3191)) ([e5fee05](https://github.com/conventional-changelog/commitlint/commit/e5fee05301ab7441b6091e4ee6fc095d26bbd589)), closes [#3190](https://github.com/conventional-changelog/commitlint/issues/3190) [#3190](https://github.com/conventional-changelog/commitlint/issues/3190) [#3190](https://github.com/conventional-changelog/commitlint/issues/3190)
+
+
+
+
+
 # [17.0.0](https://github.com/conventional-changelog/commitlint/compare/v16.3.0...v17.0.0) (2022-05-16)
 
 

diff --git a/@commitlint/cli/fixtures/comment-char/commitlint.config.js b/@commitlint/cli/fixtures/comment-char/commitlint.config.js
@@ -1,6 +1,6 @@
 module.exports = {
 	rules: {
-		'subject-empty': [2, 'never']
+		'body-empty': [2, 'never']
 	},
 	parserPreset: {
         parserOpts: {

diff --git a/@commitlint/cli/package.json b/@commitlint/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@commitlint/cli",
-  "version": "17.0.0",
+  "version": "17.0.3",
   "description": "Lint your commit messages",
   "files": [
     "index.js",
@@ -39,17 +39,17 @@
   "devDependencies": {
     "@commitlint/test": "^17.0.0",
     "@commitlint/utils": "^17.0.0",
-    "@types/node": "12.20.52",
+    "@types/node": "12.20.55",
     "@types/yargs": "^17.0.0",
-    "execa": "^5.0.0",
     "fs-extra": "^10.0.0"
   },
   "dependencies": {
     "@commitlint/format": "^17.0.0",
-    "@commitlint/lint": "^17.0.0",
-    "@commitlint/load": "^17.0.0",
+    "@commitlint/lint": "^17.0.3",
+    "@commitlint/load": "^17.0.3",
     "@commitlint/read": "^17.0.0",
     "@commitlint/types": "^17.0.0",
+    "execa": "^5.0.0",
     "lodash": "^4.17.19",
     "resolve-from": "5.0.0",
     "resolve-global": "1.0.0",

diff --git a/@commitlint/cli/src/cli.test.ts b/@commitlint/cli/src/cli.test.ts
@@ -329,13 +329,50 @@ test('should handle --amend with signoff', async () => {
 	expect(commit).toBeTruthy();
 }, 10000);
 
-test('should fail with an empty message and a commentChar is set', async () => {
+test('it uses parserOpts.commentChar when not using edit mode', async () => {
+	const cwd = await gitBootstrap('fixtures/comment-char');
+	const input = 'header: foo\n$body\n';
+
+	const actual = await cli([], {cwd})(input);
+	expect(actual.stdout).toContain('[body-empty]');
+	expect(actual.exitCode).toBe(1);
+});
+
+test("it doesn't use parserOpts.commentChar when using edit mode", async () => {
+	const cwd = await gitBootstrap('fixtures/comment-char');
+	await fs.writeFile(
+		path.join(cwd, '.git', 'COMMIT_EDITMSG'),
+		'header: foo\n\n$body\n'
+	);
+
+	const actual = await cli(['--edit', '.git/COMMIT_EDITMSG'], {cwd})();
+	expect(actual.stdout).not.toContain('[body-empty]');
+	expect(actual.exitCode).toBe(0);
+});
+
+test('it uses core.commentChar git config when using edit mode', async () => {
 	const cwd = await gitBootstrap('fixtures/comment-char');
 	await execa('git', ['config', '--local', 'core.commentChar', '$'], {cwd});
-	await fs.writeFile(path.join(cwd, '.git', 'COMMIT_EDITMSG'), '#1234');
+	await fs.writeFile(
+		path.join(cwd, '.git', 'COMMIT_EDITMSG'),
+		'header: foo\n\n$body\n'
+	);
+
+	const actual = await cli(['--edit', '.git/COMMIT_EDITMSG'], {cwd})();
+	expect(actual.stdout).toContain('[body-empty]');
+	expect(actual.exitCode).toBe(1);
+});
+
+test('it falls back to # for core.commentChar when using edit mode', async () => {
+	const cwd = await gitBootstrap('fixtures/comment-char');
+	await fs.writeFile(
+		path.join(cwd, '.git', 'COMMIT_EDITMSG'),
+		'header: foo\n\n#body\n'
+	);
 
 	const actual = await cli(['--edit', '.git/COMMIT_EDITMSG'], {cwd})();
-	expect(actual.stdout).toContain('[subject-empty]');
+	expect(actual.stdout).toContain('[body-empty]');
+	expect(actual.stderr).toEqual('');
 	expect(actual.exitCode).toBe(1);
 });
 

diff --git a/@commitlint/cli/src/cli.ts b/@commitlint/cli/src/cli.ts
@@ -1,3 +1,4 @@
+import execa, {ExecaError} from 'execa';
 import load from '@commitlint/load';
 import lint from '@commitlint/lint';
 import read from '@commitlint/read';
@@ -21,6 +22,8 @@ import {CliError} from './cli-error';
 
 const pkg = require('../package');
 
+const gitDefaultCommentChar = '#';
+
 const cli = yargs
 	.options({
 		color: {
@@ -221,11 +224,24 @@ async function main(args: MainArgs) {
 	}
 	const format = loadFormatter(loaded, flags);
 
-	// Strip comments if reading from `.git/COMMIT_EDIT_MSG` using the
-	// commentChar from the parser preset falling back to a `#` if that is not
-	// set
-	if (flags.edit && typeof opts.parserOpts.commentChar !== 'string') {
-		opts.parserOpts.commentChar = '#';
+	// If reading from `.git/COMMIT_EDIT_MSG`, strip comments using
+	// core.commentChar from git configuration, falling back to '#'.
+	if (flags.edit) {
+		try {
+			const {stdout} = await execa('git', ['config', 'core.commentChar']);
+			opts.parserOpts.commentChar = stdout.trim() || gitDefaultCommentChar;
+		} catch (e) {
+			const execaError = e as ExecaError;
+			// git config returns exit code 1 when the setting is unset,
+			// don't warn in this case.
+			if (!execaError.failed || execaError.exitCode !== 1) {
+				console.warn(
+					'Could not determine core.commentChar git configuration',
+					e
+				);
+			}
+			opts.parserOpts.commentChar = gitDefaultCommentChar;
+		}
 	}
 
 	const results = await Promise.all(

diff --git a/@commitlint/config-angular/CHANGELOG.md b/@commitlint/config-angular/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.
 
+## [17.0.3](https://github.com/conventional-changelog/commitlint/compare/v17.0.2...v17.0.3) (2022-06-25)
+
+**Note:** Version bump only for package @commitlint/config-angular
+
+
+
+
+
 # [17.0.0](https://github.com/conventional-changelog/commitlint/compare/v16.3.0...v17.0.0) (2022-05-16)
 
 

diff --git a/@commitlint/config-angular/package.json b/@commitlint/config-angular/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@commitlint/config-angular",
-  "version": "17.0.0",
+  "version": "17.0.3",
   "description": "Shareable commitlint config enforcing the angular commit convention",
   "files": [
     "index.js"
@@ -30,7 +30,7 @@
     "node": ">=v14"
   },
   "devDependencies": {
-    "@commitlint/lint": "^17.0.0",
+    "@commitlint/lint": "^17.0.3",
     "@commitlint/utils": "^17.0.0"
   },
   "dependencies": {

diff --git a/@commitlint/config-conventional/CHANGELOG.md b/@commitlint/config-conventional/CHANGELOG.md
@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.0.3](https://github.com/conventional-changelog/commitlint/compare/v17.0.2...v17.0.3) (2022-06-25)
+
+**Note:** Version bump only for package @commitlint/config-conventional
+
+
+
+
+
+## [17.0.2](https://github.com/conventional-changelog/commitlint/compare/v17.0.1...v17.0.2) (2022-06-01)
+
+
+### Bug Fixes
+
+* update dependency conventional-changelog-conventionalcommits to v5 ([#3201](https://github.com/conventional-changelog/commitlint/issues/3201)) ([c20fd19](https://github.com/conventional-changelog/commitlint/commit/c20fd1952ed02df987165d96e4cef650c7fbaa4b))
+
+
+
+
+
 # [17.0.0](https://github.com/conventional-changelog/commitlint/compare/v16.3.0...v17.0.0) (2022-05-16)
 
 

diff --git a/@commitlint/config-conventional/package.json b/@commitlint/config-conventional/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@commitlint/config-conventional",
-  "version": "17.0.0",
+  "version": "17.0.3",
   "description": "Shareable commitlint config enforcing conventional commits",
   "files": [
     "index.js"
@@ -33,11 +33,11 @@
     "node": ">=v14"
   },
   "devDependencies": {
-    "@commitlint/lint": "^17.0.0",
+    "@commitlint/lint": "^17.0.3",
     "@commitlint/utils": "^17.0.0"
   },
   "dependencies": {
-    "conventional-changelog-conventionalcommits": "^4.3.1"
+    "conventional-changelog-conventionalcommits": "^5.0.0"
   },
   "gitHead": "70f7f4688b51774e7ac5e40e896cdaa3f132b2bc"
 }