ci: 🎡 添加交互式提交功能

commitlint.config copy.js

+// @ts-check
+
+/** @type {import("@commitlint/types").UserConfig} */
+export default {
+  ignores: [commit => commit.includes("init")],
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    "body-leading-blank": [2, "always"],
+    "footer-leading-blank": [1, "always"],
+    "header-max-length": [2, "always", 108],
+    "subject-empty": [2, "never"],
+    "type-empty": [2, "never"],
+    "type-enum": [
+      2,
+      "always",
+      [
+        "feat",
+        "fix",
+        "perf",
+        "style",
+        "docs",
+        "test",
+        "refactor",
+        "build",
+        "ci",
+        "chore",
+        "revert",
+        "wip",
+        "workflow",
+        "types",
+        "release"
+      ]
+    ]
+  }
+};

commitlint.config.js

-// @ts-check
-
-/** @type {import("@commitlint/types").UserConfig} */
-export default {
-  ignores: [commit => commit.includes("init")],
+module.exports = {
   extends: ["@commitlint/config-conventional"],
   rules: {
     "body-leading-blank": [2, "always"],
@@ -16,11 +12,11 @@ export default {
       [
         "feat",
         "fix",
-        "perf",
-        "style",
         "docs",
-        "test",
+        "style",
         "refactor",
+        "perf",
+        "test",
         "build",
         "ci",
         "chore",
@@ -31,5 +27,83 @@ export default {
         "release"
       ]
     ]
+  },
+  prompt: {
+    messages: {
+      type: "Select the type of change that you're committing:",
+      scope: "Denote the SCOPE of this change (optional):",
+      customScope: "Denote the SCOPE of this change:",
+      subject: "Write a SHORT, IMPERATIVE tense description of the change:\n",
+      body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+      breaking:
+        'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
+      footerPrefixsSelect:
+        "Select the ISSUES type of changeList by this change (optional):",
+      customFooterPrefixs: "Input ISSUES prefix:",
+      footer: "List any ISSUES by this change. E.g.: #31, #34:\n",
+      confirmCommit: "Are you sure you want to proceed with the commit above?"
+    },
+    types: [
+      { value: "feat", name: "feat:     🚀  A new feature", emoji: "🚀" },
+      { value: "fix", name: "fix:      🧩  A bug fix", emoji: "🧩" },
+      {
+        value: "docs",
+        name: "docs:     📚  Documentation only changes",
+        emoji: "📚"
+      },
+      {
+        value: "style",
+        name: "style:    🎨  Changes that do not affect the meaning of the code",
+        emoji: "🎨"
+      },
+      {
+        value: "refactor",
+        name: "refactor: ♻️   A code change that neither fixes a bug nor adds a feature",
+        emoji: "♻️"
+      },
+      {
+        value: "perf",
+        name: "perf:     ⚡️  A code change that improves performance",
+        emoji: "⚡️"
+      },
+      {
+        value: "test",
+        name: "test:     ✅  Adding missing tests or correcting existing tests",
+        emoji: "✅"
+      },
+      {
+        value: "build",
+        name: "build:    📦️   Changes that affect the build system or external dependencies",
+        emoji: "📦️"
+      },
+      {
+        value: "ci",
+        name: "ci:       🎡  Changes to our CI configuration files and scripts",
+        emoji: "🎡"
+      },
+      {
+        value: "chore",
+        name: "chore:    🔨  Other changes that don't modify src or test files",
+        emoji: "🔨"
+      },
+      {
+        value: "revert",
+        name: "revert:   ⏪️  Reverts a previous commit",
+        emoji: "⏪️"
+      },
+      { value: "wip", name: "wip:      🕔  work in process", emoji: "🕔" },
+      {
+        value: "workflow",
+        name: "workflow: 📋  workflow improvements",
+        emoji: "📋"
+      },
+      {
+        value: "types",
+        name: "types:    🔰  type definition file changes",
+        emoji: "🔰"
+      }
+    ],
+    useEmoji: true,
+    allowBreakingChanges: ["feat", "fix"]
   }
 };

package.json

@@ -20,7 +20,8 @@
     "lint": "pnpm lint:eslint && pnpm lint:prettier && pnpm lint:stylelint",
     "prepare": "husky",
     "preinstall": "npx only-allow pnpm",
-    "plop": "plop --plopfile ./plop-templates/plopfile.cjs"
+    "plop": "plop --plopfile ./plop-templates/plopfile.cjs",
+    "commit": "git-cz"
   },
   "keywords": [
     "vue-pure-admin",
@@ -138,7 +139,9 @@
     "@vitejs/plugin-vue-jsx": "^4.1.2",
     "boxen": "^8.0.1",
     "code-inspector-plugin": "^0.20.7",
+    "commitizen": "^4.3.1",
     "cssnano": "^7.0.6",
+    "cz-git": "^1.11.1",
     "dagre": "^0.8.5",
     "eslint": "^9.24.0",
     "eslint-config-prettier": "^10.1.1",
@@ -205,5 +208,10 @@
       "typeit",
       "vue-demi"
     ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-git"
+    }
   }
 }