Skip to content

fix: footer parser does not escape special chars for regex #4560 #4634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
escapedcat merged 2 commits into from
Mar 3, 2026
+358 −223
Merged

fix: footer parser does not escape special chars for regex #4560 #4634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e312f08
test(parse): add regression test for noteKeywords with regex-special …
escapedcat Mar 3, 2026
46be149
fix: add @types/conventional-commits-parser to resolve TS7016
escapedcat Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions @commitlint/cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"devDependencies": {
"@commitlint/test": "^20.4.0",
"@commitlint/utils": "^20.0.0",
"@types/conventional-commits-parser": "^5.0.2",
"@types/lodash.mergewith": "^4.6.8",
"@types/node": "^18.19.17",
"@types/yargs": "^17.0.29",
Expand Down
2 changes: 1 addition & 1 deletion @commitlint/config-conventional/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
},
"dependencies": {
"@commitlint/types": "^20.4.0",
"conventional-changelog-conventionalcommits": "^9.1.0"
"conventional-changelog-conventionalcommits": "^9.2.0"
},
"gitHead": "e82f05a737626bb69979d14564f5ff601997f679"
}
2 changes: 1 addition & 1 deletion @commitlint/load/fixtures/parser-preset-conventional-without-factory/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"name": "parser-preset-conventional-without-factory",
"version": "1.0.0",
"devDependencies": {
"conventional-changelog-conventionalcommits": "^9.1.0"
"conventional-changelog-conventionalcommits": "^9.2.0"
}
}
2 changes: 1 addition & 1 deletion @commitlint/load/fixtures/parser-preset-conventionalcommits/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"name": "parser-preset-conventionalcommits",
"version": "1.0.0",
"devDependencies": {
"conventional-changelog-conventionalcommits": "^9.1.0"
"conventional-changelog-conventionalcommits": "^9.2.0"
}
}
2 changes: 1 addition & 1 deletion @commitlint/load/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"@commitlint/execute-rule": "^20.0.0",
"@commitlint/resolve-extends": "^20.4.0",
"@commitlint/types": "^20.4.0",
"cosmiconfig": "^9.0.0",
"cosmiconfig": "^9.0.1",
"cosmiconfig-typescript-loader": "^6.1.0",
"is-plain-obj": "^4.1.0",
"lodash.mergewith": "^4.6.2",
Expand Down
7 changes: 4 additions & 3 deletions @commitlint/parse/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,13 @@
"license": "MIT",
"devDependencies": {
"@commitlint/test": "^20.4.0",
"@commitlint/utils": "^20.0.0"
"@commitlint/utils": "^20.0.0",
"@types/conventional-commits-parser": "^5.0.2"
},
"dependencies": {
"@commitlint/types": "^20.4.0",
"conventional-changelog-angular": "^8.1.0",
"conventional-commits-parser": "^6.2.1"
"conventional-changelog-angular": "^8.2.0",
"conventional-commits-parser": "^6.3.0"
},
"gitHead": "e82f05a737626bb69979d14564f5ff601997f679"
}
12 changes: 12 additions & 0 deletions @commitlint/parse/src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,3 +303,15 @@ test("does not work with chinese scopes with incompatible pattern", async () =>
expect(actual.subject).toBe(null);
expect(actual.scope).toBe(null);
});

test("parses footer with noteKeywords containing regex-special characters", async () => {
const message = "feat: add feature\n\nBody text\n[1] Custom note footer";

const actual = await parse(message, undefined, {
noteKeywords: ["[1]", "Notes:"],
});

// [1] should be recognized as a note keyword (not regex)
expect(actual.notes).toHaveLength(1);
expect(actual.notes[0].title).toBe("[1]");
});
5 changes: 3 additions & 2 deletions @commitlint/rules/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@
"@commitlint/parse": "^20.4.1",
"@commitlint/test": "^20.4.0",
"@commitlint/utils": "^20.0.0",
"conventional-changelog-angular": "^8.1.0",
"conventional-commits-parser": "^6.2.1",
"@types/conventional-commits-parser": "^5.0.2",
"conventional-changelog-angular": "^8.2.0",
"conventional-commits-parser": "^6.3.0",
"glob": "^11.0.0"
},
"dependencies": {
Expand Down
5 changes: 3 additions & 2 deletions @commitlint/types/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@
},
"license": "MIT",
"dependencies": {
"conventional-commits-parser": "^6.2.1",
"conventional-commits-parser": "^6.3.0",
"picocolors": "^1.1.1"
},
"devDependencies": {
"@commitlint/utils": "^20.0.0"
"@commitlint/utils": "^20.0.0",
"@types/conventional-commits-parser": "^5.0.2"
},
"gitHead": "e82f05a737626bb69979d14564f5ff601997f679"
}
12 changes: 6 additions & 6 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,15 @@
"email": "hello@herebecode.com"
},
"devDependencies": {
"@eslint/eslintrc": "^3.1.0",
"@eslint/eslintrc": "^3.3.4",
"@eslint/js": "^10.0.1",
"@swc/core": "^1.10.1",
"@typescript-eslint/eslint-plugin": "^8.18.0",
"@typescript-eslint/parser": "^8.18.0",
"@swc/core": "^1.15.18",
"@typescript-eslint/eslint-plugin": "^8.56.1",
"@typescript-eslint/parser": "^8.56.1",
"@vitest/coverage-istanbul": "^4.0.18",
"@vitest/eslint-plugin": "^1.3.4",
"cross-env": "^7.0.3",
"eslint": "^10.0.0",
"eslint": "^10.0.2",
"eslint-config-prettier": "^10.0.0",
"eslint-import-resolver-typescript": "^4.4.3",
"eslint-plugin-import-x": "^4.15.2",
Expand All @@ -103,6 +103,6 @@
"vitepress": "^1.3.4",
"vitepress-plugin-tabs": "^0.7.0",
"vitest": "^4.0.18",
"vue": "^3.5.0"
"vue": "^3.5.29"
}
}
Loading