@varlet/release 0.2.8 → 0.2.10

package/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
 

package/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                                                               |
 
 ### 自定义处理
 

package/bin/index.js

@@ -1,40 +1,41 @@
-#!/usr/bin/env node
-import { release, publish, changelog, commitLint } from '../dist/index.js'
-import { Command } from 'commander'
-
-const program = new Command()
-
-program
-  .command('release')
-  .option('-r --remote <remote>', 'Remote name')
-  .option('-s --skip-npm-publish', 'Skip npm publish')
-  .option('-sc --skip-changelog', 'Skip generate changelog')
-  .option('-sgt --skip-git-tag', 'Skip git tag')
-  .option('-nt --npm-tag <npmTag>', 'Npm tag')
-  .description('Release all packages and generate changelogs')
-  .action(async (options) => release(options))
-
-program
-  .command('publish')
-  .option('-c --check-remote-version', 'Check remote version')
-  .option('-nt --npm-tag <npmTag>', 'Npm tag')
-  .description('Publish to npm')
-  .action(async (options) => publish(options))
-
-program
-  .command('changelog')
-  .option('-rc --releaseCount <releaseCount>', 'Release count')
-  .option('-f --file <file>', 'Changelog filename')
-  .description('Generate changelog')
-  .action(async (options) => changelog(options))
-
-program
-  .command('commit-lint')
-  .option('-p --commitMessagePath <path>', 'Git commit message path')
-  .option('-r --commitMessageRe <reg>', 'Validate the regular of whether the commit message passes')
-  .option('-e --errorMessage <message>', 'Validation failed to display error messages')
-  .option('-w --warningMessage <message>', 'Validation failed to display warning messages')
-  .description('Lint commit message')
-  .action(async (option) => commitLint(option))
-
-program.parse()
+#!/usr/bin/env node
+import { release, publish, changelog, commitLint } from '../dist/index.js'
+import { Command } from 'commander'
+
+const program = new Command()
+
+program
+  .command('release')
+  .option('-r --remote <remote>', 'Remote name')
+  .option('-s --skip-npm-publish', 'Skip npm publish')
+  .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))
+
+program
+  .command('publish')
+  .option('-c --check-remote-version', 'Check remote version')
+  .option('-nt --npm-tag <npmTag>', 'Npm tag')
+  .description('Publish to npm')
+  .action(async (options) => publish(options))
+
+program
+  .command('changelog')
+  .option('-rc --releaseCount <releaseCount>', 'Release count')
+  .option('-f --file <file>', 'Changelog filename')
+  .description('Generate changelog')
+  .action(async (options) => changelog(options))
+
+program
+  .command('commit-lint')
+  .option('-p --commitMessagePath <path>', 'Git commit message path')
+  .option('-r --commitMessageRe <reg>', 'Validate the regular of whether the commit message passes')
+  .option('-e --errorMessage <message>', 'Validation failed to display error messages')
+  .option('-w --warningMessage <message>', 'Validation failed to display warning messages')
+  .description('Lint commit message')
+  .action(async (option) => commitLint(option))
+
+program.parse()

package/dist/index.cjs

