standards-cli 1.0.3 → 1.0.6

package/README.md

@@ -107,7 +107,7 @@ standards init [选项]
 ```json
 {
   "scripts": {
-    "prepare": "husky install",
+    "prepare": "husky",
     "cz": "cz",
     "commit": "cz"
   },
@@ -115,6 +115,11 @@ standards init [选项]
     "commitizen": {
       "path": "cz-git"
     }
+  },
+  "pnpm": {
+    "overrides": {
+      "string-width": "^7.0.0"
+    }
   }
 }
 ```
@@ -132,7 +137,23 @@ standards init [选项]
 
 初始化完成后，可以使用以下两种方式提交：
 
-### 方式一：交互式提交（推荐）
+### 方式一：符合规范格式的直接提交（推荐）
+
+```bash
+git commit -m "feat(login): 完成登录相关功能"
+git commit -m "fix(user): 修复用户信息更新bug"
+```
+
+**格式要求：** `type(scope): subject`
+
+- `type`: 提交类型（feat/fix/docs 等）
+- `scope`: 模块名称（必填，如 login、user、api 等）
+- `subject`: 简短描述
+
+✅ **只要符合格式，就能正常提交**  
+❌ **不符合格式会被 commit-msg hook 拦截**
+
+### 方式二：交互式提交
 
 ```bash
 pnpm commit
@@ -142,24 +163,24 @@ pnpm cz
 
 使用交互式界面选择提交类型、填写描述等，自动生成符合规范的提交信息。
 
-**交互流程：**
+## 团队成员使用流程
 
-1. 选择提交类型（feat/fix/docs/...）
-2. **填写 scope（对应代码模块）** - 必填，手动输入如 `auth`
-3. 填写简短描述（subject）- 必填
-4. 确认提交
-
-**最终提交信息格式：** `feat (auth): add login feature`
-
-### 方式二：直接提交
+团队成员克隆项目后，只需执行：
 
 ```bash
-git commit -m "feat: add new feature"
+# 1. 安装依赖（会自动执行 prepare 脚本，初始化 Git hooks）
+pnpm install
+
+# 2. 之后正常提交即可（符合规范就能提交，不符合会被拦截）
+git commit -m "feat(login): 完成登录相关功能"
 ```
 
-直接使用符合规范的提交信息格式提交，commit-msg hook 会自动验证。
+**说明：**
 
-**注意：** 无论使用哪种方式，commit-msg hook 都会拦截不符合规范的提交信息。
+- `pnpm install` 会自动触发 `prepare` 脚本
+- `prepare` 脚本执行 `husky`，自动配置 Git hooks
+- 配置完成后，每次 commit 都会自动检查提交信息格式
+- **无需额外操作**，开箱即用
 
 ## lint-staged 智能配置
 
@@ -219,24 +240,24 @@ CLI 会自动检测项目是否已安装 `eslint` 和 `prettier`，并生成对
 **示例：**
 
 ```bash
