@done-coding/cli-inject 0.5.19 → 0.5.20

package/README.md

@@ -1,7 +1,184 @@
 # @done-coding/cli-inject
 
-done-coding信息(JSON)注入命令行工具
+信息(JSON)注入命令行工具 - 将 JSON 数据注入到文件中
 
-## 使用
+[![npm version](https://badge.fury.io/js/@done-coding%2Fcli-inject.svg)](https://www.npmjs.com/package/@done-coding/cli-inject)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+## 安装
+
+### 独立安装
+```bash
 npm install @done-coding/cli-inject
+# 或
+pnpm add @done-coding/cli-inject
+```
+
+### 作为 done-coding CLI 的一部分
+```bash
+npm install -g @done-coding/cli
+# 然后使用
+DC inject [command]
+```
+
+## 快速开始
+
+```bash
+# 独立使用
+dc-inject [command]
+
+# 作为主 CLI 的子命令
+DC inject [command]
+
+# 查看帮助
+dc-inject --help
+```
+
+## 功能特性
+
+- ✅ **JSON 注入**: 将 JSON 数据注入到指定文件中
+- 🔧 **配置管理**: 支持配置文件管理注入规则
+- 📁 **目录支持**: 支持指定运行目录和配置文件路径
+- 🔄 **批量处理**: 支持批量注入操作
+
+## API 文档
+
+### 基础命令
+
+#### `dc-inject init`
+初始化配置文件
+
+```bash
+# 创建默认配置文件
+dc-inject init
+```
+
+#### `dc-inject` (默认命令)
+生成文件
+
+```bash
+# 使用默认配置生成文件
+dc-inject
+
+# 指定运行目录
+dc-inject -R ./src
+
+# 指定配置文件路径
+dc-inject -C ./custom-config.json
+```
+
+**选项说明**:
+- `-R, --rootDir`: 运行目录
+- `-C, --configPath`: 配置文件相对路径，默认为 `./.done-coding/inject.json`
+
+## 使用示例
+
+### 基础使用场景
+
+```bash
+# 1. 初始化配置
+dc-inject init
+
+# 2. 执行注入操作
+dc-inject
+
+# 3. 指定不同的运行目录
+dc-inject -R ./packages/core
+```
+
+### 作为主 CLI 的一部分
+
+```bash
+# Windows 系统
+dc inject init
+dc inject -R ./src
+
+# macOS/Linux 系统
+DC inject init
+DC inject -R ./src
+```
+
+## 配置
+
+通过 `dc-inject init` 命令可以初始化配置文件 `.done-coding/inject.json`。
+
+具体的配置选项需要查看初始化后生成的配置文件内容。
+
+## 编程接口
+
+本包提供了编程接口，具体的导出内容请查看包的类型定义文件。
+
+## 故障排除
+
+### 常见问题
+
+**Q: 配置文件找不到**
+```bash
+# 检查配置文件是否存在
+ls -la .done-coding/inject.json
+
+# 重新初始化配置
+dc-inject init
+```
+
+**Q: 注入失败**
+```bash
+# 检查运行目录
+dc-inject -R ./src
+
+# 检查配置文件路径
+dc-inject -C ./custom-config.json
+```
+
+### 调试模式
+
+```bash
+# 查看版本信息
+dc-inject --version
+
+# 查看帮助信息
+dc-inject --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/inject
+
+# 安装依赖
+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)
+- [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-3b0208e2.js";
+import { c as m } from "./index-b3f74005.js";
 import "./index-a1ee6691.js";
 import "@done-coding/cli-utils";
 import "node:path";

package/es/{index-3b0208e2.js → index-b3f74005.js}

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { I as c, S as E } from "./index-a1ee6691.js";
 import { log as o, _get as I, initHandlerCommon as k, getConfigFileCommonOptions as A, _set as w, readConfigFile as T, createSubcommand as N, getRootScriptName as _, createMainCommand as M } from "@done-coding/cli-utils";
-import $ from "node:path";
+import D from "node:path";
 import u from "node:fs";
 const x = ({
   sourceJson: e,
@@ -36,7 +36,7 @@ const x = ({
   }
 }, d = {
   name: "@done-coding/cli-inject",
-  version: "0.5.19",
+  version: "0.5.20",
   description: "信息(JSON)注入命令行工具",
   bin: {
     "dc-inject": "es/cli.mjs"
@@ -47,7 +47,7 @@ const x = ({
   }
 }, {
   cliConfig: { namespaceDir: G, moduleName: J }
-} = d, L = `./${G}/${J}`, R = `${L}.json`, h = {
+} = d, L = `./${G}/${J}`, R = `${L}.json`, U = {
   sourceFilePath: "./package.json",
   keyConfigMap: {
     name: {
@@ -64,22 +64,22 @@ const x = ({
     }
   },
   injectFilePath: "./src/injectInfo.json"
-}, U = () => A({
+}, h = U, V = () => A({
   configPathDefault: R
 }), S = async (e) => k(h, e, {
   onFileGenerated: () => {
     o.info("文件生成成功");
   }
-}), V = {
+}), H = {
   command: E.INIT,
   describe: "初始化配置文件",
-  options: U(),
+  options: V(),
   handler: S
-}, H = () => ({
+}, K = () => ({
   ...A({
     configPathDefault: R
   })
-}), K = async ({
+}), W = async ({
   rootDir: e = process.cwd(),
   config: n = h,
   keyConfigMap: t = {}
@@ -96,13 +96,13 @@ const x = ({
     return o.error("源文件必须是json"), process.exit(1);
   if (!r.endsWith(".json"))
     return o.error("注入文件必须是json"), process.exit(1);
-  const p = $.resolve(e, s), g = u.readFileSync(p, "utf-8"), y = JSON.parse(g), i = Object.entries(f).reduce(
+  const p = D.resolve(e, s), g = u.readFileSync(p, "utf-8"), y = JSON.parse(g), i = Object.entries(f).reduce(
     (m, [F, v]) => {
       const P = x({ sourceJson: y, targetKey: F, keyConfig: v });
       return w(m, F, P), m;
     },
     {}
-  ), l = $.resolve(e, r), C = JSON.stringify(i, null, 2);
+  ), l = D.resolve(e, r), C = JSON.stringify(i, null, 2);
   if (u.existsSync(l)) {
     const m = u.readFileSync(l, "utf-8");
     if (C === m)
@@ -116,13 +116,13 @@ const x = ({
   if (!n)
     return o.error("配置文件为空"), process.exit(1);
   const { rootDir: t } = e;
-  await K({ rootDir: t, config: n });
-}, W = {
+  await W({ rootDir: t, config: n });
+}, X = {
   command: "$0",
   describe: "生成文件",
-  options: H(),
+  options: K(),
   handler: j
-}, Z = async (e, n) => {
+}, ee = async (e, n) => {
   switch (e) {
     case E.INIT:
       return S(n);
@@ -131,34 +131,34 @@ const x = ({
     default:
       return j(n);
   }
-}, { version: X, description: q } = d, b = {
-  describe: q,
-  version: X,
-  subcommands: [V, W].map(
+}, { version: q, description: z } = d, b = {
+  describe: z,
+  version: q,
+  subcommands: [H, X].map(
     N
   ),
   demandCommandCount: 1,
   rootScriptName: _({ packageJson: d })
 }, {
-  cliConfig: { moduleName: D }
+  cliConfig: { moduleName: $ }
 } = d, O = (e = !1) => {
-  const n = e ? D : void 0, t = `$0${e ? ` ${D}` : ""} <command> [options]`;
+  const n = e ? $ : void 0, t = `$0${e ? ` ${$}` : ""} <command> [options]`;
   return { command: n, usage: t };
-}, ee = async () => M({
+}, ne = async () => M({
   ...b,
   ...O()
-}), ne = () => N({
+}), oe = () => N({
   ...b,
   ...O(!0)
 });
 export {
-  ne as a,
-  V as b,
-  ee as c,
+  oe as a,
+  H as b,
+  ne as c,
   j as d,
-  W as e,
-  Z as f,
-  K as g,
+  X as e,
+  ee as f,
+  W as g,
   S as h,
   b as i,
   x as k

package/es/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { i as r, a as i, e as s, g as t, d, f as l, b as f, h as p, k as C } from "./index-3b0208e2.js";
+import { i as r, a as i, e as s, g as t, d, f as l, b as f, h as p, k as C } from "./index-b3f74005.js";
 import { I as g, S as u } from "./index-a1ee6691.js";
 import "@done-coding/cli-utils";
 import "node:path";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-inject",
-  "version": "0.5.19",
+  "version": "0.5.20",
   "description": "信息(JSON)注入命令行工具",
   "private": false,
   "module": "es/index.mjs",
@@ -64,7 +64,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@done-coding/cli-utils": "0.8.0"
+    "@done-coding/cli-utils": "0.8.1"
   },
-  "gitHead": "e68f726aa899f75c4d294b11620f343c953a74c3"
+  "gitHead": "0930f800167c04a86b56eae9741872dd51bec0c6"
 }