@done-coding/cli-publish 0.7.11 → 0.7.13

package/README.md

@@ -1,7 +1,250 @@
 # @done-coding/cli-publish
 
-项目发布命令行工具
+项目发布命令行工具 - 自动化项目版本管理和发布流程
 
-## 使用
+[![npm version](https://badge.fury.io/js/@done-coding%2Fcli-publish.svg)](https://www.npmjs.com/package/@done-coding/cli-publish)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-npm install @done-coding/cli-publish
+## 安装
+
+### 独立安装
+```bash
+npm install @done-coding/cli-publish
+# 或
+pnpm add @done-coding/cli-publish
+```
+
+### 作为 done-coding CLI 的一部分
+```bash
+npm install -g @done-coding/cli
+# 然后使用
+DC publish [command]
+```
+
+## 快速开始
+
+```bash
+# 独立使用
+dc-publish [command]
+
+# 作为主 CLI 的子命令
+DC publish [command]
+
+# 查看帮助
+dc-publish --help
+```
+
+## 功能特性
+
+- ✅ **版本管理**: 支持语义化版本号管理
+- 📦 **多模式发布**: 支持 npm 和 web 两种发布模式
+- 🏷️ **标签管理**: 支持不同的发布标签（latest、next、alpha、beta、rc）
+- 🔄 **Git 集成**: 支持自动推送到远程仓库
+- ⚙️ **配置管理**: 支持配置文件管理发布规则
+
+## API 文档
+
+### 基础命令
+
+#### `dc-publish init`
+初始化配置文件
+
+```bash
+# 创建默认配置文件
+dc-publish init
+```
+
+#### `dc-publish` (默认命令)
+执行发布命令
+
+```bash
+# 使用默认配置发布
+dc-publish
+
+# 指定发布类型
+dc-publish -t patch
+
+# 指定发布模式
+dc-publish -m npm
+
+# 指定发布标签
+dc-publish -d next
+
+# 禁用推送到远程仓库
+dc-publish -p false
+```
+
+#### `dc-publish alias`
+别名发布
+
+```bash
+# 执行别名发布
+dc-publish alias
+```
+
+### 命令选项
+
+- `-R, --rootDir`: 运行目录
+- `-C, --configPath`: 配置文件相对路径，默认为 `./.done-coding/publish.json`
+- `-m, --mode`: 发布模式，可选值：`npm`（默认）、`web`
+- `-t, --type`: 发布类型，可选值：`major`、`minor`、`patch`、`premajor`、`preminor`、`prepatch`、`prerelease`、`custom version`
+- `-p, --push`: 是否推送至远程仓库，默认为 `true`
+- `-d, --distTag`: 发布标签，可选值：`latest`、`next`、`alpha`、`beta`、`rc`
+
+## 使用示例
+
+### 基础使用场景
+
+```bash
+# 1. 初始化配置
+dc-publish init
+
+# 2. 发布补丁版本
+dc-publish -t patch
+
+# 3. 发布到 next 标签
+dc-publish -t minor -d next
+
+# 4. 发布但不推送到远程仓库
+dc-publish -t patch -p false
+```
+
+### 不同发布类型
+
+```bash
+# 主版本发布 (1.0.0 -> 2.0.0)
+dc-publish -t major
+
+# 次版本发布 (1.0.0 -> 1.1.0)
+dc-publish -t minor
+
+# 补丁版本发布 (1.0.0 -> 1.0.1)
+dc-publish -t patch
+
+# 预发布版本 (1.0.0 -> 1.0.1-0)
+dc-publish -t prerelease
+```
+
+### 不同发布模式
+
+```bash
+# npm 模式发布
+dc-publish -m npm
+
+# web 模式发布
+dc-publish -m web
+```
+
+### 作为主 CLI 的一部分
+
+```bash
+# Windows 系统
+dc publish init
+dc publish -t patch
+dc publish alias
+
+# macOS/Linux 系统
+DC publish init
+DC publish -t patch
+DC publish alias
+```
+
+## 配置
+
+通过 `dc-publish init` 命令可以初始化配置文件 `.done-coding/publish.json`。
+
+具体的配置选项需要查看初始化后生成的配置文件内容。
+
+## 编程接口
+
+本包提供了编程接口，具体的导出内容请查看包的类型定义文件。
+
+## 故障排除
+
+### 常见问题
+
+**Q: 配置文件找不到**
+```bash
+# 检查配置文件是否存在
+ls -la .done-coding/publish.json
+
+# 重新初始化配置
+dc-publish init
+```
+
+**Q: 发布失败**
+```bash
+# 检查 npm 登录状态
+npm whoami
+
+# 检查包名是否已存在
+npm view @your-package-name
+
+# 检查网络连接
+npm ping
+```
+
+**Q: Git 推送失败**
+```bash
+# 检查 Git 远程仓库配置
+git remote -v
+
+# 检查 Git 认证
+git config --list | grep user
+
+# 禁用自动推送
+dc-publish -p false
+```
+
+### 调试模式
+
+```bash
+# 查看版本信息
+dc-publish --version
+
+# 查看帮助信息
+dc-publish --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/publish
+
+# 安装依赖
+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,10 +1,8 @@
 #!/usr/bin/env node
-import { c as m } from "./index-ccdf15a3.js";
+import { c as m } from "./index-f33712b6.js";
 import "@done-coding/cli-utils";
-import "node:os";
 import "node:child_process";
 import "semver";
-import "uuid";
 import "node:path";
 import "node:fs";
 m();

package/es/{index-ccdf15a3.js → index-f33712b6.js}

@@ -1,15 +1,13 @@
 #!/usr/bin/env node
-import { getConfigFileCommonOptions as O, initHandlerCommon as F, log as d, readConfigFile as _, getPackageJson as w, getGitLastCommitInfo as G, pushGitPublishInfoToRemote as W, xPrompts as $, createSubcommand as D, getRootScriptName as X, createMainCommand as V } from "@done-coding/cli-utils";
-import { tmpdir as q } from "node:os";
+import { getConfigFileCommonOptions as O, initHandlerCommon as F, log as m, readConfigFile as H, getPackageJson as $, applyUseTempDir as U, getCliModuleTempDir as G, getGitLastCommitInfo as W, pushGitPublishInfoToRemote as X, xPrompts as L, createSubcommand as y, getRootScriptName as V, createMainCommand as q } from "@done-coding/cli-utils";
 import { execSync as l } from "node:child_process";
-import { inc as L } from "semver";
-import { v4 as z } from "uuid";
-import T from "node:path";
-import b, { rmSync as K } from "node:fs";
-var g = /* @__PURE__ */ ((e) => (e.INIT = "init", e.EXEC = "exec", e.ALIAS = "alias", e))(g || {}), r = /* @__PURE__ */ ((e) => (e.MAJOR = "major", e.MINOR = "minor", e.PATCH = "patch", e.PREMAJOR = "premajor", e.PREMINOR = "preminor", e.PREPATCH = "prepatch", e.PRERELEASE = "prerelease", e.CUSTOM_VERSION = "custom version", e))(r || {}), f = /* @__PURE__ */ ((e) => (e.LATEST = "latest", e.NEXT = "next", e.ALPHA = "alpha", e.BETA = "beta", e.RC = "rc", e))(f || {}), c = /* @__PURE__ */ ((e) => (e.NPM = "npm", e.WEB = "web", e))(c || {});
-const P = {
+import { inc as N } from "semver";
+import z from "node:path";
+import S, { rmSync as K } from "node:fs";
+var I = /* @__PURE__ */ ((e) => (e.INIT = "init", e.EXEC = "exec", e.ALIAS = "alias", e))(I || {}), r = /* @__PURE__ */ ((e) => (e.MAJOR = "major", e.MINOR = "minor", e.PATCH = "patch", e.PREMAJOR = "premajor", e.PREMINOR = "preminor", e.PREPATCH = "prepatch", e.PRERELEASE = "prerelease", e.CUSTOM_VERSION = "custom version", e))(r || {}), f = /* @__PURE__ */ ((e) => (e.LATEST = "latest", e.NEXT = "next", e.ALPHA = "alpha", e.BETA = "beta", e.RC = "rc", e))(f || {}), c = /* @__PURE__ */ ((e) => (e.NPM = "npm", e.WEB = "web", e))(c || {});
+const R = {
   name: "@done-coding/cli-publish",
-  version: "0.7.11",
+  version: "0.7.13",
   description: "项目发布命令行工具",
   bin: {
     "dc-publish": "es/cli.mjs"
@@ -18,9 +16,9 @@ const P = {
     namespaceDir: ".done-coding",
     moduleName: "publish"
   }
-}, Q = `${q()}/.DONE_CODING_CLI/PUBLISH_ALIAS_TEMP_DIR`, {
-  cliConfig: { namespaceDir: Y, moduleName: Z }
-} = P, ee = `./${Y}/${Z}`, v = `${ee}.json`, te = {
+}, {
+  cliConfig: { namespaceDir: Q, moduleName: Y }
+} = R, Z = `./${Q}/${Y}`, v = `${Z}.json`, ee = {
   [c.WEB]: {},
   [c.NPM]: {
     aliasInfo: [
@@ -33,65 +31,70 @@ const P = {
       }
     ]
   }
-}, ne = () => O({
+}, te = () => O({
   configPathDefault: v
-}), k = async (e) => F(te, e, {
+}), k = async (e) => F(ee, e, {
   onFileGenerated: () => {
-    d.info("文件生成成功");
+    m.info("文件生成成功");
   }
-}), oe = {
-  command: g.INIT,
+}), ne = {
+  command: I.INIT,
   describe: "初始化配置文件",
-  options: ne(),
+  options: te(),
   handler: k
-}, se = () => O({
+}, oe = () => O({
   configPathDefault: v
-}), y = (e) => {
+}), J = (e) => {
   var o;
   const t = ((o = e[c.NPM]) == null ? void 0 : o.aliasInfo) || [];
   if (t.length)
     return t;
-}, S = async (e) => {
-  var u;
-  const t = await _(e, () => ({})), o = y(t);
+}, M = async (e) => {
+  const t = await H(e, () => ({})), o = J(t);
   if (!o) {
-    d.warn("没有配置别名发布信息");
+    m.warn("没有配置别名发布信息");
     return;
   }
-  const { rootDir: m } = e, s = w({ rootDir: m }), { name: a, version: i } = s, n = T.resolve(Q, z());
-  b.mkdirSync(n, { recursive: !0 }), l(`pnpm add ${a}@${i}`, {
-    stdio: "inherit",
-    cwd: n
-  });
-  const h = (u = l(`npm dist-tag ${a}`).toString().trim().split(`
-`).map((C) => C.split(":").map((R) => R.trim())).find(
-    ([, C]) => C === i
-  )) == null ? void 0 : u[0];
-  if (!h)
-    return d.warn(`没有找到 ${a}@${i} 对应的dist-tag`);
-  const E = T.resolve(n, "node_modules", a), I = w({
-    rootDir: E
+  const { rootDir: d } = e, s = $({ rootDir: d }), { name: a, version: i } = s;
+  return U({
+    dir: G(R.cliConfig.moduleName),
+    fn: async (n) => {
+      var g;
+      S.mkdirSync(n, { recursive: !0 }), l(`pnpm add ${a}@${i}`, {
+        stdio: "inherit",
+        cwd: n
+      });
+      const h = (g = l(`npm dist-tag ${a}`).toString().trim().split(`
+`).map((E) => E.split(":").map((w) => w.trim())).find(
+        ([, E]) => E === i
+      )) == null ? void 0 : g[0];
+      if (!h)
+        return m.warn(`没有找到 ${a}@${i} 对应的dist-tag`);
+      const C = z.resolve(n, "node_modules", a), u = $({
+        rootDir: C
+      });
+      for (let E of o) {
+        const { packageJson: w } = E, j = {
+          ...u,
+          ...w
+        }, B = `${C}/package.json`;
+        S.writeFileSync(
+          B,
+          JSON.stringify(j, null, 2)
+        ), l(`pnpm publish --tag ${h}`, {
+          stdio: "inherit",
+          cwd: C
+        });
+      }
+      K(n, { recursive: !0, force: !0 });
+    }
   });
-  for (let C of o) {
-    const { packageJson: R } = C, j = {
-      ...I,
-      ...R
-    }, U = `${E}/package.json`;
-    b.writeFileSync(
-      U,
-      JSON.stringify(j, null, 2)
-    ), l(`pnpm publish --tag ${h}`, {
-      stdio: "inherit",
-      cwd: E
-    });
-  }
-  K(n, { recursive: !0, force: !0 });
-}, re = {
-  command: g.ALIAS,
+}, se = {
+  command: I.ALIAS,
   describe: "别名发布",
-  options: se(),
-  handler: S
-}, ie = () => ({
+  options: oe(),
+  handler: M
+}, re = () => ({
   ...O({
     configPathDefault: v
   }),
@@ -117,12 +120,12 @@ const P = {
     describe: "发布标签",
     choices: Object.values(f)
   }
-}), N = async ({
+}), P = async ({
   packageJson: e,
   type: t,
   distTag: o
 }) => {
-  let m = e.name, s = "", a;
+  let d = e.name, s = "", a;
   const { version: i } = e;
   if (!i)
     throw new Error("当前版本号为空");
@@ -130,27 +133,27 @@ const P = {
     case r.PATCH:
     case r.MINOR:
     case r.MAJOR: {
-      s = L(i, t), a = o || f.LATEST;
+      s = N(i, t), a = o || f.LATEST;
       break;
     }
     case r.PREPATCH:
     case r.PREMINOR:
     case r.PREMAJOR: {
-      s = L(i, t, f.ALPHA), a = o || f.ALPHA;
+      s = N(i, t, f.ALPHA), a = o || f.ALPHA;
       break;
     }
     case r.PRERELEASE: {
-      const n = (await $({
+      const n = (await L({
         type: "text",
         name: "identifier",
         message: "请输入修饰符",
         initial: f.ALPHA
       })).identifier;
-      s = L(i, t, n), a = o || n;
+      s = N(i, t, n), a = o || n;
       break;
     }
     default:
-      s = (await $({
+      s = (await L({
         type: "text",
         name: "customVersion",
         message: "请输入自定义版本号"
@@ -159,23 +162,23 @@ const P = {
   if (!s)
     throw new Error("version is empty");
   return {
-    name: m,
+    name: d,
     version: s,
     tag: a
   };
-}, ae = async ({
+}, ie = async ({
   type: e,
   packageJson: t,
   distTag: o
 }) => {
   if (e)
-    return await N({
+    return await P({
       packageJson: t,
       type: e,
       distTag: o
     });
   {
-    const m = {}, s = [
+    const d = {}, s = [
       r.PATCH,
       r.MINOR,
       r.MAJOR,
@@ -184,14 +187,14 @@ const P = {
       r.PREMAJOR
     ];
     for (let n of s)
-      m[n] = await N({
+      d[n] = await P({
         packageJson: t,
         type: n,
         distTag: o
       });
     const a = [
       ...s.map((n) => ({
-        title: `${n} (${m[n].version})`,
+        title: `${n} (${d[n].version})`,
         value: n
       })),
       ...[
@@ -201,35 +204,35 @@ const P = {
         title: n,
         value: n
       }))
-    ], i = (await $({
+    ], i = (await L({
       type: "select",
       name: "selectType",
       message: `请选择发布类型，当前版本：${t.version}`,
       choices: a
     })).selectType;
-    return s.includes(i) ? m[i] : N({
+    return s.includes(i) ? d[i] : P({
       packageJson: t,
       type: i,
       distTag: o
     });
   }
-}, J = async (e) => {
-  const { mode: t, type: o, push: m, rootDir: s, distTag: a } = e, i = await _(e, () => ({})), n = i[t], A = await G(n), M = w({ rootDir: s }), p = await ae({
+}, x = async (e) => {
+  const { mode: t, type: o, push: d, rootDir: s, distTag: a } = e, i = await H(e, () => ({})), n = i[t], A = await W(n), T = $({ rootDir: s }), p = await ie({
     type: o,
-    packageJson: M,
+    packageJson: T,
     distTag: a
   }), { version: h } = p;
   l(`npm version ${h}`, {
     cwd: s,
     stdio: "inherit"
   });
-  const { tag: E } = p;
+  const { tag: C } = p;
   try {
     switch (t) {
       case c.WEB: {
-        const { build: I } = n;
-        if (I)
-          l(`${I}`, {
+        const { build: u } = n;
+        if (u)
+          l(`${u}`, {
             stdio: "inherit",
             cwd: s
           });
@@ -238,7 +241,7 @@ const P = {
         break;
       }
       case c.NPM: {
-        l(`npm publish --tag ${E}`, {
+        l(`npm publish --tag ${C}`, {
           cwd: s,
           stdio: "inherit"
         });
@@ -247,70 +250,70 @@ const P = {
       default:
         throw new Error(`未知发布模式：${t}`);
     }
-  } catch (I) {
-    d.error(`发布失败, error: ${I.message}`);
+  } catch (u) {
+    m.error(`发布失败, error: ${u.message}`);
     try {
-      d.info(`回滚本地版本到发布前的版本：${A.lastHash}`);
-      const { lastHash: u } = A;
-      l(`git reset --hard ${u}`, {
+      m.info(`回滚本地版本到发布前的版本：${A.lastHash}`);
+      const { lastHash: g } = A;
+      l(`git reset --hard ${g}`, {
         stdio: "inherit"
-      }), d.info(`删除本次发布时生成的tag：v${p.version}`), l(`git tag -d v${p.version}`, {
+      }), m.info(`删除本次发布时生成的tag：v${p.version}`), l(`git tag -d v${p.version}`, {
         stdio: "inherit"
       });
-    } catch (u) {
-      d.error(`回滚失败, error: ${u.message}`);
+    } catch (g) {
+      m.error(`回滚失败, error: ${g.message}`);
     }
     return process.exit(1);
   }
-  m && W({
+  d && X({
     branchName: A.branchName,
     version: p.version,
     remoteInfo: A.remoteInfo
-  }), d.success(`发布成功，版本号：${h}`), t === c.NPM && y(i) && S(e);
-}, ce = {
+  }), m.success(`发布成功，版本号：${h}`), t === c.NPM && J(i) && M(e);
+}, ae = {
   command: "$0",
   describe: "执行发布命令",
-  options: ie(),
-  handler: J
-}, he = async (e, t) => {
+  options: re(),
+  handler: x
+}, ge = async (e, t) => {
   switch (e) {
-    case g.INIT:
+    case I.INIT:
       return k(t);
-    case g.EXEC:
-      return J(t);
-    case g.ALIAS:
-      return S(t);
+    case I.EXEC:
+      return x(t);
+    case I.ALIAS:
+      return M(t);
     default:
       throw new Error(`不支持的命令 ${e}`);
   }
-}, { version: me, description: de } = P, x = {
+}, { version: ce, description: de } = R, D = {
   describe: de,
-  version: me,
+  version: ce,
   subcommands: [
-    oe,
-    ce,
-    re
-  ].map(D),
+    ne,
+    ae,
+    se
+  ].map(y),
   demandCommandCount: 1,
-  rootScriptName: X({ packageJson: P })
+  rootScriptName: V({ packageJson: R })
 }, {
-  cliConfig: { moduleName: H }
-} = P, B = (e = !1) => {
-  const t = e ? H : void 0, o = `$0${e ? ` ${H}` : ""} [options]`;
+  cliConfig: { moduleName: b }
+} = R, _ = (e = !1) => {
+  const t = e ? b : void 0, o = `$0${e ? ` ${b}` : ""} [options]`;
   return { command: t, usage: o };
-}, Ee = async () => V({
-  ...x,
-  ...B()
-}), Ce = () => D({
-  ...x,
-  ...B(!0)
+}, Ie = async () => q({
+  ...D,
+  ..._()
+}), Ae = () => y({
+  ...D,
+  ..._(!0)
 });
 export {
   r as P,
-  g as S,
-  Ce as a,
+  I as S,
+  Ae as a,
   f as b,
-  Ee as c,
+  Ie as c,
   c as d,
-  he as h
+  ge as h
 };

package/es/index.mjs

@@ -1,17 +1,15 @@
 #!/usr/bin/env node
-import { d as t, b as e, P as b, S as d, a as h, h as l } from "./index-ccdf15a3.js";
+import { d as u, b as e, P as b, S as p, a as t, h as d } from "./index-f33712b6.js";
 import "@done-coding/cli-utils";
-import "node:os";
 import "node:child_process";
 import "semver";
-import "uuid";
 import "node:path";
 import "node:fs";
 export {
-  t as PublishModeEnum,
+  u as PublishModeEnum,
   e as PublishTagEnum,
   b as PublishVersionTypeEnum,
-  d as SubcommandEnum,
-  h as crateAsSubcommand,
-  l as handler
+  p as SubcommandEnum,
+  t as crateAsSubcommand,
+  d as handler
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-publish",
-  "version": "0.7.11",
+  "version": "0.7.13",
   "description": "项目发布命令行工具",
   "private": false,
   "module": "es/index.mjs",
@@ -41,10 +41,9 @@
   "license": "MIT",
   "sideEffects": false,
   "devDependencies": {
-    "@done-coding/cli-inject": "0.5.18",
+    "@done-coding/cli-inject": "0.5.20",
     "@types/node": "^18.0.0",
     "@types/semver": "^7.5.3",
-    "@types/uuid": "^10.0.0",
     "@types/yargs": "^17.0.28",
     "rimraf": "^6.0.1",
     "typescript": "^5.2.2",
@@ -55,9 +54,8 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@done-coding/cli-utils": "0.7.8",
-    "semver": "^7.5.4",
-    "uuid": "^11.1.0"
+    "@done-coding/cli-utils": "0.8.1",
+    "semver": "^7.5.4"
   },
-  "gitHead": "67d4fc202427c5b2f387b856cfe9507127a5b26c"
+  "gitHead": "0930f800167c04a86b56eae9741872dd51bec0c6"
 }