feat: add remote version check to release

Author: a145789

README.md

@@ -11,24 +11,10 @@
 
 ## Intro
 
-`Varlet Release` is a tool to release all packages, generate changelogs and lint commit message.
+`Varlet Release` is a tool used for publishing all packages, generating change logs, and checking `commit messages`, relying on `pnpm`.
 
 ## Installation
 
-### npm
-
-```shell
-npm i @varlet/release -D
-```
-
-### yarn
-
-```shell
-yarn add @varlet/release -D
-```
-
-### pnpm
-
 ```shell
 pnpm add @varlet/release -D
 ```
@@ -65,13 +51,14 @@ npx vr publish
 
 #### release
 
-| Params                 | Instructions        |
-| ---------------------- | ------------------- |
-| -r --remote \<remote\> | Specify remote name |
-| -s --skip-npm-publish  | Skip npm publish    |
-| -sc --skip-changelog    | Skip generate changelog    |
-| -sgt --skip-git-tag    | Skip git tag        |
-| -nt --npm-tag \<npmTag\>   | npm tag        |
+| Params                    | Instructions                                                                                                              |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
+| -r --remote \<remote\>    | Specify remote name                                                                                                       |
+| -s --skip-npm-publish     | Skip npm publish                                                                                                          |
+| -c --check-remote-version | Check if the remote version of the npm package is the same as the one you want to publish locally, if so, stop execution. |
+| -sc --skip-changelog      | Skip generate changelog                                                                                                   |
+| -sgt --skip-git-tag       | Skip git tag                                                                                                              |
+| -nt --npm-tag \<npmTag\>  | npm tag                                                                                                                   |
 
 #### changelog
 
@@ -91,10 +78,10 @@ npx vr publish
 
 #### publish
 
-| Params                      | Instructions                                                                                                                                             |
+| Params                    | Instructions                                                                                                                                     |
 | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
 | -c --check-remote-version | Detects whether the remote version of the npm package is the same as the package version to be published locally, and if it is, skip the release |
-| -nt --npm-tag \<npmTag\>   | npm tag        |
+| -nt --npm-tag \<npmTag\>  | npm tag                                                                                                                                          |
 
 ### Custom Handle
 

README.zh-CN.md

@@ -11,24 +11,10 @@
 
 ## 介绍
 
-`Varlet Release` 是一个用于发布所有包、生成变更日志和检测 `commit message` 的工具。
+`Varlet Release` 是一个用于发布所有包、生成变更日志和检测 `commit message` 的工具，依赖于 `pnpm`。
 
 ## 安装
 
-### npm
-
-```shell
-npm i @varlet/release -D
-```
-
-### yarn
-
-```shell
-yarn add @varlet/release -D
-```
-
-### pnpm
-
 ```shell
 pnpm add @varlet/release -D
 ```
@@ -65,13 +51,14 @@ npx vr publish
 
 #### release
 
-| 参数                   | 说明             |
-| ---------------------- | ---------------- |
-| -r --remote \<remote\> | 指定远程仓库名称 |
-| -s --skip-npm-publish  | 跳过 npm 发布    |
-| -sc --skip-changelog    | 跳过生成变更日志     |
-| -sgt --skip-git-tag    | 跳过 git tag     |
-| -nt --npm-tag \<npmTag\>   | npm tag        |
+| 参数                      | 说明                                                                    |
+| ------------------------- | ----------------------------------------------------------------------- |
+| -r --remote \<remote\>    | 指定远程仓库名称                                                        |
+| -s --skip-npm-publish     | 跳过 npm 发布                                                           |
+| -c --check-remote-version | 检测 npm 包的远程版本是否与要在本地发布的包版本相同，如果是，则停止执行 |
+| -sc --skip-changelog      | 跳过生成变更日志                                                        |
+| -sgt --skip-git-tag       | 跳过 git tag                                                            |
+| -nt --npm-tag \<npmTag\>  | npm tag                                                                 |
 
 #### changelog
 
