@varlet/release 0.4.4 → 1.0.0

package/README.zh-CN.md

@@ -1,161 +1,163 @@
-<h1 align="center">Varlet Release</h1>
-
-<p align="center">
-  <span>中文</span> | 
-  <a href="https://github.com/varletjs/release/blob/main/README.md">English</a>
-</p>
-<p align="center">
-  <a href="https://www.npmjs.com/package/@varlet/release" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/npm/v/@varlet/release" alt="NPM Version" /></a>
-  <a href="https://github.com/valetjs/release/blob/master/LICENSE" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/github/license/varletjs/release" alt="License" /></a>
-</p>
-
-## 介绍
-
-`Varlet Release` 是一个用于发布所有包、生成变更日志和检测 `commit message` 的工具，依赖于 `pnpm`。
-
-## 安装
-
-```shell
-pnpm add @varlet/release -D
-```
-
-## 使用
-
-### 使用命令
-
-```shell
-# 发布所有包并生成变更日志
-npx vr release
-
-# 指定远程仓库名称
-npx vr release -r https://github.com/varletjs/varlet-release
-# or
-npx vr release --remote https://github.com/varletjs/varlet-release
-
-# 仅生成变更日志
-npx vr changelog
-
-# 指定变更日志文件名
-npx vr changelog -f changelog.md
-# or
-npx vr changelog --file changelog.md
-
-# 检测 commit message
-npx vr lint-commit -p .git/COMMIT_EDITMSG
-
-# 发布到 npm，可以在 ci 中执行
-npx vr publish
-```
-
-### 配置
-
-#### release
-
-| 参数                      | 说明                                                                    |
-| ------------------------- | ----------------------------------------------------------------------- |
-| -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
-
-| 参数                                | 说明               |
-| ----------------------------------- | ------------------ |
-| -f --file \<filename\>              | 指定变更日志文件名 |
-| -rc --releaseCount \<releaseCount\> | 发布数量           |
-| -p --preset \<preset\>              | 指定变更预设       |
-
-#### lint-commit
-
-| 参数                            | 说明                                                                        |
-| ------------------------------- | --------------------------------------------------------------------------- |
-| -p --commitMessagePath \<path\> | 提交 `git message` 的临时文件路径。`git` 钩子 `commit-msg` 会传递这个参数。 |
-| -r --commitMessageRe \<reg\>    | 验证 `commit message` 是否通过的正则                                        |
-| -e --errorMessage \<message\>   | 验证失败展示的错误信息                                                      |
-| -w --warningMessage \<message\> | 验证失败展示的提示信息                                                      |
-
-#### publish
-
-| 参数                      | 说明                                                                  |
-| ------------------------- | --------------------------------------------------------------------- |
-| -c --check-remote-version | 检测npm包的远程版本是否与要在本地发布的包版本相同，如果是，则跳过发布 |
-| -nt --npm-tag \<npmTag\>  | npm tag                                                               |
-
-### 自定义处理
-
-#### 示例
-
-```js
-import { changelog, release } from '@varlet/release'
-
-// Do what you want to do...
-release()
-```
-
-你可以传入一个 `task`，在包版本更改后，在发布之前会调用 `task`。
-
-```js
-import { changelog, release } from '@varlet/release'
-
-async function task() {
-  await doSomething1()
-  await doSomething2()
-}
-
-release({ task })
-```
-
-#### 类型
-
-```ts
-interface PublishCommandOptions {
-  preRelease?: boolean
-  checkRemoteVersion?: boolean
-  npmTag?: string
-}
-function publish({ preRelease, checkRemoteVersion, npmTag }: PublishCommandOptions): Promise<void>
-function updateVersion(version: string): void
-interface ReleaseCommandOptions {
-  remote?: string
-  skipNpmPublish?: boolean
-  skipChangelog?: boolean
-  skipGitTag?: boolean
-  npmTag?: string
-  task?(newVersion: string, oldVersion: string): Promise<void>
-}
-function release(options: ReleaseCommandOptions): Promise<void>
-
-interface ChangelogCommandOptions {
-  file?: string
-  releaseCount?: number
-  preset?:
-    | 'angular'
-    | 'atom'
-    | 'codemirror'
-    | 'conventionalcommits'
-    | 'ember'
-    | 'eslint'
-    | 'express'
-    | 'jquery'
-    | 'jshint'
-}
-function changelog({ releaseCount, file, preset }?: ChangelogCommandOptions): Promise<void>
-
-const COMMIT_MESSAGE_RE: RegExp
-function isVersionCommitMessage(message: string): string | false | null
-function getCommitMessage(commitMessagePath: string): string
-interface CommitLintCommandOptions {
-  commitMessagePath: string
-  commitMessageRe?: string | RegExp
-  errorMessage?: string
-  warningMessage?: string
-}
-function commitLint(options: CommitLintCommandOptions): void
-```
-
-## 许可证
-
-[MIT](https://github.com/varletjs/release/blob/main/LICENSE)
+<h1 align="center">Varlet Release</h1>
+
+<p align="center">
+  <span>中文</span> | 
+  <a href="https://github.com/varletjs/release/blob/main/README.md">English</a>
+</p>
+<p align="center">
+  <a href="https://www.npmjs.com/package/@varlet/release" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/npm/v/@varlet/release" alt="NPM Version" /></a>
+  <a href="https://github.com/valetjs/release/blob/master/LICENSE" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/github/license/varletjs/release" alt="License" /></a>
+</p>
+
+## 介绍
+
+`Varlet Release` 是一个用于发布所有包、生成变更日志和检测 `commit message` 的工具，依赖于 `pnpm`。
+
+`Varlet Release` 需要 `Node.js` ^20.19.0 || >=22.12.0，并且仅支持 `esm`。
+
+## 安装
+
+```shell
+pnpm add @varlet/release -D
+```
+
+## 使用
+
+### 使用命令
+
+```shell
+# 发布所有包并生成变更日志
+npx vr release
+
+# 指定远程仓库名称
+npx vr release -r https://github.com/varletjs/varlet-release
+# or
+npx vr release --remote https://github.com/varletjs/varlet-release
+
+# 仅生成变更日志
+npx vr changelog
+
+# 指定变更日志文件名
+npx vr changelog -f changelog.md
+# or
+npx vr changelog --file changelog.md
+
+# 检测 commit message
+npx vr lint-commit -p .git/COMMIT_EDITMSG
+
+# 发布到 npm，可以在 ci 中执行
+npx vr publish
+```
+
+### 配置
+
+#### release
+
+| 参数                      | 说明                                                                    |
+| ------------------------- | ----------------------------------------------------------------------- |
+| -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
+
+| 参数                                | 说明               |
+| ----------------------------------- | ------------------ |
+| -f --file \<filename\>              | 指定变更日志文件名 |
+| -rc --releaseCount \<releaseCount\> | 发布数量           |
+| -p --preset \<preset\>              | 指定变更预设       |
+
+#### lint-commit
+
+| 参数                            | 说明                                                                        |
+| ------------------------------- | --------------------------------------------------------------------------- |
+| -p --commitMessagePath \<path\> | 提交 `git message` 的临时文件路径。`git` 钩子 `commit-msg` 会传递这个参数。 |
+| -r --commitMessageRe \<reg\>    | 验证 `commit message` 是否通过的正则                                        |
+| -e --errorMessage \<message\>   | 验证失败展示的错误信息                                                      |
+| -w --warningMessage \<message\> | 验证失败展示的提示信息                                                      |
+
+#### publish
+
+| 参数                      | 说明                                                                  |
+| ------------------------- | --------------------------------------------------------------------- |
+| -c --check-remote-version | 检测npm包的远程版本是否与要在本地发布的包版本相同，如果是，则跳过发布 |
+| -nt --npm-tag \<npmTag\>  | npm tag                                                               |
+
+### 自定义处理
+
+#### 示例
+
+```js
+import { changelog, release } from '@varlet/release'
+
+// Do what you want to do...
+release()
+```
+
+你可以传入一个 `task`，在包版本更改后，在发布之前会调用 `task`。
+
+```js
+import { changelog, release } from '@varlet/release'
+
+async function task() {
+  await doSomething1()
+  await doSomething2()
+}
+
+release({ task })
+```
+
+#### 类型
+
+```ts
+interface PublishCommandOptions {
+  preRelease?: boolean
+  checkRemoteVersion?: boolean
+  npmTag?: string
+}
+function publish({ preRelease, checkRemoteVersion, npmTag }: PublishCommandOptions): Promise<void>
+function updateVersion(version: string): void
+interface ReleaseCommandOptions {
+  remote?: string
+  skipNpmPublish?: boolean
+  skipChangelog?: boolean
+  skipGitTag?: boolean
+  npmTag?: string
+  task?(newVersion: string, oldVersion: string): Promise<void>
+}
+function release(options: ReleaseCommandOptions): Promise<void>
+
+interface ChangelogCommandOptions {
+  file?: string
+  releaseCount?: number
+  preset?:
+    | 'angular'
+    | 'atom'
+    | 'codemirror'
+    | 'conventionalcommits'
+    | 'ember'
+    | 'eslint'
+    | 'express'
+    | 'jquery'
+    | 'jshint'
+}
+function changelog({ releaseCount, file, preset }?: ChangelogCommandOptions): Promise<void>
+
+const COMMIT_MESSAGE_RE: RegExp
+function isVersionCommitMessage(message: string): string | false | null
+function getCommitMessage(commitMessagePath: string): string
+interface CommitLintCommandOptions {
+  commitMessagePath: string
+  commitMessageRe?: string | RegExp
+  errorMessage?: string
+  warningMessage?: string
+}
+function commitLint(options: CommitLintCommandOptions): void
+```
+
+## 许可证
+
+[MIT](https://github.com/varletjs/release/blob/main/LICENSE)

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/cli.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+import { changelog, commitLint, publish, release } from "./index.js";
+import { Command } from "commander";
+
+//#region package.json
+var version = "1.0.0";
+
+//#endregion
+//#region src/cli.ts
+const program = new Command();
+program.version(version);
+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((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((options) => publish(options));
+program.command("changelog").option("-rc --releaseCount <releaseCount>", "Release count").option("-f --file <file>", "Changelog filename").option("-p --preset <preset>", "Changelog preset").description("Generate changelog").action((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((option) => commitLint(option));
+program.parse();
+
+//#endregion
+export {  };

package/dist/index.d.ts

@@ -1,41 +1,54 @@
-import conventionalChangelog from 'conventional-changelog';
+import conventionalChangelog from "conventional-changelog";
 
+//#region src/release.d.ts
 declare function isSameVersion(version?: string): Promise<boolean | undefined>;
 interface PublishCommandOptions {
-    preRelease?: boolean;
-    checkRemoteVersion?: boolean;
-    npmTag?: string;
+  preRelease?: boolean;
+  checkRemoteVersion?: boolean;
+  npmTag?: string;
 }
-declare function publish({ preRelease, checkRemoteVersion, npmTag }: PublishCommandOptions): Promise<void>;
+declare function publish({
+  preRelease,
+  checkRemoteVersion,
+  npmTag
+}: PublishCommandOptions): Promise<void>;
+declare function getAllPackageJsons(): string[];
 declare function updateVersion(version: string): void;
 interface ReleaseCommandOptions {
-    remote?: string;
-    npmTag?: string;
-    skipNpmPublish?: boolean;
-    skipChangelog?: boolean;
-    skipGitTag?: boolean;
-    checkRemoteVersion?: boolean;
-    task?(newVersion: string, oldVersion: string): Promise<void>;
+  remote?: string;
+  npmTag?: string;
+  skipNpmPublish?: boolean;
+  skipChangelog?: boolean;
+  skipGitTag?: boolean;
+  checkRemoteVersion?: boolean;
+  task?(newVersion: string, oldVersion: string): Promise<void>;
 }
 declare function release(options: ReleaseCommandOptions): Promise<void>;
-
+//#endregion
+//#region src/changelog.d.ts
 interface ChangelogCommandOptions {
-    file?: string;
-    releaseCount?: number;
-    preset?: 'angular' | 'atom' | 'codemirror' | 'conventionalcommits' | 'ember' | 'eslint' | 'express' | 'jquery' | 'jshint';
-    writerOpts?: Parameters<typeof conventionalChangelog>['4'];
+  file?: string;
+  releaseCount?: number;
+  preset?: "angular" | "atom" | "codemirror" | "conventionalcommits" | "ember" | "eslint" | "express" | "jquery" | "jshint";
+  writerOpts?: Parameters<typeof conventionalChangelog>["4"];
 }
-declare function changelog({ releaseCount, file, preset, writerOpts, }?: ChangelogCommandOptions): Promise<void>;
-
+declare function changelog({
+  releaseCount,
+  file,
+  preset,
+  writerOpts
+}?: ChangelogCommandOptions): Promise<void>;
+//#endregion
+//#region src/commitLint.d.ts
 declare const COMMIT_MESSAGE_RE: RegExp;
-declare function isVersionCommitMessage(message: string): string | false | null;
+declare function isVersionCommitMessage(message: string): boolean;
 declare function getCommitMessage(commitMessagePath: string): string;
 interface CommitLintCommandOptions {
-    commitMessagePath: string;
-    commitMessageRe?: string | RegExp;
-    errorMessage?: string;
-    warningMessage?: string;
+  commitMessagePath: string;
+  commitMessageRe?: string | RegExp;
+  errorMessage?: string;
+  warningMessage?: string;
 }
 declare function commitLint(options: CommitLintCommandOptions): void;
-
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type PublishCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };
+//#endregion
+export { COMMIT_MESSAGE_RE, ChangelogCommandOptions, CommitLintCommandOptions, PublishCommandOptions, ReleaseCommandOptions, changelog, commitLint, getAllPackageJsons, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };