done-coding-extract 0.1.19 → 0.1.22

package/README.md

@@ -1,11 +1,239 @@
 # @done-coding/cli-extract
 
+信息提取命令行工具 - 从项目中提取和生成各种信息文件
+
+[![npm version](https://badge.fury.io/js/@done-coding%2Fcli-extract.svg)](https://www.npmjs.com/package/@done-coding/cli-extract)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## 安装
+
+### 独立安装
+```bash
+npm install @done-coding/cli-extract
+# 或
+pnpm add @done-coding/cli-extract
 ```
-信息提取命令行工具
+
+### 作为 done-coding CLI 的一部分
+```bash
+npm install -g @done-coding/cli
+# 然后使用
+DC extract [command]
 ```
 
-## 使用
+## 快速开始
 
-``` bash
-npm install @done-coding/cli-extract
-```
+```bash
+# 独立使用
+dc-extract [command]
+
+# 作为主 CLI 的子命令
+DC extract [command]
+
+# 查看帮助
+dc-extract --help
+```
+
+## 功能特性
+
+- ✅ **信息提取**: 从项目源码中提取各种信息
+- 📄 **文件生成**: 基于提取的信息生成文档或配置文件
+- 🔧 **模板支持**: 支持自定义模板进行信息格式化
+- ⚙️ **配置灵活**: 支持多种配置方式和生成模式
+- 🚀 **批量处理**: 支持批量提取和生成操作
+
+## API 文档
+
+### 基础命令
+
+#### `dc-extract init`
+初始化配置文件
+
+```bash
+# 创建默认配置文件
+dc-extract init
+```
+
+**功能说明**:
+- 在项目根目录创建 `.done-coding/extract.json5` 配置文件
+- 提供默认的提取规则和模板配置
+- 支持自定义提取目标和输出格式
+
+#### `dc-extract` (默认命令)
+生成文件
+
+```bash
+# 使用默认配置生成文件
+dc-extract
+
+# 指定配置文件路径
+dc-extract -C ./custom-config.json5
+
+# 指定生成模式
+dc-extract -m template
+
+# 指定运行目录
+dc-extract -R ./src
+```
+
+**选项说明**:
+- `-R, --rootDir`: 运行目录，默认为当前目录
+- `-C, --configPath`: 配置文件相对路径，默认为 `./.done-coding/extract.json5`
+- `-m, --mode`: 生成模式，可选值：`result`（默认）、`template`
+
+### 生成模式
+
+#### result 模式
+直接生成最终结果文件
+
+```bash
+# 生成结果文件
+dc-extract -m result
+```
+
+#### template 模式
+生成模板文件供进一步处理
+
+```bash
+# 生成模板文件
+dc-extract -m template
+```
+
+## 使用示例
+
+### 基础使用场景
+
+```bash
+# 1. 初始化配置
+dc-extract init
+
+# 2. 编辑配置文件（可选）
+# 编辑 .done-coding/extract.json5
+
+# 3. 执行信息提取和文件生成
+dc-extract
+
+# 4. 检查生成的文件
+ls -la output/
+```
+
+### 自定义配置使用
+
+```bash
+# 使用自定义配置文件
+dc-extract -C ./configs/my-extract.json5
+
+# 指定不同的运行目录
+dc-extract -R ./packages/core
+
+# 生成模板文件而非最终结果
+dc-extract -m template
+```
+
+### 作为主 CLI 的一部分
+
+```bash
+# Windows 系统
+dc extract init
+dc extract -m result
+dc extract -C ./config.json5
+
+# macOS/Linux 系统
+DC extract init
+DC extract -m result
+DC extract -C ./config.json5
+```
+
+## 配置
+
+### 配置文件
+
+通过 `dc-extract init` 命令可以初始化配置文件 `.done-coding/extract.json5`。
+
+具体的配置选项需要查看初始化后生成的配置文件内容。
+
+## 编程接口
+
+本包提供了编程接口，具体的导出内容请查看包的类型定义文件。
+
+## 故障排除
+
+### 常见问题
+
+**Q: 配置文件找不到**
+```bash
+# 检查配置文件是否存在
+ls -la .done-coding/extract.json5
+
+# 重新初始化配置
+dc-extract init
+```
+
+**Q: 生成失败**
+```bash
+# 检查运行目录
+dc-extract -R ./src
+
+# 检查配置文件路径
+dc-extract -C ./custom-config.json5
+```
+
+### 调试模式
+
+```bash
+# 查看版本信息
+dc-extract --version
+
+# 查看帮助信息
+dc-extract --help
+```
+
+## 性能建议
+
+- 使用合适的文件匹配规则避免处理不必要的文件
+- 启用缓存可以提高重复提取的速度
+- 大项目建议使用并行处理模式
+
+## 贡献指南
+
+我们欢迎贡献！请遵循以下步骤：
+
+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/extract
+
+# 安装依赖
+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)
+- [模板处理工具](https://www.npmjs.com/package/@done-coding/cli-template) - 本包依赖的模板引擎
+- [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-898cd26e.js";
+import { c as m } from "./index-694d5432.js";
 import "./index-a1ee6691-8c73eb4d.js";
 import "@done-coding/cli-utils";
 import "node:path";

package/es/{index-898cd26e.js → index-694d5432.js}

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 import { a as r, e as V, E as u, S as h, G as S } from "./index-a1ee6691-8c73eb4d.js";
-import { log as s, _get as J, createSubcommand as N, getRootScriptName as v, getConfigFileCommonOptions as j, initHandlerCommon as F, readConfigFile as x, _set as U, createMainCommand as W } from "@done-coding/cli-utils";
+import { outputConsole as s, _get as J, createSubcommand as N, getRootScriptName as v, getConfigFileCommonOptions as j, initHandlerCommon as F, readConfigFile as x, _set as U, createMainCommand as W } from "@done-coding/cli-utils";
 import $ from "node:path";
-import y from "node:fs";
+import g from "node:fs";
 import { OutputModeEnum as H, batchCompileHandler as X } from "@done-coding/cli-template";
 const D = {
   name: "@done-coding/cli-extract",
-  version: "0.1.19",
+  version: "0.1.22",
   description: "信息提取命令行工具",
   bin: {
     "dc-extract": "es/cli.mjs"
@@ -50,7 +50,7 @@ const D = {
   }
 }, R = {
   name: "@done-coding/cli-inject",
-  version: "0.5.19",
+  version: "0.5.22",
   description: "信息(JSON)注入命令行工具",
   bin: {
     "dc-inject": "es/cli.mjs"
@@ -110,21 +110,21 @@ const D = {
     return s.error("源文件必须是json"), process.exit(1);
   if (!c.endsWith(".json"))
     return s.error("注入文件必须是json"), process.exit(1);
-  const l = $.resolve(e, t), f = y.readFileSync(l, "utf-8"), d = JSON.parse(f), i = Object.entries(m).reduce(
+  const l = $.resolve(e, t), f = g.readFileSync(l, "utf-8"), d = JSON.parse(f), i = Object.entries(m).reduce(
     (E, [b, M]) => {
       const L = C({ sourceJson: d, targetKey: b, keyConfig: M });
       return U(E, b, L), E;
     },
     {}
-  ), p = $.resolve(e, c), g = JSON.stringify(i, null, 2);
-  if (y.existsSync(p)) {
-    const E = y.readFileSync(p, "utf-8");
-    if (g === E)
+  ), p = $.resolve(e, c), y = JSON.stringify(i, null, 2);
+  if (g.existsSync(p)) {
+    const E = g.readFileSync(p, "utf-8");
+    if (y === E)
       return s.skip("注入文件已存在且内容相同，无需重复注入"), i;
     s.stage("文件内容变化,开始覆盖注入文件");
   } else
     s.stage("开始注入文件");
-  y.writeFileSync(p, g), s.success(`文件注入成功: ${p}`), s.info(g);
+  g.writeFileSync(p, y), s.success(`文件注入成功: ${p}`), s.info(y);
 }, se = async (e) => {
   const n = await x(e, () => (s.info("配置文件为空，使用默认配置"), O));
   if (!n)
@@ -144,7 +144,7 @@ const ae = ({
   input: e,
   rootDir: n
 }) => {
-  const o = $.resolve(n, e), t = y.readFileSync(o, "utf-8");
+  const o = $.resolve(n, e), t = g.readFileSync(o, "utf-8");
   return e.endsWith(".json") || e.endsWith(".json5") ? JSON.parse(t) : t;
 }, ue = (e) => typeof e == "object" && !!e, de = ({
   content: e,
@@ -259,7 +259,7 @@ const ae = ({
     default: S.RESULT,
     describe: "生成模式"
   }
-}), ge = async ({
+}), ye = async ({
   rootDir: e = process.cwd(),
   config: n
 }) => {
@@ -271,12 +271,12 @@ const ae = ({
       });
       return Object.entries(l).reduce(
         (d, [i, p]) => {
-          const g = de({
+          const y = de({
             content: f,
             targetKey: i,
             keyConfig: p
           });
-          return d[i] = g, d;
+          return d[i] = y, d;
         },
         c
       );
@@ -295,8 +295,8 @@ const ae = ({
   if (!n)
     return s.error("配置文件为空"), process.exit(1);
   const { rootDir: o } = e;
-  await ge({ rootDir: o, config: n });
-}, ye = {
+  await ye({ rootDir: o, config: n });
+}, ge = {
   command: "$0",
   describe: "生成文件",
   options: fe(),
@@ -313,7 +313,7 @@ const ae = ({
 }, { version: Ee, description: Ce } = D, _ = {
   describe: Ce,
   version: Ee,
-  subcommands: [le, ye].map(
+  subcommands: [le, ge].map(
     N
   ),
   demandCommandCount: 1,
@@ -335,9 +335,9 @@ export {
   le as b,
   Re as c,
   I as d,
-  ye as e,
+  ge as e,
   Ne as f,
-  ge as g,
+  ye as g,
   G as h,
   _ as i
 };

package/es/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { i as t, a as i, e as s, g as d, d as l, f as p, b as f, h as u } from "./index-898cd26e.js";
+import { i as t, a as i, e as s, g as d, d as l, f as p, b as f, h as u } from "./index-694d5432.js";
 import { E as C, G as E, S as b } from "./index-a1ee6691-8c73eb4d.js";
 import "@done-coding/cli-utils";
 import "node:path";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "done-coding-extract",
-  "version": "0.1.19",
+  "version": "0.1.22",
   "description": "信息提取命令行工具",
   "private": false,
   "module": "es/index.mjs",
@@ -42,21 +42,20 @@
   "license": "MIT",
   "sideEffects": false,
   "devDependencies": {
-    "@done-coding/cli-inject": "0.5.19",
+    "@done-coding/cli-inject": "0.5.22",
     "@types/node": "^18.0.0",
     "@types/yargs": "^17.0.28",
-    "rimraf": "^6.0.1",
-    "typescript": "^5.2.2",
+    "typescript": "^5.8.3",
     "vite": "^4.4.11",
     "vite-plugin-dts": "^3.6.0"
   },
+  "dependencies": {
+    "@done-coding/cli-template": "0.8.9",
+    "@done-coding/cli-utils": "0.8.3"
+  },
   "engines": {
     "node": ">=18.0.0"
   },
-  "dependencies": {
-    "@done-coding/cli-template": "0.8.6",
-    "@done-coding/cli-utils": "0.8.0"
-  },
-  "gitHead": "e68f726aa899f75c4d294b11620f343c953a74c3",
+  "gitHead": "4893b466954ef5925151d8dfc8fc8aa558ce654c",
   "scripts": {}
 }

package/types/index.d.ts

@@ -76,7 +76,7 @@ export declare const generateCommandCliInfo: SubCliInfo;
 
 /** 将提取的信息生成文件 */
 export declare const generateFile: ({ rootDir, config, }: {
-    rootDir?: string | undefined;
+    rootDir?: string;
     config: ExtractConfig;
 }) => Promise<void>;