@@ -94,7 +81,7 @@ npx vr publish
 | 参数                      | 说明                                                                  |
 | ------------------------- | --------------------------------------------------------------------- |
 | -c --check-remote-version | 检测npm包的远程版本是否与要在本地发布的包版本相同，如果是，则跳过发布 |
-| -nt --npm-tag \<npmTag\>   | npm tag        |
+| -nt --npm-tag \<npmTag\>  | npm tag                                                               |
 
 ### 自定义处理
 

bin/index.js

@@ -11,6 +11,7 @@ program
   .option('-sc --skip-changelog', 'Skip generate changelog')
   .option('-sgt --skip-git-tag', 'Skip git tag')
   .option('-nt --npm-tag <npmTag>', 'Npm tag')
+  .option('-c --check-remote-version', 'Check remote version')
   .description('Release all packages and generate changelogs')
   .action(async (options) => release(options))
 

package.json

@@ -34,7 +34,7 @@
   "scripts": {
     "dev": "tsup --watch",
     "build": "tsup",
-    "release": "pnpm build && node bin/index.js release",
+    "release": "pnpm build && node bin/index.js release -c",
     "lint": "eslint --ext .ts,.js",
     "commit-lint": "node bin/index.js commit-lint"
   },
@@ -76,4 +76,4 @@
     "picocolors": "^1.0.0",
     "semver": "^7.5.4"
   }
-}
+}

src/release.ts

@@ -21,6 +21,27 @@ async function isWorktreeEmpty() {
   return !ret.stdout
 }
 
+export async function isSameVersion(version?: string) {
+  const s = createSpinner('Check remote version...').start()
+
+  const packageJsones = getPackageJsons()
+  const packageJson = packageJsones.find((packageJson) => !packageJson.config.private) || packageJsones[0]
+  if (packageJson) {
+    const { config } = packageJson
+    try {
+      await execa('npm', ['view', `${config.name}@${version ?? config.version}`, 'version'])
+
+      s.warn({
+        text: `The npm package has a same remote version ${config.version}.`,
+      })
+      return true
+    } catch {
+      s.success()
+      return false
+    }
+  }
+}
+
 export interface PublishCommandOptions {
   preRelease?: boolean
   checkRemoteVersion?: boolean
@@ -31,20 +52,9 @@ export async function publish({ preRelease, checkRemoteVersion, npmTag }: Publis
   const s = createSpinner('Publishing all packages').start()
   const args = ['-r', 'publish', '--no-git-checks', '--access', 'public']
 
-  if (checkRemoteVersion) {
-    const packageJson = getPackageJsons().find((packageJson) => !packageJson.config.private)
-    if (packageJson) {
-      const { config } = packageJson
-      try {
-        await execa('npm', ['view', `${config.name}@${config.version}`, 'version'])
-        s.warn({
-          text: `The npm package has a same remote version ${config.version}, publishing automatically skipped.`,
-        })
-        return
-      } catch {
-        /* empty */
-      }
-    }
+  if (checkRemoteVersion && (await isSameVersion())) {
+    logger.error('publishing automatically skipped.')
+    return
   }
 
   if (preRelease) {
@@ -181,6 +191,7 @@ export interface ReleaseCommandOptions {
   skipNpmPublish?: boolean
   skipChangelog?: boolean
   skipGitTag?: boolean
+  checkRemoteVersion?: boolean
   task?(): Promise<void>
 }
 
@@ -208,6 +219,11 @@ export async function release(options: ReleaseCommandOptions) {
 
     const { isPreRelease, expectVersion } = await getReleaseVersion(currentVersion)
 
+    if (options.checkRemoteVersion && (await isSameVersion(expectVersion))) {
+      logger.error('Please check remote version.')
+      return
+    }
+
     updateVersion(expectVersion)
 
     if (options.task) {