done-coding-component 0.4.8 → 0.4.9

package/README.md

@@ -1,7 +1,188 @@
 # @done-coding/cli-component
 
-组件命令行工具
+组件生成命令行工具 - 快速创建和管理项目组件
 
-## 使用
+[![npm version](https://badge.fury.io/js/@done-coding%2Fcli-component.svg)](https://www.npmjs.com/package/@done-coding/cli-component)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+## 安装
+
+### 独立安装
+```bash
 npm install @done-coding/cli-component
+# 或
+pnpm add @done-coding/cli-component
+```
+
+### 作为 done-coding CLI 的一部分
+```bash
+npm install -g @done-coding/cli
+# 然后使用
+DC component [command]
+```
+
+## 快速开始
+
+```bash
+# 独立使用
+dc-component [command]
+
+# 作为主 CLI 的子命令
+DC component [command]
+
+# 查看帮助
+dc-component --help
+```
+
+## 功能特性
+
+- ✅ **组件创建**: 使用 `add` 命令创建新组件
+- 🗂️ **组件管理**: 使用 `list` 命令查看已创建的组件
+- 🗑️ **组件删除**: 使用 `remove` 命令删除不需要的组件
+- 🔧 **智能命名**: 自动处理组件名称的格式转换
+
+## API 文档
+
+### 基础命令
+
+#### `dc-component add <name>`
+新增一个组件
+
+```bash
+# 创建一个名为 Button 的组件
+dc-component add Button
+
+# 创建一个名为 UserCard 的组件
+dc-component add UserCard
+```
+
+**参数说明**:
+- `name`: 组件名称（必需）
+
+#### `dc-component remove [name]`
+删除一个组件
+
+```bash
+# 删除指定组件
+dc-component remove Button
+
+# 不指定名称时可能提供交互式选择
+dc-component remove
+```
+
+**参数说明**:
+- `name`: 组件名称（可选）
+
+#### `dc-component list`
+展示组件列表
+
+```bash
+# 显示所有已创建的组件
+dc-component list
+```
+
+## 使用示例
+
+### 基础使用场景
+
+```bash
+# 1. 查看当前组件列表
+dc-component list
+
+# 2. 创建新组件
+dc-component add MyButton
+
+# 3. 再次查看组件列表确认创建
+dc-component list
+
+# 4. 删除不需要的组件
+dc-component remove MyButton
+```
+
+### 作为主 CLI 的一部分
+
+```bash
+# 使用主 CLI 命令
+DC component add Button
+DC component list
+DC component remove Button
+
+# 使用替代命令
+dc-cli component add Button
+done-coding component list
+```
+
+## 故障排除
+
+### 常见问题
+
+**Q: 组件创建失败**
+```bash
+# 检查当前目录
+pwd
+
+# 查看详细错误信息
+dc-component add MyButton
+```
+
+**Q: 组件列表为空**
+```bash
+# 确认是否在正确的项目目录
+ls -la
+
+# 检查是否已创建过组件
+dc-component list
+```
+
+**Q: 删除组件失败**
+```bash
+# 确认组件名称正确
+dc-component list
+
+# 检查文件权限
+ls -la src/components/
+```
+
+## 贡献指南
+
+我们欢迎贡献！请遵循以下步骤：
+
+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/component
+
+# 安装依赖
+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-7fe45e8f.js";
+import { c as m } from "./index-578b8ec1.js";
 import "node:path";
 import "node:fs";
 import "@done-coding/cli-utils";

package/es/{index-7fe45e8f.js → index-578b8ec1.js}

@@ -1,23 +1,23 @@
 #!/usr/bin/env node
 import p from "node:path";
-import m from "node:fs";
-import { log as l, json5 as L, chalk as g, xPrompts as w, createSubcommand as O, getRootScriptName as V, createMainCommand as J } from "@done-coding/cli-utils";
+import u from "node:fs";
+import { log as m, json5 as F, getLogText as $, xPrompts as w, createSubcommand as O, getRootScriptName as V, createMainCommand as J } from "@done-coding/cli-utils";
 import x from "lodash.upperfirst";
-import v from "lodash.camelcase";
-import S from "lodash.kebabcase";
+import S from "lodash.camelcase";
+import v from "lodash.kebabcase";
 import T from "lodash.lowerfirst";
 import f from "lodash.template";
 import { OutputModeEnum as E, compileHandler as C } from "@done-coding/cli-template";
-var u = /* @__PURE__ */ ((e) => (e.ADD = "add", e.REMOVE = "remove", e.LIST = "list", e))(u || {});
+var l = /* @__PURE__ */ ((e) => (e.ADD = "add", e.REMOVE = "remove", e.LIST = "list", e))(l || {});
 const _ = (e, t) => {
   if (!/^[a-zA-Z]+[a-zA-Z0-9-]*$/.test(e))
-    return l.error("组件名只能包含字母、数字、中划线"), process.exit(1);
+    return m.error("组件名只能包含字母、数字、中划线"), process.exit(1);
   const { nameExcludes: n } = t;
-  return n.includes(e) ? (l.error(`组件名: ${e}是保留名称。
+  return n.includes(e) ? (m.error(`组件名: ${e}是保留名称。
 保留名称: ${n.join(",")}`), process.exit(1)) : !0;
-}, D = {
+}, g = {
   name: "@done-coding/cli-component",
-  version: "0.4.8",
+  version: "0.4.9",
   description: "组件命令行工具",
   bin: {
     "dc-component": "es/cli.mjs"
@@ -26,82 +26,82 @@ const _ = (e, t) => {
     namespaceDir: ".done-coding",
     moduleName: "component"
   }
-}, { namespaceDir: K, moduleName: z } = D.cliConfig, N = () => p.resolve(K, z), I = () => ({
+}, { namespaceDir: K, moduleName: z } = g.cliConfig, N = () => p.resolve(K, z), I = () => ({
   execDir: process.cwd(),
   templateDir: N()
-}), b = (e) => {
-  const { series: t, name: n } = e, o = x(v(n)), c = T(o), a = S(o), s = t ? x(v(t)) : "", i = s ? `${s}${o}` : "", d = S(i);
+}), D = (e) => {
+  const { series: t, name: n } = e, o = x(S(n)), i = T(o), a = v(o), s = t ? x(S(t)) : "", c = s ? `${s}${o}` : "", d = v(c);
   return {
     series: s,
     name: o,
-    nameLowerFirst: c,
+    nameLowerFirst: i,
     nameKebab: a,
-    fullName: i,
+    fullName: c,
     fullNameKebab: d,
     cls: d
   };
 }, Z = (e) => ({
   $: "$",
   ...I(),
-  ...b(e)
-}), $ = () => {
+  ...D(e)
+}), h = () => {
   const e = p.resolve(N(), "index.json");
-  if (!m.existsSync(e))
-    return l.error(`模块入口文件不存在: ${e}`), process.exit(1);
-  const n = JSON.parse(m.readFileSync(e, "utf-8")).config;
+  if (!u.existsSync(e))
+    return m.error(`模块入口文件不存在: ${e}`), process.exit(1);
+  const n = JSON.parse(u.readFileSync(e, "utf-8")).config;
   if (!n)
-    return l.error(`配置文件相对路径不存在: ${n}`), process.exit(1);
+    return m.error(`配置文件相对路径不存在: ${n}`), process.exit(1);
   const o = p.resolve(
     p.dirname(e),
     n
   );
-  if (!m.existsSync(o))
-    return l.error(`配置文件不存在: ${o}`), process.exit(1);
-  const c = L.parse(m.readFileSync(o, "utf-8")), a = I();
-  return c.componentDir = f(c.componentDir)(a), m.existsSync(c.componentDir) || m.mkdirSync(c.componentDir, {
+  if (!u.existsSync(o))
+    return m.error(`配置文件不存在: ${o}`), process.exit(1);
+  const i = F.parse(u.readFileSync(o, "utf-8")), a = I();
+  return i.componentDir = f(i.componentDir)(a), u.existsSync(i.componentDir) || u.mkdirSync(i.componentDir, {
     recursive: !0
-  }), c;
-}, k = async ({
+  }), i;
+}, R = async ({
   name: e,
   config: t,
   command: n
 }) => {
-  if (![u.ADD, u.REMOVE].includes(n))
-    return l.error(`不支持组件${n}操作`), process.exit(1);
+  if (![l.ADD, l.REMOVE].includes(n))
+    return m.error(`不支持组件${n}操作`), process.exit(1);
   const o = Z({
     ...t,
     name: e
-  }), c = process.cwd(), a = JSON.stringify(o);
-  for (const { entry: s, index: i } of t.list) {
+  }), i = process.cwd(), a = JSON.stringify(o);
+  for (const { entry: s, index: c } of t.list) {
     const d = {
       envData: a,
-      rollback: n === u.REMOVE,
+      rollback: n === l.REMOVE,
       /** 回滚时可以删除空文件 */
       rollbackDelNullFile: !0,
       rollbackDelAskAsYes: !0,
       dealMarkdown: !0,
       batch: !1,
-      rootDir: c
+      rootDir: i
     };
     if (s) {
       const r = s;
       r != null && r.input && (r.input = f(r.input)(o)), r != null && r.output && (r.output = f(r.output)(o));
-      const h = {
+      const b = {
         ...s,
         mode: E.APPEND,
         ...d
       };
-      await C(h);
+      await C(b);
     }
-    if (i) {
-      const r = i;
+    if (c) {
+      const r = c;
       r != null && r.input && (r.input = f(r.input)(o)), r != null && r.output && (r.output = f(r.output)(o));
-      const h = {
-        ...i,
+      const b = {
+        ...c,
         mode: E.OVERWRITE,
         ...d
       };
-      await C(h);
+      await C(b);
     }
   }
 }, H = () => ({
@@ -118,41 +118,44 @@ const _ = (e, t) => {
   }
 }), y = (e) => {
   const { componentDir: t, nameExcludes: n } = e;
-  return m.statSync(t).isDirectory() ? m.readdirSync(t).map((s) => {
-    const i = p.join(t, s);
-    return m.statSync(i).isDirectory() ? (console.log("filePath:", i, p.basename(i)), p.basename(i)) : "";
-  }).filter((s) => !(!s || n.includes(s))) : (l.error("组件源码路径不是目录"), process.exit(1));
-}, R = async ({
+  return u.statSync(t).isDirectory() ? u.readdirSync(t).map((s) => {
+    const c = p.join(t, s);
+    return u.statSync(c).isDirectory() ? (m.info("filePath:", c, p.basename(c)), p.basename(c)) : "";
+  }).filter((s) => !(!s || n.includes(s))) : (m.error("组件源码路径不是目录"), process.exit(1));
+}, k = async ({
   outputJson: e,
   outputPath: t
 }) => {
-  l.stage("展示列表");
-  const n = $(), o = y(n), c = t || n.nameListJsonOutputPath, a = o.map((s) => {
-    const { name: i, fullName: d } = b({
+  m.stage("展示列表");
+  const n = h(), o = y(n), i = t || n.nameListJsonOutputPath, a = o.map((s) => {
+    const { name: c, fullName: d } = D({
       ...n,
       name: s
     });
     return {
-      name: i,
+      name: c,
       nameKebab: s,
       fullName: d
     };
   });
   if (console.table(
-    a.map(({ name: s, fullName: i, nameKebab: d }) => ({
-      [g.green("名称")]: s,
-      [g.green("带系列名称")]: i,
-      [g.green("绝对路径")]: p.resolve(n.componentDir, d)
+    a.map(({ name: s, fullName: c, nameKebab: d }) => ({
+      [$.success("名称")]: s,
+      [$.success("带系列名称")]: c,
+      [$.success("绝对路径")]: p.resolve(
+        n.componentDir,
+        d
+      )
     }))
-  ), e && c) {
-    const s = p.resolve(c), i = p.dirname(s);
-    m.existsSync(i) || m.mkdirSync(i, { recursive: !0 }), console.log(g.blue(`输出组件名列表到${s}`)), m.writeFileSync(s, JSON.stringify(a, null, 2));
+  ), e && i) {
+    const s = p.resolve(i), c = p.dirname(s);
+    u.existsSync(c) || u.mkdirSync(c, { recursive: !0 }), m.stage(`输出组件名列表到${s}`), u.writeFileSync(s, JSON.stringify(a, null, 2));
   }
 }, U = {
-  command: u.LIST,
+  command: l.LIST,
   describe: "展示组件列表",
   options: H(),
-  handler: R
+  handler: k
 }, W = () => ({
   name: {
     describe: "组件名称",
@@ -161,29 +164,29 @@ const _ = (e, t) => {
 }), A = async ({
   name: e
 }) => {
-  l.stage("添加组件");
+  m.stage("添加组件");
   let t;
   e ? t = e : t = (await w({
     type: "text",
     name: "name",
     message: "请输入组件名"
   })).name;
-  const n = $();
+  const n = h();
   _(t, n);
-  const { series: o } = n, c = await y(n);
-  for (let a of c)
-    if (b({
+  const { series: o } = n, i = await y(n);
+  for (let a of i)
+    if (D({
       series: o,
       name: t
     }).nameKebab === a)
-      return l.error(`组件${a}已存在, 不能再次创建${t}组件`), process.exit(1);
-  return k({
+      return m.error(`组件${a}已存在, 不能再次创建${t}组件`), process.exit(1);
+  return R({
     name: t,
     config: n,
-    command: u.ADD
+    command: l.ADD
   });
 }, Y = {
-  command: `${u.ADD} <name>`,
+  command: `${l.ADD} <name>`,
   describe: "新增一个组件",
   positionals: W(),
   handler: A
@@ -195,10 +198,10 @@ const _ = (e, t) => {
 }), M = async ({
   name: e
 }) => {
-  l.stage("移除组件");
-  const t = $(), n = await y(t);
+  m.stage("移除组件");
+  const t = h(), n = await y(t);
   if (n.length === 0)
-    return l.error("组件列表为空"), process.exit(1);
+    return m.error("组件列表为空"), process.exit(1);
   let o;
   e ? o = e : o = (await w({
     type: "select",
@@ -206,37 +209,37 @@ const _ = (e, t) => {
     message: "请选择要移除的组件",
     choices: n.map((a) => ({ title: a, value: a }))
   })).name;
-  const { series: c } = t;
+  const { series: i } = t;
   for (let a of n)
-    if (b({
-      series: c,
+    if (D({
+      series: i,
       name: o
     }).nameKebab === a) {
-      await k({
+      await R({
         name: o,
         config: t,
-        command: u.REMOVE
-      }), m.rmdirSync(p.resolve(t.componentDir, a));
+        command: l.REMOVE
+      }), u.rmdirSync(p.resolve(t.componentDir, a));
       return;
     }
-  return l.error(`组件${o}不存在`), process.exit(1);
+  return m.error(`组件${o}不存在`), process.exit(1);
 }, B = {
-  command: `${u.REMOVE} [name]`,
+  command: `${l.REMOVE} [name]`,
   describe: "删除一个组件",
   positionals: q(),
   handler: M
-}, ce = async (e, t) => {
+}, ie = async (e, t) => {
   switch (e) {
-    case u.ADD:
+    case l.ADD:
       return A(t);
-    case u.REMOVE:
+    case l.REMOVE:
       return M(t);
-    case u.LIST:
-      return R();
+    case l.LIST:
+      return k(t);
     default:
       throw new Error(`不支持的命令 ${e}`);
   }
-}, { version: G, description: Q } = D, j = {
+}, { version: G, description: Q } = g, L = {
   describe: Q,
   version: G,
   subcommands: [
@@ -245,22 +248,22 @@ const _ = (e, t) => {
     U
   ].map(O),
   demandCommandCount: 1,
-  rootScriptName: V({ packageJson: D })
+  rootScriptName: V({ packageJson: g })
 }, {
   cliConfig: { moduleName: P }
-} = D, F = (e = !1) => {
+} = g, j = (e = !1) => {
   const t = e ? P : void 0, n = `$0${e ? ` ${P}` : ""} <command> [options]`;
   return { command: t, usage: n };
 }, me = async () => J({
-  ...j,
-  ...F()
-}), le = () => O({
-  ...j,
-  ...F(!0)
+  ...L,
+  ...j()
+}), ue = () => O({
+  ...L,
+  ...j(!0)
 });
 export {
-  u as S,
-  le as a,
+  l as S,
+  ue as a,
   me as c,
-  ce as h
+  ie as h
 };

package/es/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { S as u, a as b, h as c } from "./index-7fe45e8f.js";
+import { S as u, a as b, h as c } from "./index-578b8ec1.js";
 import "node:path";
 import "node:fs";
 import "@done-coding/cli-utils";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "done-coding-component",
-  "version": "0.4.8",
+  "version": "0.4.9",
   "description": "组件命令行工具",
   "private": false,
   "module": "es/index.mjs",
@@ -31,7 +31,7 @@
   "license": "MIT",
   "sideEffects": false,
   "devDependencies": {
-    "@done-coding/cli-inject": "0.5.19",
+    "@done-coding/cli-inject": "0.5.20",
     "@types/lodash.camelcase": "^4.3.8",
     "@types/lodash.kebabcase": "^4.1.8",
     "@types/lodash.lowerfirst": "^4.3.8",
@@ -48,14 +48,14 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@done-coding/cli-template": "0.8.6",
-    "@done-coding/cli-utils": "0.8.0",
+    "@done-coding/cli-template": "0.8.7",
+    "@done-coding/cli-utils": "0.8.1",
     "lodash.camelcase": "^4.3.0",
     "lodash.kebabcase": "^4.1.1",
     "lodash.lowerfirst": "^4.3.1",
     "lodash.template": "^4.5.0",
     "lodash.upperfirst": "^4.3.1"
   },
-  "gitHead": "e68f726aa899f75c4d294b11620f343c953a74c3",
+  "gitHead": "0930f800167c04a86b56eae9741872dd51bec0c6",
   "scripts": {}
 }