actions/action-conventional-commits
actions/action-conventional-commits
1
0
Fork 0
mirror of https://github.com/webiny/action-conventional-commits.git synced 2024-11-10 12:09:34 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: use regex pattern to valid message

Browse source
This commit is contained in:
Changliang Wu 2023-04-13 11:59:57 +08:00
parent 679da979e4
commit d56babc5d1
No known key found for this signature in database
GPG key ID: 45D7CA7699EDE780
2 changed files with 9 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/__tests__/isValidCommitMessage.test.ts
View file

@ -7,10 +7,14 @@ test("should be able to correctly validate the commit message", () => {
expect(isValidCommitMessage("fix: menu must open on shortcut press")).toBe(true); expect(isValidCommitMessage("fix: menu must open on shortcut press")).toBe(true);
expect(isValidCommitMessage("something: should not work")).toBe(false); expect(isValidCommitMessage("something: should not work")).toBe(false);
expect(isValidCommitMessage("fixes something")).toBe(false); expect(isValidCommitMessage("fixes something")).toBe(false);
expect(isValidCommitMessage("🚧 fix: menu must open on shortcut press")).toBe(true); expect(isValidCommitMessage("🚧 fix: menu must open on shortcut press")).toBe(false);
expect(isValidCommitMessage("fix(menus): menu must open on shortcut press")).toBe(true); expect(isValidCommitMessage("fix(menus): menu must open on shortcut press")).toBe(true);
expect(isValidCommitMessage("🚧 fix(menus): menu must open on shortcut press")).toBe(true); expect(isValidCommitMessage("🚧 fix(menus): menu must open on shortcut press")).toBe(false);
expect(isValidCommitMessage("🚧 fixing something")).toBe(false); expect(isValidCommitMessage("🚧 fixing something")).toBe(false);
expect(isValidCommitMessage("🚧 something: should not work")).toBe(false); expect(isValidCommitMessage("🚧 something: should not work")).toBe(false);
expect(isValidCommitMessage("chorz: 123")).toBe(false); expect(isValidCommitMessage("chorz: 123")).toBe(false);
expect(isValidCommitMessage("(chorz:) 123")).toBe(false);
expect(isValidCommitMessage("fix: test 🐛 with icon")).toBe(true);
expect(isValidCommitMessage("fix: test 🐛 with icon")).toBe(false);
expect(isValidCommitMessage("fix: 🐛 test with icon")).toBe(true);
}); });

36
src/isValidCommitMesage.ts
View file

@ -1,42 +1,12 @@
const DEFAULT_COMMIT_TYPES = [ const isValidCommitMessage = (message): boolean => {
"feat",
"fix",
"docs",
"style",
"refactor",
"test",
"build",
"perf",
"ci",
"chore",
"revert",
"merge",
"wip",
];
const isValidCommitMessage = (message, availableTypes = DEFAULT_COMMIT_TYPES): boolean => {
// Exceptions. // Exceptions.
// This is a message that's auto-generated by git. Can't do much about it unfortunately. Let's allow it. // This is a message that's auto-generated by git. Can't do much about it unfortunately. Let's allow it.
if (message.startsWith("Merge ") || message.startsWith("Revert ")) { if (message.startsWith("Merge ") || message.startsWith("Revert ")) {
return true; return true;
} }
// Commit message doesn't fall into the exceptions group. Let's do the validation. let pattern = /^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.]+\))?(!)?: \S+([\s\S]*)/
let [possiblyValidCommitType] = message.split(":"); return pattern.test(message)
possiblyValidCommitType = possiblyValidCommitType.toLowerCase();
// Let's remove scope if present.
if (possiblyValidCommitType.match(/\(\S*?\)/)) {
possiblyValidCommitType = possiblyValidCommitType.replace(/\(\S*?\)/, "");
}
possiblyValidCommitType = possiblyValidCommitType
.replace(/\s/g, "") // Remove all whitespace
.replace(/\!/g, "") // Remove bang for notify breaking change
.replace(/()/g, "") // Remove all whitespace
.replace(/[^a-z]/g, ""); // Only leave [a-z] characters.
return availableTypes.includes(possiblyValidCommitType);
}; };
export default isValidCommitMessage; export default isValidCommitMessage;