[Add::rules] add breakChangeSymbol rules

Author: z825316969

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

@@ -0,0 +1,25 @@
+import { RuleResolver } from "./typings";
+import { breakChangeSymbol } from "./constants";
+
+const breakChangeSymbolRuleResolver: RuleResolver = (
+  parsed,
+  _when,
+  value = breakChangeSymbol
+) => {
+  const rawCommitMessage = parsed.raw;
+  if (!rawCommitMessage) return [false, "Commit message should not be empty"];
+
+  let isRuleValid = false;
+
+  const findedBreakChangeSymbol: string = rawCommitMessage.split("[")[0];
+
+  // 查找[ 前一项
+  if (!findedBreakChangeSymbol || findedBreakChangeSymbol === value)
+    isRuleValid = true;
+
+  return [
+    isRuleValid,
+    `break change must be symbol with "${value}" e.g: ${value}[Type::scope] subject`,
+  ];
+};
+export default breakChangeSymbolRuleResolver;

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

@@ -0,0 +1,22 @@
+import breakChangeSymbolRuleResolver from "../break-change-symbol-rule-resolver";
+
+describe("breakChangeSymbolRuleResolver", () => {
+  it("should return a error response if breakChangeSymbol is not !", () => {
+    const parsed = {
+      raw: "$[Type::scope] subject",
+    };
+    expect(breakChangeSymbolRuleResolver(parsed)[0]).toEqual(false);
+  });
+  it("should return a success response if no breakChangeSymbol", () => {
+    const parsed = {
+      raw: "[Type::scope] subject",
+    };
+    expect(breakChangeSymbolRuleResolver(parsed)[0]).toEqual(true);
+  });
+  it("should return a success response if breakChangeSymbol is !", () => {
+    const parsed = {
+      raw: "![Type::scope] subject",
+    };
+    expect(breakChangeSymbolRuleResolver(parsed)[0]).toEqual(true);
+  });
+});

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

@@ -0,0 +1,27 @@
+export type RuleResolver = (
+  parsed: Partial<{
+    type: string;
+    scope: string;
+    subject: string;
+    merge: string;
+    header: string;
+    body: string;
+    footer: string;
+    notes: string[];
+    references: string[];
+    mentions: string[];
+    revert: string;
+    raw: string;
+  }>,
+  when?: string,
+  value?: string | number | boolean | (string | number)[]
+) => (string | boolean)[];
+
+export interface CommitlintPlugin {
+  rules: {
+    [key: string]: RuleResolver;
+  };
+}
+declare const commitlintPlugin: CommitlintPlugin;
+
+export default commitlintPlugin;