@@ -34,6 +34,7 @@ __export(src_exports, {
   changelog: () => changelog,
   commitLint: () => commitLint,
   getCommitMessage: () => getCommitMessage,
+  isSameVersion: () => isSameVersion,
   isVersionCommitMessage: () => isVersionCommitMessage,
   publish: () => publish,
   release: () => release,
@@ -101,22 +102,30 @@ async function isWorktreeEmpty() {
   const ret = await (0, import_execa.execa)("git", ["status", "--porcelain"]);
   return !ret.stdout;
 }
+async function isSameVersion(version) {
+  const s = (0, import_nanospinner2.createSpinner)("Check remote version...").start();
+  const packageJsones = getPackageJsons();
+  const packageJson = packageJsones.find((packageJson2) => !packageJson2.config.private) || packageJsones[0];
+  if (packageJson) {
+    const { config } = packageJson;
+    try {
+      await (0, import_execa.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;
+    }
+  }
+}
 async function publish({ preRelease, checkRemoteVersion, npmTag }) {
   const s = (0, import_nanospinner2.createSpinner)("Publishing all packages").start();
   const args = ["-r", "publish", "--no-git-checks", "--access", "public"];
-  if (checkRemoteVersion) {
-    const packageJson = getPackageJsons().find((packageJson2) => !packageJson2.config.private);
-    if (packageJson) {
-      const { config } = packageJson;
-      try {
-        await (0, import_execa.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 {
-      }
-    }
+  if (checkRemoteVersion && await isSameVersion()) {
+    logger_default.error("publishing automatically skipped.");
+    return;
   }
   if (preRelease) {
     args.push("--tag", "alpha");
@@ -240,6 +249,10 @@ async function release(options) {
       return;
     }
     const { isPreRelease, expectVersion } = await getReleaseVersion(currentVersion);
+    if (options.checkRemoteVersion && await isSameVersion(expectVersion)) {
+      logger_default.error("Please check remote version.");
+      return;
+    }
     updateVersion(expectVersion);
     if (options.task) {
       await options.task();
@@ -320,6 +333,10 @@ function commitLint(options) {
     errorMessage = ERROR_MESSAGE,
     warningMessage = WARNING_MESSAGE
   } = options;
+  if (!commitMessagePath) {
+    logger_default.error("commitMessagePath is required");
+    process.exit(1);
+  }
   const commitMessage = getCommitMessage(commitMessagePath);
   const isValidCommitMessage = new RegExp(commitMessageRe).test(commitMessage);
   if (!isVersionCommitMessage(commitMessage) && !isValidCommitMessage) {
@@ -334,6 +351,7 @@ function commitLint(options) {
   changelog,
   commitLint,
   getCommitMessage,
+  isSameVersion,
   isVersionCommitMessage,
   publish,
   release,

package/dist/index.d.cts

@@ -1,3 +1,4 @@
+declare function isSameVersion(version?: string): Promise<boolean | undefined>;
 interface PublishCommandOptions {
     preRelease?: boolean;
     checkRemoteVersion?: boolean;
@@ -11,6 +12,7 @@ interface ReleaseCommandOptions {
     skipNpmPublish?: boolean;
     skipChangelog?: boolean;
     skipGitTag?: boolean;
+    checkRemoteVersion?: boolean;
     task?(): Promise<void>;
 }
 declare function release(options: ReleaseCommandOptions): Promise<void>;
@@ -32,4 +34,4 @@ interface CommitLintCommandOptions {
 }
 declare function commitLint(options: CommitLintCommandOptions): void;
 
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type PublishCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, publish, release, updateVersion };
+export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type PublishCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+declare function isSameVersion(version?: string): Promise<boolean | undefined>;
 interface PublishCommandOptions {
     preRelease?: boolean;
     checkRemoteVersion?: boolean;
@@ -11,6 +12,7 @@ interface ReleaseCommandOptions {
     skipNpmPublish?: boolean;
     skipChangelog?: boolean;
     skipGitTag?: boolean;
+    checkRemoteVersion?: boolean;
     task?(): Promise<void>;
 }
 declare function release(options: ReleaseCommandOptions): Promise<void>;
@@ -32,4 +34,4 @@ interface CommitLintCommandOptions {
 }
 declare function commitLint(options: CommitLintCommandOptions): void;
 
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type PublishCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, publish, release, updateVersion };
+export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type PublishCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };

package/dist/index.js

@@ -58,22 +58,30 @@ async function isWorktreeEmpty() {
   const ret = await execa("git", ["status", "--porcelain"]);
   return !ret.stdout;
 }
+async function isSameVersion(version) {
+  const s = createSpinner2("Check remote version...").start();
+  const packageJsones = getPackageJsons();
+  const packageJson = packageJsones.find((packageJson2) => !packageJson2.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;
+    }
+  }
+}
 async function publish({ preRelease, checkRemoteVersion, npmTag }) {
   const s = createSpinner2("Publishing all packages").start();
   const args = ["-r", "publish", "--no-git-checks", "--access", "public"];
-  if (checkRemoteVersion) {
-    const packageJson = getPackageJsons().find((packageJson2) => !packageJson2.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 {
-      }
-    }
+  if (checkRemoteVersion && await isSameVersion()) {
+    logger_default.error("publishing automatically skipped.");
+    return;
   }
   if (preRelease) {
     args.push("--tag", "alpha");
@@ -197,6 +205,10 @@ async function release(options) {
       return;
     }
     const { isPreRelease, expectVersion } = await getReleaseVersion(currentVersion);
+    if (options.checkRemoteVersion && await isSameVersion(expectVersion)) {
+      logger_default.error("Please check remote version.");
+      return;
+    }
     updateVersion(expectVersion);
     if (options.task) {
       await options.task();
@@ -277,6 +289,10 @@ function commitLint(options) {
     errorMessage = ERROR_MESSAGE,
     warningMessage = WARNING_MESSAGE
   } = options;
+  if (!commitMessagePath) {
+    logger_default.error("commitMessagePath is required");
+    process.exit(1);
+  }
   const commitMessage = getCommitMessage(commitMessagePath);
   const isValidCommitMessage = new RegExp(commitMessageRe).test(commitMessage);
   if (!isVersionCommitMessage(commitMessage) && !isValidCommitMessage) {
@@ -290,6 +306,7 @@ export {
   changelog,
   commitLint,
   getCommitMessage,
+  isSameVersion,
   isVersionCommitMessage,
   publish,
   release,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@varlet/release",
   "type": "module",
-  "version": "0.2.8",
+  "version": "0.2.10",
   "description": "release all packages and generate changelogs",
   "keywords": [
     "varlet",
@@ -39,7 +39,6 @@
     "*.{ts,tsx,js,vue,less}": "prettier --write",
     "*.{ts,tsx,js,vue}": "eslint --fix"
   },
-  "packageManager": "pnpm@8.7.5",
   "engines": {
     "node": ">=16.0.0",
     "pnpm": ">=8.0"
@@ -72,7 +71,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"
   }