@varlet/release 0.1.1 → 0.2.0

package/README.md

@@ -56,6 +56,9 @@ npx vr changelog --file changelog.md
 
 # Lint commit message
 npx vr lint-commit -p .git/COMMIT_EDITMSG
+
+# Publish to npm, which can be called in the ci environment
+npx vr publish
 ```
 
 ### Configuration
@@ -71,6 +74,7 @@ npx vr lint-commit -p .git/COMMIT_EDITMSG
 | Params                              | Instructions               |
 | ----------------------------------- | -------------------------- |
 | -f --file \<filename\>              | Specify changelog filename |
+| -s --skip-npm-publish               | Skip npm publish           |
 | -rc --releaseCount \<releaseCount\> | Release count              |
 
 #### lint-commit
@@ -82,6 +86,12 @@ npx vr lint-commit -p .git/COMMIT_EDITMSG
 | -e --errorMessage \<message\>   | Validation failed to display error messages                                                                            |
 | -w --warningMessage \<message\> | Validation failed to display warning messages                                                                          |
 
+#### publish
+
+```shell
+vr publish
+```
+
 ### Custom Handle
 
 #### Example
@@ -109,8 +119,11 @@ release({ task })
 #### Types
 
 ```ts
+function publish(preRelease: boolean | undefined): Promise<void>
+function updateVersion(version: string): void
 interface ReleaseCommandOptions {
   remote?: string
+  skipNpmPublish?: boolean
   task?(): Promise<void>
 }
 function release(options: ReleaseCommandOptions): Promise<void>
@@ -121,6 +134,9 @@ interface ChangelogCommandOptions {
 }
 function changelog({ releaseCount, file }?: 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

package/README.zh-CN.md

@@ -56,6 +56,9 @@ npx vr changelog --file changelog.md
 
 # 检测 commit message
 npx vr lint-commit -p .git/COMMIT_EDITMSG
+
+# 发布到 npm，可以在 ci 中执行
+npx vr publish
 ```
 
 ### 配置
@@ -71,6 +74,7 @@ npx vr lint-commit -p .git/COMMIT_EDITMSG
 | 参数                                | 说明               |
 | ----------------------------------- | ------------------ |
 | -f --file \<filename\>              | 指定变更日志文件名 |
+| -s --skip-npm-publish               | 跳过 npm 发布      |
 | -rc --releaseCount \<releaseCount\> | 发布数量           |
 
 #### lint-commit
@@ -82,6 +86,12 @@ npx vr lint-commit -p .git/COMMIT_EDITMSG
 | -e --errorMessage \<message\>   | 验证失败展示的错误信息                                                      |
 | -w --warningMessage \<message\> | 验证失败展示的提示信息                                                      |
 
+#### publish
+
+```shell
+vr publish
+```
+
 ### 自定义处理
 
 #### 示例
@@ -109,8 +119,11 @@ release({ task })
 #### 类型
 
 ```ts
+function publish(preRelease: boolean | undefined): Promise<void>
+function updateVersion(version: string): void
 interface ReleaseCommandOptions {
   remote?: string
+  skipNpmPublish?: boolean
   task?(): Promise<void>
 }
 function release(options: ReleaseCommandOptions): Promise<void>
@@ -121,6 +134,9 @@ interface ChangelogCommandOptions {
 }
 function changelog({ releaseCount, file }?: 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

package/bin/index.js

@@ -1,29 +1,35 @@
-#!/usr/bin/env node
-import { release, changelog, commitLint } from '../dist/index.js'
-import { Command } from 'commander'
-
-const program = new Command()
-
-program
-  .command('release')
-  .option('-r --remote <remote>', 'Remote name')
-  .description('Release all packages and generate changelogs')
-  .action(async (options) => release(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')
+  .description('Release all packages and generate changelogs')
+  .action(async (options) => release(options))
+
+program
+  .command('publish')
+  .description('Publish to npm')
+  .action(async () => publish())
+
+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

@@ -35,7 +35,9 @@ __export(src_exports, {
   commitLint: () => commitLint,
   getCommitMessage: () => getCommitMessage,
   isVersionCommitMessage: () => isVersionCommitMessage,
-  release: () => release
+  publish: () => publish,
+  release: () => release,
+  updateVersion: () => updateVersion
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -209,7 +211,9 @@ async function release(options) {
     if (options.task) {
       await options.task();
     }
-    await publish(isPreRelease);
+    if (!options.skipNpmPublish) {
+      await publish(isPreRelease);
+    }
     if (!isPreRelease) {
       await changelog();
       await pushGit(expectVersion, options.remote);
@@ -294,5 +298,7 @@ function commitLint(options) {
   commitLint,
   getCommitMessage,
   isVersionCommitMessage,
-  release
+  publish,
+  release,
+  updateVersion
 });

package/dist/index.d.cts

@@ -1,5 +1,8 @@
+declare function publish(preRelease: boolean | undefined): Promise<void>;
+declare function updateVersion(version: string): void;
 interface ReleaseCommandOptions {
     remote?: string;
+    skipNpmPublish?: boolean;
     task?(): Promise<void>;
 }
 declare function release(options: ReleaseCommandOptions): Promise<void>;
@@ -21,4 +24,4 @@ interface CommitLintCommandOptions {
 }
 declare function commitLint(options: CommitLintCommandOptions): void;
 
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, release };
+export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, publish, release, updateVersion };

package/dist/index.d.ts

@@ -1,5 +1,8 @@
+declare function publish(preRelease: boolean | undefined): Promise<void>;
+declare function updateVersion(version: string): void;
 interface ReleaseCommandOptions {
     remote?: string;
+    skipNpmPublish?: boolean;
     task?(): Promise<void>;
 }
 declare function release(options: ReleaseCommandOptions): Promise<void>;
@@ -21,4 +24,4 @@ interface CommitLintCommandOptions {
 }
 declare function commitLint(options: CommitLintCommandOptions): void;
 
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, release };
+export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, publish, release, updateVersion };

package/dist/index.js

@@ -168,7 +168,9 @@ async function release(options) {
     if (options.task) {
       await options.task();
     }
-    await publish(isPreRelease);
+    if (!options.skipNpmPublish) {
+      await publish(isPreRelease);
+    }
     if (!isPreRelease) {
       await changelog();
       await pushGit(expectVersion, options.remote);
@@ -252,5 +254,7 @@ export {
   commitLint,
   getCommitMessage,
   isVersionCommitMessage,
-  release
+  publish,
+  release,
+  updateVersion
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@varlet/release",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "release all packages and generate changelogs",
   "keywords": [
     "varlet",
@@ -71,8 +71,6 @@
     "semver": "^7.5.4"
   },
   "scripts": {
-    "preinstall": "npx only-allow pnpm",
-    "postinstall": "node -e \"if (process.env.INIT_CWD === process.cwd()) { process.exit(1) }\" || simple-git-hooks",
     "dev": "tsup --watch",
     "build": "tsup",
     "release": "pnpm build && node bin/index.js release",