@varlet/release 2.1.1 → 2.2.0

package/README.md

@@ -20,12 +20,36 @@
 
 > `Varlet Release` requires `Node.js` ^20.19.0 || >=22.12.0 and `esm` only.
 
-## Installation
+## Quick Start
+
+Install dependencies:
 
 ```shell
-pnpm add @varlet/release -D
+pnpm add @varlet/release simple-git-hooks -D
 ```
 
+Add the following configuration to `package.json`:
+
+```json
+{
+  "scripts": {
+    "prepare": "simple-git-hooks",
+    "release": "vr release",
+    "changelog": "vr changelog"
+  },
+  "simple-git-hooks": {
+    "commit-msg": "pnpm exec vr commit-lint $1",
+    "post-merge": "pnpm exec vr lockfile-check --install"
+  }
+}
+```
+
+Now you can:
+
+- Write commits following the [Conventional Commits](https://www.conventionalcommits.org/) format, `commit-lint` will automatically validate them.
+- After pulling or merging code, `lockfile-check` will automatically detect lockfile changes (`pnpm-lock.yaml`, `yarn.lock`, `package-lock.json`) and reinstall dependencies.
+- Run `pnpm release` to start the interactive release workflow.
+
 ## Usage
 
 ### Features Overview
@@ -61,29 +85,29 @@ _Flags Reference_:
 Usage: vr release [flags...]
 
 Flags:
-  -r, --remote <string>             Remote repository name
-  -s, --skip-npm-publish            Skip npm publish
-      --skip-changelog              Skip generating changelog
-      --skip-git-tag                Skip git tag
-  -t, --npm-tag <string>            npm tag
-  -c, --check-remote-version        Check remote version
+      --remote string                 Remote repository name  # default: 'origin'
+      --skip-npm-publish              Skip npm publish
+      --skip-changelog                Skip generating changelog
+      --skip-git-tag                  Skip git tag
+      --npm-tag string                npm tag
+      --check-remote-version          Check remote version
 ```
 
 _Example_:
 
 ```shell
 # Release all packages and execute the full workflow
-npx vr release
-
-# Specify remote repository name (default origin)
-npx vr release -r origin
+pnpm exec vr release
 
 # Skip npm publishing
-npx vr release -s
+pnpm exec vr release --skip-npm-publish
 # Skip generating changelog
-npx vr release --skip-changelog
+pnpm exec vr release --skip-changelog
 # Check remote version, interrupt execution if the identical version already exists
-npx vr release -c
+pnpm exec vr release --check-remote-version
+
+# Specify the git remote name for pushing tags (useful when multiple remotes are configured, e.g. upstream, fork)
+pnpm exec vr release --remote upstream
 ```
 
 **Node API**:
@@ -134,20 +158,20 @@ _Flags Reference_:
 Usage: vr publish [flags...]
 
 Flags:
-  -c, --check-remote-version        Check remote version
-  -t, --npm-tag <string>            npm tag
+      --check-remote-version          Check remote version
+      --npm-tag string                npm tag
 ```
 
 _Example_:
 
 ```shell
 # Publish directly to npm
-npx vr publish
+pnpm exec vr publish
 
 # Check if the same version already exists due to network or other reasons, and abort if so
-npx vr publish -c
+pnpm exec vr publish --check-remote-version
 # Specify the npm dist-tag
-npx vr publish -t alpha
+pnpm exec vr publish --npm-tag alpha
 ```
 
 **Node API**:
@@ -181,20 +205,20 @@ _Flags Reference_:
 Usage: vr changelog [flags...]
 
 Flags:
-  -c, --release-count <number>      Release count, default 0
-  -f, --file <string>               Changelog filename
+      --release-count number          Release count  # default: 0
+      --file string                   Changelog filename  # default: 'CHANGELOG.md'
 ```
 
 _Example_:
 
 ```shell
 # Generate changelogs for all history and output as CHANGELOG.md in the current directory
-npx vr changelog
+pnpm exec vr changelog
 
 # Specify the generated changelog filename
-npx vr changelog -f my-changelog.md
+pnpm exec vr changelog --file my-changelog.md
 # Limit the range of release versions to generate changelogs for (0 means all)
-npx vr changelog -c 0
+pnpm exec vr changelog --release-count 0
 ```
 
 **Node API**:
@@ -224,26 +248,28 @@ changelog({
 
 **CLI Commands**:
 
-_Flags Reference_:
+_Parameters Reference_:
 
 ```text
-Usage: vr commit-lint [flags...]
+Usage: vr commit-lint <commit-message-path> [flags...]
+
+Parameters:
+  <commit-message-path>             Git commit message path (required)
 
 Flags:
-  -p, --commit-message-path <string>  Git commit message path
-  -r, --commit-message-re <string>    Validate the regex for commit message
-  -e, --error-message <string>        Error message displayed on validation failure
-  -w, --warning-message <string>      Warning message displayed on validation failure
+      --commit-message-re string      Validate the regex for commit message
+      --error-message string          Error message displayed on validation failure
+      --warning-message string        Warning message displayed on validation failure
 ```
 
 _Example_:
 
 ```shell
 # Check if the commit message at the given path is standard
-npx vr commit-lint -p .git/COMMIT_EDITMSG
+pnpm exec vr commit-lint .git/COMMIT_EDITMSG
 
 # Customize regex validation and prompt message
-npx vr commit-lint -p .git/COMMIT_EDITMSG -r "^feat: .*" -e "Commit validation failed"
+pnpm exec vr commit-lint .git/COMMIT_EDITMSG --commit-message-re "^feat: .*" --error-message "Commit validation failed"
 ```
 
 _It is recommended to integrate with `simple-git-hooks` or `husky` in `package.json`:_
@@ -251,7 +277,7 @@ _It is recommended to integrate with `simple-git-hooks` or `husky` in `package.j
 ```json
 {
   "simple-git-hooks": {
-    "commit-msg": "npx vr commit-lint -p $1"
+    "commit-msg": "pnpm exec vr commit-lint $1"
   }
 }
 ```
@@ -273,11 +299,11 @@ commitLint({
 
 ### lockfile-check
 
-**Description**: Detect and visually output in the console whether the lockfile of frontend dependencies has been modified.
+**Description**: Detect and visually output in the console whether the lockfile of frontend dependencies has been modified, and automatically install dependencies by default to keep in sync.
 
-**Use cases**: Recommended to use after Git operations such as pulling updates (`git pull`), switching branches (`git checkout`), or merging code. It helps detect if upstream dependency lockfiles (like `pnpm-lock.yaml`) have changed. If a change is detected, you can invoke a package manager's installation command through specific options to synchronize the local environment with upstream instantly, preventing obscure bugs caused by outdated dependencies.
+**Use cases**: Recommended to use after Git operations such as pulling updates (`git pull`), switching branches (`git checkout`), or merging code. It helps detect if upstream dependency lockfiles (like `pnpm-lock.yaml`) have changed. If a change is detected, it will automatically invoke a package manager's installation command to synchronize the local environment with upstream instantly, preventing obscure bugs caused by outdated dependencies.
 
-**Core Workflow**: Execute a Git diff comparing the project's lockfile (e.g. `pnpm-lock.yaml` or corresponding environment lockfile) from the original HEAD. Print its modification status in the console. Furthermore, trigger the package manager to reinstall dependencies to sync with upstream if directed by the command options.
+**Core Workflow**: Execute a Git diff comparing the project's lockfile (e.g. `pnpm-lock.yaml` or corresponding environment lockfile) from the original HEAD. Print its modification status in the console. Furthermore, trigger the package manager to reinstall dependencies to sync with upstream by default, or skip installation if directed by the command options.
 
 **CLI Commands**:
 
@@ -287,21 +313,21 @@ _Flags Reference_:
 Usage: vr lockfile-check [flags...]
 
 Flags:
-  -m, --package-manager <string>    Package manager (npm, yarn, pnpm), default pnpm
-  -i, --install                     Auto install dependencies if lockfile changed
+      --package-manager string        Package manager (npm, yarn, pnpm)  # default: 'pnpm'
+      --skip-install                  Skip install dependencies when lockfile changed
 ```
 
 _Example_:
 
 ```shell
-# Check the synchronization status of the current lockfile
-npx vr lockfile-check
+# Check the synchronization status of the current lockfile and install dependencies if changed
+pnpm exec vr lockfile-check
 
-# Check current status, forcefully run installation to sync dependencies if updates exist
-npx vr lockfile-check -i
+# Check current status but skip installation even if updates exist
+pnpm exec vr lockfile-check --skip-install
 
-# Specify other package managers for checking (defaults to pnpm)
-npx vr lockfile-check -m npm
+# Specify other package managers for checking
+pnpm exec vr lockfile-check --package-manager npm
 ```
 
 _It is also recommended to integrate with `simple-git-hooks` or `husky` in `package.json` (e.g. trigger checks and installations automatically during the `post-merge` or `post-checkout` hooks):_
@@ -309,7 +335,7 @@ _It is also recommended to integrate with `simple-git-hooks` or `husky` in `pack
 ```json
 {
   "simple-git-hooks": {
-    "post-merge": "npx vr lockfile-check -i"
+    "post-merge": "pnpm exec vr lockfile-check"
   }
 }
 ```
@@ -321,7 +347,7 @@ import { lockfileCheck } from '@varlet/release'
 
 lockfileCheck({
   packageManager?: 'npm' | 'yarn' | 'pnpm' // Choose package manager, defaults to 'pnpm'
-  install?: boolean                        // Whether to automatically run install if lockfile is out of sync
+  skipInstall?: boolean                    // Whether to skip installation if lockfile is out of sync
 })
 ```
 

package/README.zh-CN.md

@@ -20,12 +20,36 @@
 
 > `Varlet Release` 需要 `Node.js` ^20.19.0 || >=22.12.0，并且仅支持 `esm`。
 
-## 安装
+## 快速开始
+
+安装依赖：
 
 ```shell
-pnpm add @varlet/release -D
+pnpm add @varlet/release simple-git-hooks -D
 ```
 
+在 `package.json` 中添加以下配置：
+
+```json
+{
+  "scripts": {
+    "prepare": "simple-git-hooks",
+    "release": "vr release",
+    "changelog": "vr changelog"
+  },
+  "simple-git-hooks": {
+    "commit-msg": "pnpm exec vr commit-lint $1",
+    "post-merge": "pnpm exec vr lockfile-check --install"
+  }
+}
+```
+
+现在你可以：
+
+- 按照 [Conventional Commits](https://www.conventionalcommits.org/) 规范编写提交信息，`commit-lint` 会自动校验。
+- 拉取或合并代码后，`lockfile-check` 会自动检测 lockfile 变化（`pnpm-lock.yaml`、`yarn.lock`、`package-lock.json`）并重新安装依赖。
+- 运行 `pnpm release` 启动交互式发布流程。
+
 ## 使用
 
 ### 功能概览
@@ -61,29 +85,29 @@ _标志参考_：
 用法: vr release [标志...]
 
 标志:
-  -r, --remote <string>             远程仓库名称
-  -s, --skip-npm-publish            跳过 npm 发布
-      --skip-changelog              跳过生成变更日志
-      --skip-git-tag                跳过 git tag
-  -t, --npm-tag <string>            npm tag
-  -c, --check-remote-version        检查远程版本
+      --remote string                 远程仓库名称  # 默认: 'origin'
+      --skip-npm-publish              跳过 npm 发布
+      --skip-changelog                跳过生成变更日志
+      --skip-git-tag                  跳过 git tag
+      --npm-tag string                npm tag
+      --check-remote-version          检查远程版本
 ```
 
 _使用示例_：
 
 ```shell
 # 发布所有包并执行完整工作流程
-npx vr release
-
-# 指定远程仓库名称 (默认 origin)
-npx vr release -r origin
+pnpm exec vr release
 
 # 跳过 npm 发布
-npx vr release -s
+pnpm exec vr release --skip-npm-publish
 # 跳过生成变更日志
-npx vr release --skip-changelog
+pnpm exec vr release --skip-changelog
 # 检查远程版本，若已存在相同版本则中断执行
-npx vr release -c
+pnpm exec vr release --check-remote-version
+
+# 指定推送 tag 的 git remote 名称（适用于配置了多个 remote 的场景，如 upstream、fork 等）
+pnpm exec vr release --remote upstream
 ```
 
 **Node 调用**：
@@ -134,20 +158,20 @@ _标志参考_：
 用法: vr publish [标志...]
 
 标志:
-  -c, --check-remote-version        检查远程版本
-  -t, --npm-tag <string>            npm tag
+      --check-remote-version          检查远程版本
+      --npm-tag string                npm tag
 ```
 
 _使用示例_：
 
 ```shell
 # 直接发布到 npm
-npx vr publish
+pnpm exec vr publish
 
 # 检查由于网络等原因是否已存在相同版本，存在则放弃发布
-npx vr publish -c
+pnpm exec vr publish --check-remote-version
 # 指定 npm 的 dist-tag
-npx vr publish -t alpha
+pnpm exec vr publish --npm-tag alpha
 ```
 
 **Node 调用**：
@@ -181,20 +205,20 @@ _标志参考_：
 用法: vr changelog [标志...]
 
 标志:
-  -c, --release-count <number>      发布数量，默认 0
-  -f, --file <string>               变更日志文件名
+      --release-count number          发布数量  # 默认: 0
+      --file string                   变更日志文件名  # 默认: 'CHANGELOG.md'
 ```
 
 _使用示例_：
 
 ```shell
 # 生成所有历史的变更日志并在当前目录输出为 CHANGELOG.md
-npx vr changelog
+pnpm exec vr changelog
 
 # 指定生成的变更日志文件名
-npx vr changelog -f my-changelog.md
+pnpm exec vr changelog --file my-changelog.md
 # 限定发布版本的范围数量以生成变更日志 (0 为全量)
-npx vr changelog -c 0
+pnpm exec vr changelog --release-count 0
 ```
 
 **Node 调用**：
@@ -224,26 +248,28 @@ changelog({
 
 **CMD 命令**：
 
-_标志参考_：
+_参数参考_：
 
 ```text
-用法: vr commit-lint [标志...]
+用法: vr commit-lint <commit-message-path> [标志...]
+
+参数:
+  <commit-message-path>             Git commit message 路径（必填）
 
 标志:
-  -p, --commit-message-path <string>  Git commit message 路径
-  -r, --commit-message-re <string>    验证 commit message 是否通过的正则表达式
-  -e, --error-message <string>        验证失败时显示的错误信息
-  -w, --warning-message <string>      验证失败时显示的警告信息
+      --commit-message-re string      验证 commit message 是否通过的正则表达式
+      --error-message string          验证失败时显示的错误信息
+      --warning-message string        验证失败时显示的警告信息
 ```
 
 _使用示例_：
 
 ```shell
 # 检测指路径的 commit message 是否符合规范
-npx vr commit-lint -p .git/COMMIT_EDITMSG
+pnpm exec vr commit-lint .git/COMMIT_EDITMSG
 
 # 定制指定的校验正则表达式和提示信息
-npx vr commit-lint -p .git/COMMIT_EDITMSG -r "^feat: .*" -e "提交校验失败"
+pnpm exec vr commit-lint .git/COMMIT_EDITMSG --commit-message-re "^feat: .*" --error-message "提交校验失败"
 ```
 
 _建议配合并在 `package.json` 中的 `simple-git-hooks` 或 `husky` 一同集成运作：_
@@ -251,7 +277,7 @@ _建议配合并在 `package.json` 中的 `simple-git-hooks` 或 `husky` 一同
 ```json
 {
   "simple-git-hooks": {
-    "commit-msg": "npx vr commit-lint -p $1"
+    "commit-msg": "pnpm exec vr commit-lint $1"
   }
 }
 ```
@@ -273,11 +299,11 @@ commitLint({
 
 ### lockfile-check
 
-**作用**：检测并在控制台直观地输出前端依赖包的 lockfile 文件是否发生变更。
+**作用**：检测并在控制台直观地输出前端依赖包的 lockfile 文件是否发生变更，并默认自动安装依赖以保持同步。
 
-**使用场景**：通常在进行 `git 操作` (如 `git pull`拉取最新代码、`git checkout`切换分支、或合并代码) 之后使用。它能帮助你检测上游的依赖锁文件（如 `pnpm-lock.yaml`）是否发生了变动。如果检测到有变更，可以通过可选操作直接执行 install 安装命令，从而确保本地环境快速与上游依赖保持一致，避免因依赖版本陈旧导致的疑难 bug。
+**使用场景**：通常在进行 `git 操作` (如 `git pull`拉取最新代码、`git checkout`切换分支、或合并代码) 之后使用。它能帮助你检测上游的依赖锁文件（如 `pnpm-lock.yaml`）是否发生了变动。如果检测到有变更，默认会自动执行 install 安装命令，从而确保本地环境快速与上游依赖保持一致，避免因依赖版本陈旧导致的疑难 bug。
 
-**核心流程**：比对项目原始游标的锁文件（如 pnpm-lock.yaml 或对应环境的 lockfile）的 Git diff，在控制台输出其是否存在变动；并根据指令决定是否随后触发包管理器的依赖重装程序以同步上游。
+**核心流程**：比对项目原始游标的锁文件（如 pnpm-lock.yaml 或对应环境的 lockfile）的 Git diff，在控制台输出其是否存在变动；默认会触发包管理器的依赖重装程序以同步上游，也可以通过指令跳过安装。
 
 **CMD 命令**：
 
@@ -287,21 +313,21 @@ _标志参考_：
 用法: vr lockfile-check [标志...]
 
 标志:
-  -m, --package-manager <string>    包管理器 (npm, yarn, pnpm)，默认 pnpm
-  -i, --install                     如果 lockfile 发生变化则自动安装依赖
+      --package-manager string        包管理器 (npm, yarn, pnpm)  # 默认: 'pnpm'
+      --skip-install                  当 lockfile 发生变化时跳过安装依赖
 ```
 
 _使用示例_：
 
 ```shell
-# 检查当前 lockfile 的同步状态
-npx vr lockfile-check
+# 检查当前 lockfile 的同步状态，若有变化则自动安装依赖
+pnpm exec vr lockfile-check
 
-# 检查当前状态，若存在更新则强制运行安装命令同步依赖
-npx vr lockfile-check -i
+# 检查当前状态，即使有更新也跳过安装
+pnpm exec vr lockfile-check --skip-install
 
-# 指定其他包管理器进行检查（默认使用 pnpm）
-npx vr lockfile-check -m npm
+# 指定其他包管理器进行检查
+pnpm exec vr lockfile-check --package-manager npm
 ```
 
 _建议配合并在 `package.json` 中的 `simple-git-hooks` 或 `husky` 一同集成运作（例如在拉取代码的 `post-merge` 或 `post-checkout` 阶段自动触发检查与安装）：_
@@ -309,7 +335,7 @@ _建议配合并在 `package.json` 中的 `simple-git-hooks` 或 `husky` 一同
 ```json
 {
   "simple-git-hooks": {
-    "post-merge": "npx vr lockfile-check -i"
+    "post-merge": "pnpm exec vr lockfile-check"
   }
 }
 ```
@@ -321,7 +347,7 @@ import { lockfileCheck } from '@varlet/release'
 
 lockfileCheck({
   packageManager?: 'npm' | 'yarn' | 'pnpm' // 选择包管理器，默认为 'pnpm'
-  install?: boolean                        // 检测到 lock 不同步时是否自动运行对应的 install 重新安装
+  skipInstall?: boolean                    // 检测到 lock 不同步时是否跳过安装
 })
 ```
 

package/dist/cli.js

@@ -1,11 +1,11 @@
 #!/usr/bin/env node
-import { c as release, i as lockfileCheck, p as commitLint, s as publish, u as changelog } from "./src-DJEBh4nv.js";
+import { c as release, i as lockfileCheck, p as commitLint, s as publish, u as changelog } from "./src-JMmGEAWu.js";
 import { cli, command } from "cleye";
 //#endregion
 //#region src/cli.ts
 cli({
 	name: "vr",
-	version: "2.1.1",
+	version: "2.2.0",
 	commands: [
 		command({
 			name: "release",
@@ -76,13 +76,8 @@ cli({
 		}, (argv) => changelog(argv.flags)),
 		command({
 			name: "commit-lint",
+			parameters: ["<commitMessagePath>"],
 			flags: {
-				commitMessagePath: {
-					type: String,
-					alias: "p",
-					default: "",
-					description: "Git commit message path"
-				},
 				commitMessageRe: {
 					type: String,
 					alias: "r",
@@ -100,7 +95,12 @@ cli({
 				}
 			},
 			help: { description: "Lint commit message" }
-		}, (argv) => commitLint(argv.flags)),
+		}, (argv) => commitLint({
+			commitMessagePath: argv._.commitMessagePath,
+			commitMessageRe: argv.flags.commitMessageRe,
+			errorMessage: argv.flags.errorMessage,
+			warningMessage: argv.flags.warningMessage
+		})),
 		command({
 			name: "lockfile-check",
 			flags: {
@@ -110,10 +110,10 @@ cli({
 					default: "pnpm",
 					description: "Package manager (npm, yarn, pnpm), default pnpm"
 				},
-				install: {
+				skipInstall: {
 					type: Boolean,
-					alias: "i",
-					description: "Auto install dependencies if lockfile changed"
+					alias: "s",
+					description: "Skip install dependencies when lockfile changed"
 				}
 			},
 			help: { description: "Check if lockfile has been updated and optionally install dependencies" }

package/dist/index.d.ts

@@ -84,7 +84,7 @@ declare function commitLint(options: CommitLintCommandOptions): void;
 type PackageManager = "npm" | "yarn" | "pnpm";
 interface LockfileCheckOptions {
   packageManager?: PackageManager;
-  install?: boolean;
+  skipInstall?: boolean;
 }
 declare function getLockfilePath(packageManager: PackageManager): string;
 declare function checkLockfileSync(packageManager: PackageManager): Promise<boolean>;

package/dist/index.js

@@ -1,2 +1,2 @@
-import { a as getPackageJsons, c as release, d as COMMIT_HEADER_RE, f as COMMIT_MESSAGE_RE, h as isVersionCommitMessage, i as lockfileCheck, l as updateVersion, m as getCommitMessage, n as getLockfilePath, o as isSameVersion, p as commitLint, r as installDependencies, s as publish, t as checkLockfileSync, u as changelog } from "./src-DJEBh4nv.js";
+import { a as getPackageJsons, c as release, d as COMMIT_HEADER_RE, f as COMMIT_MESSAGE_RE, h as isVersionCommitMessage, i as lockfileCheck, l as updateVersion, m as getCommitMessage, n as getLockfilePath, o as isSameVersion, p as commitLint, r as installDependencies, s as publish, t as checkLockfileSync, u as changelog } from "./src-JMmGEAWu.js";
 export { COMMIT_HEADER_RE, COMMIT_MESSAGE_RE, changelog, checkLockfileSync, commitLint, getCommitMessage, getLockfilePath, getPackageJsons, installDependencies, isSameVersion, isVersionCommitMessage, lockfileCheck, publish, release, updateVersion };

package/dist/{src-DJEBh4nv.js → src-JMmGEAWu.js}

@@ -458,7 +458,7 @@ async function installDependencies(packageManager) {
 async function lockfileCheck(options = {}) {
 	try {
 		const pkgManager = options.packageManager || "pnpm";
-		const installFlag = options.install || false;
+		const skipInstallFlag = options.skipInstall || false;
 		if (![
 			"npm",
 			"yarn",
@@ -469,7 +469,7 @@ async function lockfileCheck(options = {}) {
 		}
 		if (await checkLockfileSync(pkgManager)) {
 			logger.warn("Lockfile has been updated!");
-			if (installFlag) await installDependencies(pkgManager);
+			if (!skipInstallFlag) await installDependencies(pkgManager);
 		}
 	} catch (error) {
 		logger.error("Error checking lockfile sync:", error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/release",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "publish all packages, generate changelogs and check commit messages",
   "keywords": [
     "changelog",