[WIP] add breakChangeSymbol rule (#2)

* [Add::rules] add breakChangeSymbol rules

* [Feat::rules] docking plugins to the config of commitlint

Co-authored-by: youncccat <1306036576@qq.com>

Author: z825316969

package.json

@@ -12,6 +12,7 @@
   "devDependencies": {
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
+    "@commitlint/types": "^12.1.4",
     "@types/jest": "^26.0.23",
     "jest": "^27.0.1",
     "jest-config": "^27.0.1",

packages/commitlint-config-wizardoc/package.json

@@ -9,5 +9,7 @@
   "devDependencies": {
     "@commitlint/types": "^12.1.4"
   },
-  "dependencies": {}
-}
+  "dependencies": {
+    "commitlint-plugin-wizardoc-rules": "^1.0.0"
+  }
+}

packages/commitlint-config-wizardoc/src/config.ts

@@ -5,6 +5,7 @@ import {
 } from "./constants";
 import { UserConfig } from "@commitlint/types";
 import { enumerateValues } from "./utils/enum";
+import { plugins } from "commitlint-plugin-wizardoc-rules";
 
 export const config: UserConfig = {
   parserPreset: {
@@ -13,19 +14,18 @@ export const config: UserConfig = {
     parserOpts: {
       headerPattern: CONVERSION_MATCH_REGEX,
       headerCorrespondence: [
+        LexicalElement.SYMBOL,
         LexicalElement.TYPE,
         LexicalElement.SCOPE,
         LexicalElement.SUBJECT,
       ],
     },
   },
+  ...plugins,
   rules: {
-    // 'subject-exclamation-mark': [2, 'never'],
+    "break-change-prefix": [2, "always"],
     "footer-leading-blank": [1, "always"],
     "header-max-length": [2, "always", 72],
-    // 'scope-case': [2, 'always', 'lower-case'],
-    "subject-case": [2, "never", ["upper-case"] as any],
-    // 'subject-empty': [2, 'never'],
     "subject-full-stop": [2, "never", "."],
     "type-empty": [2, "never"],
     "scope-empty": [1, "never"],

packages/commitlint-config-wizardoc/src/constants.ts

@@ -3,20 +3,24 @@ export enum LexicalElement {
   TYPE = "type",
   SCOPE = "scope",
   TICKET = "ticket",
+  SYMBOL = "symbol",
 }
 
 export enum CommitType {
   FEAT = "Feat",
   INIT = "Init",
   REMOVE = "Remove",
   DELETE = "Delete",
+  UPDATE = "Update",
+  REFACTOR = "Refactor",
   MOVE = "Move",
   NEW = "New",
   ADD = "Add",
   PATCH = "Patch",
   FIX = "Fix",
   TEST = "Test",
   STUB = "Stub",
+  CHORE = "Chore",
 }
 
-export const CONVERSION_MATCH_REGEX = /^\[(\w+?)(?:\:\:(\w*))?\]\s(.*)$/;
+export const CONVERSION_MATCH_REGEX = /^(.?)\[(\w+?)(?:\:\:(\w*))?\]\s(.*)$/;

packages/commitlint-plugin-wizardoc-rules/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commitlint-plugin-wizardoc-rules",
   "version": "1.0.0",
-  "main": "index.js",
+  "main": "./dist/index.js",
   "license": "MIT"
 }

packages/commitlint-plugin-wizardoc-rules/src/break-change-symbol-rule.ts

@@ -0,0 +1,18 @@
+import { BREAK_CHANGE_SYMBOL } from "./constants";
+import { Commit, Rule, RuleOutcome } from "@commitlint/types";
+
+export type WithSymbol<T> = T & {
+  symbol: string;
+};
+
+export type CommitWithSymbol = WithSymbol<Commit>;
+
+export const breakChangeSymbolRule = (walkData: Commit): RuleOutcome => {
+  const { symbol } = walkData as CommitWithSymbol;
+  const isRuleValid = !symbol || symbol === BREAK_CHANGE_SYMBOL;
+
+  return [
+    isRuleValid,
+    `break change must be symbol with "${BREAK_CHANGE_SYMBOL}" e.g: ${BREAK_CHANGE_SYMBOL}[Type::scope] subject`,
+  ];
+};

packages/commitlint-plugin-wizardoc-rules/src/constants.ts

@@ -0,0 +1 @@
+export const BREAK_CHANGE_SYMBOL = "!";

packages/commitlint-plugin-wizardoc-rules/src/index.ts

@@ -1 +1,12 @@
-export {};
+import { breakChangeSymbolRule } from "./break-change-symbol-rule";
+import { Plugin } from "@commitlint/types";
+
+export const plugins: Record<string, Plugin[]> = {
+  plugins: [
+    {
+      rules: {
+        "break-change-prefix": breakChangeSymbolRule,
+      },
+    },
+  ],
+};

packages/commitlint-plugin-wizardoc-rules/src/tests/break-change-symbol-rule.test.ts

@@ -0,0 +1,27 @@
+import { Commit, RuleOutcome } from "@commitlint/types";
+import { breakChangeSymbolRule, WithSymbol } from "../break-change-symbol-rule";
+import { BREAK_CHANGE_SYMBOL } from "../constants";
+
+const walkData = {
+  symbol: BREAK_CHANGE_SYMBOL,
+} as unknown as WithSymbol<Commit>;
+
+const updateWalkData = (symbol: string) => (walkData.symbol = symbol);
+const getIsValid = ([isValid]: RuleOutcome) => isValid;
+
+describe("breakChangeSymbolRule", () => {
+  it("should return a error response if breakChangeSymbol is not !", () => {
+    updateWalkData("@");
+    expect(getIsValid(breakChangeSymbolRule(walkData))).toEqual(false);
+  });
+
+  it("should return a success response if no breakChangeSymbol", () => {
+    updateWalkData("");
+    expect(getIsValid(breakChangeSymbolRule(walkData))).toEqual(true);
+  });
+
+  it("should return a success response if breakChangeSymbol is !", () => {
+    updateWalkData(BREAK_CHANGE_SYMBOL);
+    expect(getIsValid(breakChangeSymbolRule(walkData))).toEqual(true);
+  });
+});