@vitarx/release-cli 1.0.0 → 1.0.2

package/README.md

@@ -18,6 +18,8 @@
 
 ### 全局安装
 
+安装时使用包名 `@vitarx/release-cli`，安装后使用命令名 `release-cli`：
+
 ```bash
 # 使用 npm
 npm install -g @vitarx/release-cli
@@ -31,6 +33,8 @@ yarn global add @vitarx/release-cli
 
 ### 临时使用 (无需安装)
 
+临时使用时使用包名 `@vitarx/release-cli`：
+
 ```bash
 # 使用 npx
 npx @vitarx/release-cli
@@ -48,41 +52,42 @@ yarn dlx @vitarx/release-cli
 
 ```bash
 # 发布当前包 (自动检测包管理器)
-@vitarx/release-cli # 如果是 workspace 项目，会以对话形式选择要发布的包
+release-cli # 如果是 workspace 项目，会以对话形式选择要发布的包
 
 # 指定包名发布 (workspace 项目)
-@vitarx/release-cli --package <包名>
+release-cli --package my-package #发布包名为my-package的包
+release-cli --package packages/my-package #发布在packages/my-package下的包
 
 # 使用 dry-run 模式测试
-@vitarx/release-cli --dry-run
+release-cli --dry-run
 
 # 指定版本类型
-@vitarx/release-cli patch
-@vitarx/release-cli minor
-@vitarx/release-cli major
+release-cli patch
+release-cli minor
+release-cli major
 # 自定义版本号
-@vitarx/release-cli 1.0.1
+release-cli 1.0.1
 ```
 
 ### 高级用法
 
 ```bash
 # 组合使用选项
-@vitarx/release-cli patch --dry-run --package my-package
-@vitarx/release-cli minor --verbose
+release-cli patch --dry-run --package my-package
+release-cli minor --verbose
 
 # 预发布版本
-@vitarx/release-cli prerelease --preid alpha
-@vitarx/release-cli prerelease --preid beta
-@vitarx/release-cli prerelease --preid rc
+release-cli prerelease --preid alpha
+release-cli prerelease --preid beta
+release-cli prerelease --preid rc
 
 # 从预发布升级到正式版本
-@vitarx/release-cli release
+release-cli release
 
 # changelog 相关选项
-@vitarx/release-cli patch --preset conventionalcommits --infile HISTORY.md
-@vitarx/release-cli minor --no-same-file --output-unreleased
-@vitarx/release-cli major --tag-prefix "" --release-count 5
+release-cli patch --preset conventionalcommits --infile HISTORY.md
+release-cli minor --no-same-file --output-unreleased
+release-cli major --tag-prefix "v" --release-count 5
 ```
 
 ### 支持的版本类型
@@ -101,6 +106,7 @@ yarn dlx @vitarx/release-cli
 
 | 选项                    | 缩写   | 描述                       | 默认值            |
 |-----------------------|------|--------------------------|----------------|
+| `--version`           | `-v` | 显示版本信息                   | -              |
 | `--help`              | `-h` | 显示帮助信息                   | -              |
 | `--dry-run`           | `-d` | 试运行模式，不实际执行操作            | `false`        |
 | `--preid`             | -    | 预发布版本标识符（alpha/beta/rc）  | -              |
@@ -117,19 +123,24 @@ yarn dlx @vitarx/release-cli
 | `--context`           | `-c` | 模板变量上下文文件                | -              |
 | `--commit-path`       | -    | 只生成指定目录的提交日志             | -              |
 | `--tag-prefix`        | -    | Git 标签前缀                 | `v`            |
-| `--verbose`           | `-v` | 详细输出模式                   | `false`        |
+| `--verbose`           | -    | 详细输出模式                   | `false`        |
 | `--release-count`     | -    | 生成的发布记录数量                | `0`            |
-| `--package`           | -    | 指定要发布的包名                 | -              |
+| `--package`           | -    | 指定要发布的包名/包相对路径           | -              |
 
 ### Workspace 支持
 
 如果你的项目是 workspace 项目（包含 `workspaces` 配置），工具会自动检测并让你选择要发布的包。
 