-# 正确
-git commit -m "feat (auth): add login"
-git commit -m "fix (api): resolve login bug"
-git commit -m "docs: update README"
-
-# 错误（会被拦截）
-git commit -m "add login"
-git commit -m "fix bug"
-git commit -m "update"
-git commit -m "feat: add login"  # 缺少 scope
+# ✅ 正确格式（能提交）
+git commit -m "feat(login): 完成登录相关功能"
+git commit -m "fix(api): 修复接口超时问题"
+git commit -m "docs(readme): 更新文档"
+
+# ❌ 错误格式（会被拦截）
+git commit -m "add login"           # 缺少 type 和 scope
+git commit -m "feat: add login"     # 缺少 scope
+git commit -m "update"              # 格式不符合
 ```
 
 ## 注意事项
 
-1. **eslint/prettier 依赖**：本 CLI 不安装 eslint 和 prettier，请根据项目需要自行安装
-2. **lint-staged 配置**：CLI 会自动检测并生成合适的配置
-3. **Node 版本**：需要 Node.js >= 18
-4. **提交方式**：`git commit` 和 `pnpm commit` 都会被 commit-msg hook 拦截验证
+1. **团队成员使用**：只需 `pnpm install`，会自动初始化 Git hooks
+2. **提交方式**：`git commit -m "feat(scope): message"` 只要符合格式就能提交
+3. **eslint/prettier 依赖**：本 CLI 不安装 eslint 和 prettier，请根据项目需要自行安装
+4. **lint-staged 配置**：CLI 会自动检测并生成合适的配置
+5. **Node 版本**：需要 Node.js >= 18
 
 ## 开发
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "standards-cli",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "description": "一键初始化前端项目提交规范链路（cz-git + commitlint + husky + lint-staged）",
   "type": "module",
   "bin": {
@@ -14,7 +14,10 @@
     "templates"
   ],
   "scripts": {
-    "test": "node src/index.js init"
+    "test": "node src/index.js init",
+    "prepare": "husky || exit 0",
+    "cz": "cz",
+    "commit": "cz"
   },
   "keywords": [
     "commitlint",
@@ -38,5 +41,23 @@
   },
   "engines": {
     "node": ">=18"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-git"
+    }
+  },
+  "pnpm": {
+    "overrides": {
+      "string-width": "^7.0.0"
+    }
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.3.1",
+    "@commitlint/config-conventional": "^20.3.1",
+    "commitizen": "^4.3.1",
+    "cz-git": "^1.12.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7"
   }
 }

package/src/commands/init.js

@@ -1,5 +1,8 @@
 import readline from "node:readline/promises";
 import { stdin as input, stdout as output } from "process";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
 import {
   exists,
   readJson,
@@ -18,6 +21,9 @@ import {
 } from "../lib/pm.js";
 import { execLive } from "../lib/exec.js";
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
 const rl = readline.createInterface({ input, output });
 
 /**
@@ -113,10 +119,24 @@ function hasLintTools(pkg) {
 async function generateConfigFiles(pkg) {
   console.log("\n📝 生成配置文件...");
 
+  // 读取模板文件
+  const commitlintConfig = readFileSync(
+    join(__dirname, "../../templates/commitlint/config.cjs"),
+    "utf-8"
+  );
+  const lintstagedConfigFull = readFileSync(
+    join(__dirname, "../../templates/lint-staged/config.cjs"),
+    "utf-8"
+  );
+  const lintstagedConfigSimple = readFileSync(
+    join(__dirname, "../../templates/lint-staged/config-simple.cjs"),
+    "utf-8"
+  );
+
   // commitlint.config.cjs
   const commitlintCreated = await writeFileIfMissing(
     "commitlint.config.cjs",
-    `module.exports = require('standards-cli/templates/commitlint/config.cjs');\n`
+    commitlintConfig
   );
   if (commitlintCreated) {
     console.log("  ✔ commitlint.config.cjs");
@@ -124,25 +144,14 @@ async function generateConfigFiles(pkg) {
     console.log("  ⚠ commitlint.config.cjs (已存在，跳过)");
   }
 
-  // cz.config.cjs
-  const czConfigCreated = await writeFileIfMissing(
-    "cz.config.cjs",
-    `module.exports = require('standards-cli/templates/commitlint/cz.config.cjs');\n`
-  );
-  if (czConfigCreated) {
-    console.log("  ✔ cz.config.cjs");
-  } else {
-    console.log("  ⚠ cz.config.cjs (已存在，跳过)");
-  }
-
   // .lintstagedrc.cjs - 根据是否有 eslint/prettier 选择模板
   const hasLintToolsInstalled = hasLintTools(pkg);
-  const lintstagedTemplate = hasLintToolsInstalled
-    ? "require('standards-cli/templates/lint-staged/config.cjs')"
-    : "require('standards-cli/templates/lint-staged/config-simple.cjs')";
+  const lintstagedContent = hasLintToolsInstalled
+    ? lintstagedConfigFull
+    : lintstagedConfigSimple;
   const lintstagedrcCreated = await writeFileIfMissing(
     ".lintstagedrc.cjs",
-    `module.exports = ${lintstagedTemplate};\n`
+    lintstagedContent
   );
   if (lintstagedrcCreated) {
     console.log("  ✔ .lintstagedrc.cjs");
@@ -155,7 +164,6 @@ async function generateConfigFiles(pkg) {
 
   // .husky/pre-commit
   const preCommitContent = `#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
 npx --no-install lint-staged
 `;
   await writeFile(".husky/pre-commit", preCommitContent);
@@ -164,7 +172,6 @@ npx --no-install lint-staged
 
   // .husky/commit-msg
   const commitMsgContent = `#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
 npx --no-install commitlint --edit "$1"
 `;
   await writeFile(".husky/commit-msg", commitMsgContent);
@@ -189,8 +196,12 @@ async function updatePackageJson() {
 
   // 添加 prepare（如果不存在）
   if (!pkg.scripts.prepare) {
-    pkg.scripts.prepare = "husky install";
-    console.log('  ✔ 添加 scripts.prepare = "husky install"');
+    pkg.scripts.prepare = "husky";
+    console.log('  ✔ 添加 scripts.prepare = "husky"');
+    modified = true;
+  } else if (pkg.scripts.prepare === "husky install" || pkg.scripts.prepare === "husky init") {
+    pkg.scripts.prepare = "husky";
+    console.log('  ✔ 更新 scripts.prepare = "husky"');
     modified = true;
   } else {
     console.log("  ⚠ scripts.prepare (已存在，跳过)");
@@ -231,6 +242,23 @@ async function updatePackageJson() {
     console.log("  ⚠ config.commitizen.path (已存在，跳过)");
   }
 
+  // 添加 pnpm overrides 来降级 string-width（兼容 Node.js 18）
+  if (!pkg.pnpm) {
+    pkg.pnpm = {};
+  }
+  if (!pkg.pnpm.overrides) {
+    pkg.pnpm.overrides = {};
+  }
+  if (pkg.pnpm.overrides["string-width"] !== "^7.0.0") {
+    pkg.pnpm.overrides["string-width"] = "^7.0.0";
+    console.log(
+      '  ✔ 添加 pnpm.overrides.string-width = "^7.0.0" (兼容 Node.js 18)'
+    );
+    modified = true;
+  } else {
+    console.log("  ⚠ pnpm.overrides.string-width (已存在，跳过)");
+  }
+
   if (modified) {
     await writeJson("package.json", pkg);
   }
@@ -264,17 +292,19 @@ async function installDependencies(pm, missingDeps) {
 }
 
 /**
- * 执行 husky install
+ * 执行 husky init
  */
 async function runHuskyInstall(pm) {
   console.log("\n🔧 初始化 husky...");
-  const command = getExecCommand(pm, "husky install");
-  console.log(`  执行: ${command}`);
-  const code = await execLive(command);
-  if (code !== 0) {
-    throw new Error(`husky install 失败，退出码: ${code}`);
+  
+  // 设置 Git hooks 路径为 .husky
+  const gitConfigCmd = "git config core.hooksPath .husky";
+  console.log(`  执行: ${gitConfigCmd}`);
+  const gitCode = await execLive(gitConfigCmd);
+  if (gitCode !== 0) {
+    throw new Error(`设置 Git hooks 路径失败，退出码: ${gitCode}`);
   }
-  console.log("  ✔ husky 初始化成功");
+  console.log("  ✔ Git hooks 路径已设置为 .husky");
 }
 
 /**
@@ -305,7 +335,7 @@ function printInstallCommand(missingDeps, defaultPm) {
     const marker = pm === defaultPm ? " [推荐]" : "";
     console.log(`  ${command}${marker}`);
   }
-  console.log("\n安装后请执行: husky install\n");
+  console.log("\n安装后请运行 prepare 脚本来初始化 hooks（npm install 会自动执行）\n");
 }
 
 /**

package/templates/commitlint/config.cjs

@@ -1,25 +1,37 @@
-
 module.exports = {
   extends: ["@commitlint/config-conventional"],
   rules: {
-    "type-enum": [
-      2,
-      "always",
-      [
-        "feat", // 新功能
-        "fix", // 修复 bug
-        "docs", // 文档更新
-        "style", // 代码格式调整（不影响功能）
-        "refactor", // 重构
-        "perf", // 性能优化
-        "test", // 测试相关
-        "build", // 构建系统或外部依赖变动
-        "ci", // CI 配置变动
-        "chore", // 其他杂项
-        "revert", // 回滚提交
-      ],
-    ],
+    "scope-enum": [0],
+    "type-enum": [2, "always", ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"]],
+    "scope-empty": [2, "never"],
     "subject-empty": [2, "never"],
     "subject-max-length": [2, "always", 72],
   },
+  prompt: {
+    messages: {
+      type: "选择你要提交的类型:",
+      scope: "填写 scope (必填，如: auth, login, user):",
+      subject: "填写简短描述 (必填，最多 72 字符):",
+      confirmCommit: "确认提交?",
+    },
+    types: [
+      { value: "feat", name: "feat:     新功能" },
+      { value: "fix", name: "fix:      修复 bug" },
+      { value: "docs", name: "docs:     文档更新" },
+      { value: "style", name: "style:    代码格式调整" },
+      { value: "refactor", name: "refactor: 重构" },
+      { value: "perf", name: "perf:     性能优化" },
+      { value: "test", name: "test:     测试相关" },
+      { value: "build", name: "build:    构建系统或外部依赖变动" },
+      { value: "ci", name: "ci:       CI 配置变动" },
+      { value: "chore", name: "chore:    其他杂项" },
+      { value: "revert", name: "revert:   回滚提交" },
+    ],
+    useEmoji: false,
+    scopes: [],
+    enableMultipleScopes: false,
+    scopeEnumSeparator: ",",
+    allowCustomScopes: true,
+    allowEmptyScopes: false,
+  },
 };

package/templates/husky/commit-msg.sh

@@ -1,12 +1,4 @@
 #!/bin/sh
-###
- # @Author: ChenYu ycyplus@gmail.com
- # @Date: 2026-01-11 22:50:56
- # @LastEditors: ChenYu ycyplus@gmail.com
- # @LastEditTime: 2026-01-11 22:50:58
- # @FilePath: \frontend-standards\templates\husky\commit-msg.sh
- # @Description: 
- # Copyright (c) 2026 by CHENY, All Rights Reserved 😎. 
-### 
+
 . "$(dirname "$0")/_/husky.sh"
 npx --no-install commitlint --edit "$1"

package/templates/husky/pre-commit.sh

@@ -1,12 +1,3 @@
 #!/bin/sh
-###
- # @Author: ChenYu ycyplus@gmail.com
- # @Date: 2026-01-11 22:50:49
- # @LastEditors: ChenYu ycyplus@gmail.com
- # @LastEditTime: 2026-01-11 22:50:52
- # @FilePath: \frontend-standards\templates\husky\pre-commit.sh
- # @Description: 
- # Copyright (c) 2026 by CHENY, All Rights Reserved 😎. 
-### 
 . "$(dirname "$0")/_/husky.sh"
 npx --no-install lint-staged

package/templates/lint-staged/config.cjs

@@ -1,12 +1,5 @@
-/*
- * @Author: ChenYu ycyplus@gmail.com
- * @Date: 2026-01-11 22:50:42
- * @LastEditors: ChenYu ycyplus@gmail.com
- * @LastEditTime: 2026-01-11 22:50:45
- * @FilePath: \frontend-standards\templates\lint-staged\config.cjs
- * @Description:
- * Copyright (c) 2026 by CHENY, All Rights Reserved 😎.
- */
+
+
 module.exports = {
   "*.{js,jsx,ts,tsx,vue}": ["eslint --fix"],
   "*.{js,jsx,ts,tsx,vue,css,scss,less,md,json,yml,yaml}": ["prettier --write"],

package/templates/commitlint/cz.config.cjs

@@ -1,45 +0,0 @@
-module.exports = {
-  types: [
-    { value: "feat", name: "feat:     新功能 (feature)" },
-    { value: "fix", name: "fix:      修复 bug (fix)" },
-    { value: "docs", name: "docs:     文档更新 (documentation)" },
-    { value: "style", name: "style:    代码格式调整（不影响功能）(style)" },
-    { value: "refactor", name: "refactor: 重构 (refactor)" },
-    { value: "perf", name: "perf:     性能优化 (performance)" },
-    { value: "test", name: "test:     测试相关 (test)" },
-    { value: "build", name: "build:    构建系统或外部依赖变动 (build)" },
-    { value: "ci", name: "ci:       CI 配置变动 (ci)" },
-    { value: "chore", name: "chore:    其他杂项 (chore)" },
-    { value: "revert", name: "revert:   回滚提交 (revert)" },
-  ],
-
-  // 交互提示信息
-  messages: {
-    type: "选择你要提交的类型:",
-    scope: "填写 scope (对应代码模块):",
-    customScope: "请输入自定义 scope:",
-    subject: "填写简短描述 (必填):",
-    confirmCommit: "确认提交?",
-  },
-
-  // 是否允许自定义 scope
-  allowCustomScopes: true,
-
-  // 是否允许空 scope（false 表示必须填写）
-  allowEmptyScopes: false,
-
-  // scope 是否从枚举列表选择（false 表示手动输入）
-  scopeEnum: false,
-
-  // 是否允许自定义 type
-  allowCustomTypes: false,
-
-  // 是否允许空 subject
-  allowEmptySubject: false,
-
-  // subject 最大长度
-  subjectMaxLength: 72,
-
-  // 是否允许 breaking 变更
-  allowBreakingChanges: ["feat", "fix"],
-};