@done-coding/cli-config 0.1.11 → 0.1.12

package/README.md

@@ -1,11 +1,222 @@
 # @done-coding/cli-config
 
+工程化配置命令行工具 - 检测和管理项目工程化配置
+
+[![npm version](https://badge.fury.io/js/@done-coding%2Fcli-config.svg)](https://www.npmjs.com/package/@done-coding/cli-config)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## 安装
+
+### 独立安装
+```bash
+npm install @done-coding/cli-config
+# 或
+pnpm add @done-coding/cli-config
 ```
-工程化配置命令行工具
+
+### 作为 done-coding CLI 的一部分
+```bash
+npm install -g @done-coding/cli
+# 然后使用
+DC config [command]
 ```
 
-## 使用
+## 快速开始
 
-``` bash
-npm install @done-coding/cli-config
-```
+```bash
+# 独立使用
+dc-config [command]
+
+# 作为主 CLI 的子命令
+DC config [command]
+
+# 查看帮助
+dc-config --help
+```
+
+## 功能特性
+
+- ✅ **配置检测**: 自动检测项目的工程化配置状态
+- 🔧 **配置添加**: 快速添加常用的工程化配置
+- 🔍 **Git 集成**: 集成 git 包的合并检测功能
+- 📋 **规范检查**: 检查代码规范和项目结构
+- 🚀 **一键配置**: 提供常用工程化工具的快速配置
+
+## API 文档
+
+### 基础命令
+
+#### `dc-config check`
+检测工程化配置
+
+```bash
+# 检测当前项目的工程化配置
+dc-config check
+```
+
+#### `dc-config add`
+添加工程化配置
+
+```bash
+# 添加工程化配置
+dc-config add
+```
+
+## 使用示例
+
+### 基础使用场景
+
+```bash
+# 1. 检测当前项目配置状态
+dc-config check
+
+# 2. 添加工程化配置
+dc-config add
+```
+
+### 作为主 CLI 的一部分
+
+```bash
+# Windows 系统
+dc config check
+dc config add
+
+# macOS/Linux 系统
+DC config check
+DC config add
+```
+
+## 配置
+
+本包支持配置文件，具体的配置选项需要查看包的实际实现。
+
+## 编程接口
+
+本包提供了编程接口，具体的导出内容请查看包的类型定义文件。
+
+## Git 合并检测集成
+
+本包集成了 `@done-coding/cli-git` 包的合并检测功能：
+
+### merge-lint 模块
+
+当执行 `dc-config check` 时，会自动调用 `dc-git check reverse-merge` 命令：
+
+```bash
+# 自动执行的检测流程
+dc-config check
+├── 检测 ESLint 配置
+├── 检测 Prettier 配置  
+├── 检测 TypeScript 配置
+├── 检测 Git 钩子配置
+└── 调用 dc-git check reverse-merge  # 检测反向合并
+```
+
+### 反向合并检测
+
+防止将高级分支合并到低级分支：
+
+- 防止 `main` 分支被合并到 `feature` 分支
+- 防止 `develop` 分支被合并到个人开发分支
+- 确保分支合并方向符合 Git Flow 规范
+
+## 故障排除
+
+### 常见问题
+
+**Q: 配置检测失败**
+```bash
+# 检查项目根目录
+pwd
+
+# 检查是否为 Git 仓库
+git status
+
+# 使用详细模式查看错误
+dc-config check --verbose
+```
+
+**Q: Git 合并检测报错**
+```bash
+# 确保 git 包已安装
+dc-git --version
+
+# 手动执行 git 检测
+dc-git check reverse-merge
+
+# 检查 Git 仓库状态
+git log --oneline -10
+```
+
+**Q: 配置添加失败**
+```bash
+# 检查写入权限
+ls -la .
+
+# 检查 npm/pnpm 可用性
+npm --version
+pnpm --version
+
+# 清理缓存重试
+npm cache clean --force
+```
+
+### 调试模式
+
+```bash
+# 启用详细输出
+dc-config --verbose check
+
+# 启用调试模式
+DEBUG=done-coding:config dc-config check
+```
+
+## 性能建议
+
+- 定期运行配置检测确保项目规范性
+- 使用 Git 钩子自动执行配置检测
+- 团队协作时统一工程化配置标准
+
+## 贡献指南
+
+我们欢迎贡献！请遵循以下步骤：
+
+1. Fork 本仓库
+2. 创建功能分支：`git checkout -b feature/amazing-feature`
+3. 提交更改：`git commit -m "feat: add amazing feature"`
+4. 推送分支：`git push origin feature/amazing-feature`
+5. 创建 Pull Request
+
+### 开发环境设置
+
+```bash
+# 克隆仓库
+git clone https://gitee.com/done-coding/done-coding-cli.git
+cd done-coding-cli/packages/config
+
+# 安装依赖
+pnpm install
+
+# 开发模式
+pnpm dev
+
+# 构建
+pnpm build
+
+# 本地开发测试
+node es/cli.mjs --help
+
+# 注意：本地使用 node + 入口文件，发布后使用 bin 命令名
+# 功能完全一致，只是调用方式不同
+```
+
+## 许可证
+
+MIT © [JustSoSu](https://gitee.com/done-coding)
+
+## 相关链接
+
+- [主 CLI 工具](https://www.npmjs.com/package/@done-coding/cli)
+- [Git 操作工具](https://www.npmjs.com/package/@done-coding/cli-git) - 本包调用的 Git 检测功能
+- [Gitee 仓库](https://gitee.com/done-coding/done-coding-cli)
+- [更新日志](./CHANGELOG.md)

package/es/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { c as m } from "./index-7d957358.js";
+import { c as m } from "./index-6536e597.js";
 import "@done-coding/cli-utils";
 import "node:fs";
 import "node:path";

package/es/{index-7d957358.js → index-6536e597.js}

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import { readConfigFile as B, log as i, getPackageJson as Q, getRelyPkgVersion as X, getConfigFileCommonOptions as Y, readCliModuleAssetsConfig as Z, xPrompts as w, addPackageConfig as ee, addHuskyHooks as te, createSubcommand as J, getRootScriptName as oe, createMainCommand as ne } from "@done-coding/cli-utils";
+import { readConfigFile as B, log as i, getPackageJson as Q, getRelyPkgVersion as X, getConfigFileCommonOptions as Y, readCliModuleAssetsConfig as Z, xPrompts as w, addPackageConfig as ee, addHuskyHooks as te, createSubcommand as J, getRootScriptName as ne, createMainCommand as oe } from "@done-coding/cli-utils";
 import k, { existsSync as C } from "node:fs";
 import g from "node:path";
 import { execSync as N } from "node:child_process";
 var y = /* @__PURE__ */ ((e) => (e.CHECK = "check", e.ADD = "add", e))(y || {}), m = /* @__PURE__ */ ((e) => (e.ESLINT = "eslint", e.PRETTIER = "prettier", e.COMMITLINT = "commitlint", e.LSLINT = "ls-lint", e.MERGELINT = "merge-lint", e))(m || {});
 const L = {
   name: "@done-coding/cli-config",
-  version: "0.1.11",
+  version: "0.1.12",
   description: "工程化配置命令行工具",
   bin: {
     "dc-config": "es/cli.mjs"
@@ -36,59 +36,59 @@ const L = {
   [m.COMMITLINT]: "@commitlint/cli",
   [m.LSLINT]: "@ls-lint/ls-lint",
   [m.MERGELINT]: "@done-coding/cli-git"
-}, o = "_$_", le = {
+}, n = "_$_", le = {
   [m.ESLINT]: [
-    `${o}.config.js`,
-    `${o}.config.mjs`,
-    `${o}.config.cjs`,
-    `.${o}rc`,
-    `.${o}rc.js`,
-    `.${o}rc.json`,
-    `.${o}rc.mjs`,
-    `.${o}rc.cjs`,
-    `.${o}rc.yaml`,
-    `.${o}rc.yml`
+    `${n}.config.js`,
+    `${n}.config.mjs`,
+    `${n}.config.cjs`,
+    `.${n}rc`,
+    `.${n}rc.js`,
+    `.${n}rc.json`,
+    `.${n}rc.mjs`,
+    `.${n}rc.cjs`,
+    `.${n}rc.yaml`,
+    `.${n}rc.yml`
   ],
   [m.PRETTIER]: [
-    `${o}.config.js`,
-    `${o}.config.mjs`,
-    `${o}.config.cjs`,
-    `.${o}rc`,
-    `.${o}rc.js`,
-    `.${o}rc.json`,
-    `.${o}rc.json5`,
-    `.${o}rc.mjs`,
-    `.${o}rc.cjs`,
-    `.${o}rc.yaml`,
-    `.${o}rc.yml`,
-    `.${o}rc.toml`
+    `${n}.config.js`,
+    `${n}.config.mjs`,
+    `${n}.config.cjs`,
+    `.${n}rc`,
+    `.${n}rc.js`,
+    `.${n}rc.json`,
+    `.${n}rc.json5`,
+    `.${n}rc.mjs`,
+    `.${n}rc.cjs`,
+    `.${n}rc.yaml`,
+    `.${n}rc.yml`,
+    `.${n}rc.toml`
   ],
   [m.COMMITLINT]: [
-    `${o}.config.js`,
-    `${o}.config.mjs`,
-    `${o}.config.cjs`,
-    `.${o}rc`,
-    `.${o}rc.js`,
-    `.${o}rc.json`,
-    `.${o}rc.mjs`,
-    `.${o}rc.cjs`,
-    `.${o}rc.yaml`,
-    `.${o}rc.yml`
+    `${n}.config.js`,
+    `${n}.config.mjs`,
+    `${n}.config.cjs`,
+    `.${n}rc`,
+    `.${n}rc.js`,
+    `.${n}rc.json`,
+    `.${n}rc.mjs`,
+    `.${n}rc.cjs`,
+    `.${n}rc.yaml`,
+    `.${n}rc.yml`
   ],
-  [m.LSLINT]: [`.${o}.yaml`, `.${o}.yml`],
+  [m.LSLINT]: [`.${n}.yaml`, `.${n}.yml`],
   [m.MERGELINT]: [".done-coding/git.json"]
-}, me = (e, t) => t.filter((n) => C(g.resolve(e, n))), _ = (e) => e.filter((t) => {
-  const n = I.includes(t);
-  return n || i.warn(
+}, me = (e, t) => t.filter((o) => C(g.resolve(e, o))), _ = (e) => e.filter((t) => {
+  const o = I.includes(t);
+  return o || i.warn(
     `当前不支持${t}的配置检测, 支持的类型有${I.join(
       ", "
     )}`
-  ), n;
+  ), o;
 }), de = ({
   config: e,
   rootDir: t
 }) => {
-  const { moduleList: n = [] } = e, s = _(n);
+  const { moduleList: o = [] } = e, s = _(o);
   i.stage(`开始获取${s.join(", ")}配置信息...`);
   const r = Q({ rootDir: t });
   return s.reduce(
@@ -101,7 +101,7 @@ const L = {
       });
       if (!f)
         return a;
-      const c = le[l].map((u) => u.replace(o, l));
+      const c = le[l].map((u) => u.replace(n, l));
       return c.length ? (a[l] = {
         version: f,
         configFileRelativePathList: me(
@@ -126,11 +126,11 @@ const L = {
     )
   }
 }), E = async (e) => {
-  const t = await ae(e), n = de({ config: t, rootDir: e.rootDir });
+  const t = await ae(e), o = de({ config: t, rootDir: e.rootDir });
   return i.success(`检测到工程化配置信息: 
-${JSON.stringify(n, null, 2)}`), {
+${JSON.stringify(o, null, 2)}`), {
     config: t,
-    info: n
+    info: o
   };
 }, ue = {
   command: y.CHECK,
@@ -161,7 +161,7 @@ ${JSON.stringify(n, null, 2)}`), {
       `${e} 跳过版本选择: 仅有一个预设版本配置, 默认选择第一个(${s.version})`
     ), s;
   }
-  const { version: n } = await w({
+  const { version: o } = await w({
     type: "select",
     name: "version",
     message: `请选择需要添加的${e}版本`,
@@ -173,18 +173,18 @@ ${JSON.stringify(n, null, 2)}`), {
       };
     })
   });
-  return t.find((s) => s.version === n);
+  return t.find((s) => s.version === o);
 }, pe = async ({
   moduleName: e,
   moduleConfig: t
 }) => {
-  const { configFileInfoList: n } = t;
-  if (!Array.isArray(n) || n.length === 0) {
+  const { configFileInfoList: o } = t;
+  if (!Array.isArray(o) || o.length === 0) {
     i.error(`未找到 ${e} 配置文件信息列表`);
     return;
   }
-  if (n.length === 1) {
-    const r = n[0];
+  if (o.length === 1) {
+    const r = o[0];
     return i.skip(
       `${e} 跳过配置文件信息选择: 仅有一个配置文件信息, 默认选择第一个(${r.sourceFile})`
     ), r;
@@ -193,7 +193,7 @@ ${JSON.stringify(n, null, 2)}`), {
     type: "select",
     name: "info",
     message: "请选择需要添加的配置文件",
-    choices: n.map((r) => {
+    choices: o.map((r) => {
       const { sourceFile: a, description: l } = r;
       return {
         title: a,
@@ -202,10 +202,10 @@ ${JSON.stringify(n, null, 2)}`), {
       };
     })
   });
-  return n.find((r) => r.sourceFile === s.sourceFile);
+  return o.find((r) => r.sourceFile === s.sourceFile);
 }, ye = ({ rootDir: e, list: t }) => {
   i.stage(`开始安装依赖包: ${JSON.stringify(t, null, 2)}`);
-  const n = g.resolve(e, "pnpm-workspace.yaml"), s = C(n);
+  const o = g.resolve(e, "pnpm-workspace.yaml"), s = C(o);
   N(`pnpm add -D ${s ? "-w" : ""} ${t.join(" ")}`, {
     cwd: e,
     stdio: "inherit"
@@ -213,16 +213,16 @@ ${JSON.stringify(n, null, 2)}`), {
 }, Le = async ({
   hooksConfig: e,
   argv: t
-}) => Object.entries(e).forEach(async ([n, s]) => {
+}) => Object.entries(e).forEach(async ([o, s]) => {
   await te({
-    hookNames: [n],
+    hookNames: [o],
     rootDir: t.rootDir,
     getCode: () => s
   });
 }), he = async ({
   moduleName: e,
   moduleConfigList: t,
-  argv: n
+  argv: o
 }) => {
   const s = await $e({
     moduleName: e,
@@ -252,7 +252,7 @@ ${JSON.stringify(n, null, 2)}`), {
   return i.stage(`需要安装的依赖包: 
 ${JSON.stringify($, null, 2)}`), await ee({
     patchConfig: s.packageJson,
-    rootDir: n.rootDir
+    rootDir: o.rootDir
   }), {
     sourceFile: u,
     targetFile: j,
@@ -264,21 +264,20 @@ ${JSON.stringify($, null, 2)}`), await ee({
       var p;
       return Le({
         hooksConfig: ((p = s.husky) == null ? void 0 : p.hooks) || {},
-        argv: n
+        argv: o
       });
     }
   };
 }, ke = ({
   listConfig: e,
   moduleDir: t,
-  moduleName: n
+  moduleName: o
 }) => {
   if (typeof e == "string") {
-    console.log(e);
     const s = g.resolve(t, e);
     if (!C(s))
       throw new Error(
-        `${n} 预设列表文件 ${s} 不存在`
+        `${o} 预设列表文件 ${s} 不存在`
       );
     const r = k.readFileSync(s, "utf-8");
     return JSON.parse(
@@ -287,13 +286,13 @@ ${JSON.stringify($, null, 2)}`), await ee({
   } else {
     if (!Array.isArray(e))
       throw new Error(
-        `(${n})预置项必须是数组或者是相对于当前工程化配置模块目录的相对路径`
+        `(${o})预置项必须是数组或者是相对于当前工程化配置模块目录的相对路径`
       );
     return e;
   }
 }, b = async (e) => {
-  const { config: t, info: n } = await E(e), { moduleList: s = [] } = t, a = _(s).filter((c) => {
-    const u = n[c];
+  const { config: t, info: o } = await E(e), { moduleList: s = [] } = t, a = _(s).filter((c) => {
+    const u = o[c];
     return u ? (i.skip(`
 检测到 ${c} 已配置, ${JSON.stringify(u, null, 2)},
 跳过添加 ${c}`), !1) : !0;
@@ -389,13 +388,13 @@ ${JSON.stringify($, null, 2)}`), await ee({
   version: Ie,
   subcommands: [ue, Ne].map(J),
   demandCommandCount: 1,
-  rootScriptName: oe({ packageJson: L })
+  rootScriptName: ne({ packageJson: L })
 }, {
   cliConfig: { moduleName: O }
 } = L, x = (e = !1) => {
-  const t = e ? O : void 0, n = `$0${e ? ` ${O}` : ""} <command> [options]`;
-  return { command: t, usage: n };
-}, Pe = async () => ne({
+  const t = e ? O : void 0, o = `$0${e ? ` ${O}` : ""} <command> [options]`;
+  return { command: t, usage: o };
+}, Pe = async () => oe({
   ...G,
   ...x()
 }), Te = () => J({

package/es/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { C as i, S as s, a as t, h as u } from "./index-7d957358.js";
+import { C as i, S as s, a as t, h as u } from "./index-6536e597.js";
 import "@done-coding/cli-utils";
 import "node:fs";
 import "node:path";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-config",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "工程化配置命令行工具",
   "private": false,
   "module": "es/index.mjs",
@@ -41,7 +41,7 @@
   "license": "MIT",
   "sideEffects": false,
   "devDependencies": {
-    "@done-coding/cli-inject": "0.5.19",
+    "@done-coding/cli-inject": "0.5.20",
     "@types/node": "^18.0.0",
     "@types/yargs": "^17.0.28",
     "rimraf": "^6.0.1",
@@ -53,7 +53,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@done-coding/cli-utils": "0.8.0"
+    "@done-coding/cli-utils": "0.8.1"
   },
-  "gitHead": "e68f726aa899f75c4d294b11620f343c953a74c3"
+  "gitHead": "0930f800167c04a86b56eae9741872dd51bec0c6"
 }