@done-coding/cli-publish 0.7.12 → 0.7.14-alpha.0

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,5 +1,5 @@
 #!/usr/bin/env node
-import { c as m } from "./index-d28c260e.js";
+import { c as m } from "./index-b589f4ab.js";
 import "@done-coding/cli-utils";
 import "node:child_process";
 import "semver";

package/es/{index-d28c260e.js → index-b589f4ab.js}

@@ -7,7 +7,7 @@ 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.12",
+  version: "0.7.14-alpha.0",
   description: "项目发布命令行工具",
   bin: {
     "dc-publish": "es/cli.mjs"
@@ -55,22 +55,22 @@ const R = {
     m.warn("没有配置别名发布信息");
     return;
   }
-  const { rootDir: d } = e, s = $({ rootDir: d }), { name: a, version: i } = s;
+  const { rootDir: d } = e, s = $({ rootDir: d }), { name: i, version: a } = s;
   return U({
     dir: G(R.cliConfig.moduleName),
     fn: async (n) => {
       var g;
-      S.mkdirSync(n, { recursive: !0 }), l(`pnpm add ${a}@${i}`, {
+      S.mkdirSync(n, { recursive: !0 }), l(`pnpm add ${i}@${a}`, {
         stdio: "inherit",
         cwd: n
       });
-      const h = (g = l(`npm dist-tag ${a}`).toString().trim().split(`
+      const h = (g = l(`npm dist-tag ${i}`).toString().trim().split(`
 `).map((E) => E.split(":").map((w) => w.trim())).find(
-        ([, E]) => E === i
+        ([, E]) => E === a
       )) == null ? void 0 : g[0];
       if (!h)
-        return m.warn(`没有找到 ${a}@${i} 对应的dist-tag`);
-      const C = z.resolve(n, "node_modules", a), u = $({
+        return m.warn(`没有找到 ${i}@${a} 对应的dist-tag`);
+      const C = z.resolve(n, "node_modules", i), u = $({
         rootDir: C
       });
       for (let E of o) {
@@ -125,21 +125,21 @@ const R = {
   type: t,
   distTag: o
 }) => {
-  let d = e.name, s = "", a;
-  const { version: i } = e;
-  if (!i)
+  let d = e.name, s = "", i;
+  const { version: a } = e;
+  if (!a)
     throw new Error("当前版本号为空");
   switch (t) {
     case r.PATCH:
     case r.MINOR:
     case r.MAJOR: {
-      s = N(i, t), a = o || f.LATEST;
+      s = N(a, t), i = o || f.LATEST;
       break;
     }
     case r.PREPATCH:
     case r.PREMINOR:
     case r.PREMAJOR: {
-      s = N(i, t, f.ALPHA), a = o || f.ALPHA;
+      s = N(a, t, f.ALPHA), i = o || f.ALPHA;
       break;
     }
     case r.PRERELEASE: {
@@ -149,7 +149,7 @@ const R = {
         message: "请输入修饰符",
         initial: f.ALPHA
       })).identifier;
-      s = N(i, t, n), a = o || n;
+      s = N(a, t, n), i = o || n;
       break;
     }
     default:
@@ -157,16 +157,16 @@ const R = {
         type: "text",
         name: "customVersion",
         message: "请输入自定义版本号"
-      })).customVersion, a = o || f.LATEST;
+      })).customVersion, i = o || f.LATEST;
   }
   if (!s)
     throw new Error("version is empty");
   return {
     name: d,
     version: s,
-    tag: a
+    tag: i
   };
-}, ie = async ({
+}, ae = async ({
   type: e,
   packageJson: t,
   distTag: o
@@ -192,7 +192,7 @@ const R = {
         type: n,
         distTag: o
       });
-    const a = [
+    const i = [
       ...s.map((n) => ({
         title: `${n} (${d[n].version})`,
         value: n
@@ -204,23 +204,23 @@ const R = {
         title: n,
         value: n
       }))
-    ], i = (await L({
+    ], a = (await L({
       type: "select",
       name: "selectType",
       message: `请选择发布类型，当前版本：${t.version}`,
-      choices: a
+      choices: i
     })).selectType;
-    return s.includes(i) ? d[i] : P({
+    return s.includes(a) ? d[a] : P({
       packageJson: t,
-      type: i,
+      type: a,
       distTag: o
     });
   }
 }, 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({
+  const { mode: t, type: o, push: d, rootDir: s, distTag: i } = e, a = await H(e, () => ({})), n = a[t], A = await W(n), T = $({ rootDir: s }), p = await ae({
     type: o,
     packageJson: T,
-    distTag: a
+    distTag: i
   }), { version: h } = p;
   l(`npm version ${h}`, {
     cwd: s,
@@ -269,8 +269,8 @@ const R = {
     branchName: A.branchName,
     version: p.version,
     remoteInfo: A.remoteInfo
-  }), m.success(`发布成功，版本号：${h}`), t === c.NPM && J(i) && M(e);
-}, ae = {
+  }), m.success(`发布成功，版本号：${h}`), t === c.NPM && J(a) && M(e);
+}, ie = {
   command: "$0",
   describe: "执行发布命令",
   options: re(),
@@ -291,7 +291,7 @@ const R = {
   version: ce,
   subcommands: [
     ne,
-    ae,
+    ie,
     se
   ].map(y),
   demandCommandCount: 1,

package/es/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { d as u, b as e, P as b, S as p, a as t, h as d } from "./index-d28c260e.js";
+import { d as u, b as e, P as b, S as p, a as t, h as d } from "./index-b589f4ab.js";
 import "@done-coding/cli-utils";
 import "node:child_process";
 import "semver";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@done-coding/cli-publish",
-  "version": "0.7.12",
+  "version": "0.7.14-alpha.0",
   "description": "项目发布命令行工具",
   "private": false,
   "module": "es/index.mjs",
@@ -41,12 +41,12 @@
   "license": "MIT",
   "sideEffects": false,
   "devDependencies": {
-    "@done-coding/cli-inject": "0.5.19",
+    "@done-coding/cli-inject": "0.5.21-alpha.0",
     "@types/node": "^18.0.0",
     "@types/semver": "^7.5.3",
     "@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"
   },
@@ -54,8 +54,8 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@done-coding/cli-utils": "0.8.0",
+    "@done-coding/cli-utils": "0.8.2-alpha.0",
     "semver": "^7.5.4"
   },
-  "gitHead": "e68f726aa899f75c4d294b11620f343c953a74c3"
+  "gitHead": "b09dd794f69ba2dafe22a3519d712d059c2eb376"
 }