-你可以使用 `--package` 选项直接指定要发布的包名，避免交互式选择：
+你可以使用 `--package` 选项直接指定要发布的包名或目录名，避免交互式选择：
 
 ```bash
-@vitarx/release-cli --package my-package
-@vitarx/release-cli patch --package my-package --dry-run
+# 按包名指定
+release-cli --package my-package
+release-cli patch --package my-package --dry-run
+
+# 按目录名指定（workspace项目）
+release-cli --package lib
+release-cli --package app
 ```
 
 ## 发布流程

package/dist/release.js

@@ -15,6 +15,7 @@ function parseArgs() {
     const result = {
         isDryRun: false, // 是否为试运行模式
         showHelp: false, // 是否显示帮助信息
+        showVersion: false, // 是否显示版本信息
         changelogPreset: 'angular', // 更改日志预设模板
         changelogInfile: 'CHANGELOG.md', // 更改日志输入文件
         changelogSameFile: true, // 是否使用同一文件
@@ -27,6 +28,9 @@ function parseArgs() {
         if (arg === '--help' || arg === '-h') {
             result.showHelp = true;
         }
+        else if (arg === '--version' || arg === '-v') {
+            result.showVersion = true;
+        }
         else if (arg === '--dry-run' || arg === '-d') {
             result.isDryRun = true;
         }
@@ -75,7 +79,7 @@ function parseArgs() {
         else if (arg === '--tag-prefix' && args[i + 1]) {
             result.changelogTagPrefix = args[++i];
         }
-        else if (arg === '--verbose' || arg === '-v') {
+        else if (arg === '--verbose') {
             result.changelogVerbose = true;
         }
         else if (arg === '--package' && args[i + 1]) {
@@ -133,14 +137,17 @@ async function publishPackage(pkgDir, packageManager, isDryRun = false, args) {
         runCommand(`npm run build --prefix ${pkgDir}`);
         // -------------------- Step 5: 生成日志 --------------------
         // 是否为根包
-        const isRootPackage = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8')).name === pkg.name;
+        const isRootPackage = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8')).name ===
+            pkg.name;
         if (isRootPackage) {
             // 生成 changelog
             try {
                 log.info(`📝 正在生成 CHANGELOG.md...`);
                 const changelogArgs = [
-                    '-p', args.changelogPreset || 'angular',
-                    '-i', args.changelogInfile || 'CHANGELOG.md',
+                    '-p',
+                    args.changelogPreset || 'angular',
+                    '-i',
+                    args.changelogInfile || 'CHANGELOG.md',
                     args.changelogOutfile ? ['-o', args.changelogOutfile] : '',
                     args.changelogSameFile ? '-s' : '',
                     args.changelogAppend ? '-a' : '',
@@ -152,8 +159,11 @@ async function publishPackage(pkgDir, packageManager, isDryRun = false, args) {
                     args.changelogCommitPath ? ['--commit-path', args.changelogCommitPath] : '',
                     args.changelogTagPrefix ? ['-t', args.changelogTagPrefix] : '',
                     args.changelogVerbose ? '-v' : '',
-                    '-r', args.changelogReleaseCount ? args.changelogReleaseCount.toString() : '0'
-                ].flat().filter(arg => arg !== '');
+                    '-r',
+                    args.changelogReleaseCount ? args.changelogReleaseCount.toString() : '0'
+                ]
+                    .flat()
+                    .filter((arg) => arg !== '');
                 runCommand(`conventional-changelog ${changelogArgs.join(' ')}`, isDryRun);
             }
             catch {
@@ -209,8 +219,14 @@ async function publishPackage(pkgDir, packageManager, isDryRun = false, args) {
  */
 export async function main() {
     const args = parseArgs();
+    // 显示版本信息
+    if (args.showVersion) {
+        const { version } = JSON.parse(fs.readFileSync(path.join(path.dirname(path.dirname(import.meta.url)), 'package.json'), 'utf-8'));
+        log.info('release-cli v' + version);
+        process.exit(0);
+    }
+    console.log(chalk.cyan('📦 Release CLI - NPM包发布工具'));
     if (args.showHelp) {
-        console.log(chalk.cyan('📦 Release CLI - NPM包发布工具'));
         console.log('');
         console.log(chalk.yellow('使用方法:'));
         console.log('  release-cli [版本类型] [选项]');
@@ -228,6 +244,7 @@ export async function main() {
         console.log('');
         console.log(chalk.yellow('选项:'));
         console.log('  -h, --help              - 显示帮助信息');
+        console.log('  -v, --version           - 输出版本号');
         console.log('  -d, --dry-run           - 试运行模式，不实际执行操作，（默认false）');
         console.log('  --preid <标识符>         - 预发布版本标识符（alpha/beta/rc）');
         console.log('  --preset <预设>          - conventional-changelog预设（默认: angular）');
@@ -243,9 +260,9 @@ export async function main() {
         console.log('  -c, --context <文件>     - 模板变量上下文文件');
         console.log('  --commit-path <目录>      - 只生成指定目录的提交日志');
         console.log('  --tag-prefix <前缀>      - Git 标签前缀（默认: v）');
-        console.log('  -v, --verbose           - 详细输出模式');
+        console.log('  --verbose           - 详细输出模式');
         console.log('  --release-count <数量>   - 生成的发布记录数量（默认: 0）');
-        console.log('  --package <包名>         - 指定要发布的包名');
+        console.log('  --package <包名>         - 指定要发布的包名/包相对路径');
         console.log('');
         console.log(chalk.yellow('示例:'));
         console.log('  release-cli patch --dry-run');
@@ -261,9 +278,9 @@ export async function main() {
     }
     const packageManager = detectPackageManager();
     const isWorkspace = isWorkspaceProject();
-    log.info(`当前包管理器: ${packageManager}`);
-    log.info(`当前工作目录: ${process.cwd()}`);
-    log.info(`当前运行模式: ${isDryRun ? 'dry-run' : 'publish'}`);
+    log.info('当前包管理器', packageManager);
+    log.info('当前工作目录', process.cwd());
+    log.info('当前运行模式', isDryRun ? 'dry-run' : 'publish');
     if (isWorkspace) {
         log.info('检测到 workspace 项目');
         const packages = getWorkspacePackages();
@@ -273,8 +290,11 @@ export async function main() {
         }
         let selectedPackage;
         if (args.packageName) {
-            // 如果指定了包名，查找对应的包
-            selectedPackage = packages.find(pkg => pkg.name === args.packageName);
+            // 如果指定了包名，查找对应的包（支持按包名或目录名匹配）
+            selectedPackage = packages.find((pkg) => {
+                console.log(`正在匹配 ${path.basename(pkg.path)}`);
+                return pkg.name === args.packageName || path.basename(pkg.path) === args.packageName;
+            });
             if (!selectedPackage) {
                 log.error(`未找到包名为 ${args.packageName} 的包`);
                 process.exit(1);

package/dist/type.d.ts

@@ -59,4 +59,6 @@ export interface ReleaseConfig {
     changelogVerbose?: boolean;
     /** 是否显示帮助信息 */
     showHelp: boolean;
+    /** 是否显示版本信息 */
+    showVersion: boolean;
 }

package/dist/utils.d.ts

@@ -20,7 +20,7 @@ export declare function checkGitStatus(): boolean;
  * @property warn - 警告日志
  */
 export declare const log: {
-    readonly info: (message: string) => void;
+    readonly info: (message: string, ...text: string[]) => void;
     readonly success: (message: string) => void;
     readonly error: (message: string) => void;
     readonly warn: (message: string) => void;

package/dist/utils.js

@@ -49,17 +49,22 @@ export function checkGitStatus() {
  * @property warn - 警告日志
  */
 export const log = {
-    info: (message) => {
-        console.log(chalk.cyan(`Info：${message}`));
+    info: (message, ...text) => {
+        if (text.length) {
+            console.log(chalk.cyan(`📢 ${message}: `), ...text);
+        }
+        else {
+            console.log(`📢 ${message}`);
+        }
     },
     success: (message) => {
-        console.log(chalk.green(`Success：✅ ${message}`));
+        console.log(chalk.green(`✅ ${message}`));
     },
     error: (message) => {
-        console.log(chalk.red(`Error：❌ ${message}`));
+        console.log(chalk.red(`❌ ${message}`));
     },
     warn: (message) => {
-        console.log(chalk.yellow(`Warn：⚠️ ${message}`));
+        console.log(chalk.yellow(`⚠️ ${message}`));
     }
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vitarx/release-cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A CLI tool for automated npm package release with workspace support",
   "main": "dist/index.js",
   "type": "module",