feat(banned phrases): add banned-phrases rule

Author: Alan Agius

README.md

@@ -25,6 +25,7 @@ The majority of the rules can be applied in any part of the configuration.
 |--------------------|------------------------------------------------------------------|----------|---------|
 | `no-unscoped`      | Disallows unscoped commit messages                               | boolean  | Message |
 | `valid-types`      | An array of allowed commit message types ex: `["feat", "chore"]` | string[] | Type    |
+| `banned-phrases`   | An array of disallowed phrases. (Case insensitive)               | string[] | All     |
 | `max-length`       | Requires text to be under a certain max length                   | number   | All     |
 | `no-dash`          | Disallows dashes                                                 | boolean  | All     |
 | `no-space`         | Disallows spaces                                                 | boolean  | All     |
@@ -49,7 +50,15 @@ If the file is not found it will fallback to an internal `speedy-commit-msg.json
 {
   "rules": {
     "message": {
-      "max-length": 75
+      "max-length": 75,
+      "banned-phrases": [
+        "minor change",
+        "minor fix",
+        "minor refactor",
+        "pr change",
+        "pr comment",
+        "following pr"
+      ]
     },
     "type": {
       "valid-types": [

config/speedy-commit-msg.json

@@ -1,7 +1,15 @@
 {
 	"rules": {
 		"message": {
-			"max-length": 75
+			"max-length": 75,
+			"banned-phrases": [
+				"minor change",
+				"minor fix",
+				"minor refactor",
+				"pr change",
+				"pr comment",
+				"following pr"
+			]
 		},
 		"type": {
 			"valid-types": [

src/rules/rules.spec.ts

@@ -5,6 +5,17 @@ describe("rulesSpec", () => {
 	const MESSAGE_PART: CommitMessagePart = "Type";
 	const COMMIT_MSG = "style(all): formatting";
 
+	describe(Rules.bannedPhrases.name, () => {
+		const bannedPhrases =  ["pr change"];
+		it("should fail when commit contain banned phrases", () => {
+			expect(Rules.bannedPhrases("chore(all): PR changes", MESSAGE_PART, bannedPhrases).failed).toBe(true);
+		});
+
+		it("should not fail when commit doesn't contain banned phrases", () => {
+			expect(Rules.bannedPhrases(COMMIT_MSG, MESSAGE_PART, bannedPhrases).failed).toBe(false);
+		});
+	});
+
 	describe(Rules.noUnscoped.name, () => {
 		it("should fail when commit message is not scope", () => {
 			expect(Rules.noUnscoped("unscoped message").failed).toBe(true);

src/rules/rules.ts

@@ -6,6 +6,13 @@ export namespace Rules {
 
 	export const SCOPED_COMMIT_REGEXP = /[a-z]+[\s]?\(.+\):/;
 
+	export function bannedPhrases(text: string, part: CommitMessagePart, bannedPhrases: string[]): RulesResult {
+		return {
+			failed: new RegExp(`(${bannedPhrases.join("|")})`, "ig").test(text),
+			message: `Commit '${part}' is not valid. You are using a 'Banned Phrase'. Banned phrases are: ${bannedPhrases.join(", ")}.`
+		};
+	}
+
 	export function noUnscoped(text: string): RulesResult {
 		return {
 			failed: !SCOPED_COMMIT_REGEXP.test(text),