@varlet/release 0.0.5 → 0.1.0

package/README.md

@@ -42,20 +42,20 @@ pnpm add @varlet/release -D
 npx vr release
 
 # Specify remote name
-npx vr release -r <remote>
+npx vr release -r https://github.com/varletjs/varlet-release
 # or
-npx vr release --remote <remote>
+npx vr release --remote https://github.com/varletjs/varlet-release
 
 # Just generate changelogs
 npx vr changelog
 
 # Specify changelog filename
-npx vr changelog -f <filename>
+npx vr changelog -f changelog.md
 # or
-npx vr changelog --file <filename>
+npx vr changelog --file changelog.md
 
 # Lint commit message
-npx vr lint-commit <gitMessagePath>
+npx vr lint-commit -p .git/COMMIT_EDITMSG
 ```
 
 ### Configuration
@@ -75,9 +75,12 @@ npx vr lint-commit <gitMessagePath>
 
 #### lint-commit
 
-| Params             | Instructions                                                                                                           |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| \<gitMessagePath\> | The path of the temporary file to which the git message is submitted. The git hook commit-msg will pass this parameter |
+| Params                          | Instructions                                                                                                           |
+| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| -p --commitMessagePath \<path\> | The path of the temporary file to which the git message is submitted. The git hook commit-msg will pass this parameter |
+| -r --commitMessageRe \<reg\>    | Validate the regular of whether the commit message passes                                                              |
+| -e --errorMessage \<message\>   | Validation failed to display error messages                                                                            |
+| -w --warningMessage \<message\> | Validation failed to display warning messages                                                                          |
 
 ### Custom Handle
 
@@ -117,7 +120,14 @@ interface ChangelogCommandOptions {
   releaseCount?: number
 }
 function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
-function commitLint(gitMessagePath: string): void
+
+interface CommitLintCommandOptions {
+  commitMessagePath: string
+  commitMessageRe?: string | RegExp
+  errorMessage?: string
+  warningMessage?: string
+}
+function commitLint(options: CommitLintCommandOptions): void
 ```
 
 ## License

package/README.zh-CN.md

@@ -42,20 +42,20 @@ pnpm add @varlet/release -D
 npx vr release
 
 # 指定远程仓库名称
-npx vr release -r <remote>
+npx vr release -r https://github.com/varletjs/varlet-release
 # or
-npx vr release --remote <remote>
+npx vr release --remote https://github.com/varletjs/varlet-release
 
 # 仅生成变更日志
 npx vr changelog
 
 # 指定变更日志文件名
-npx vr changelog -f <filename>
+npx vr changelog -f changelog.md
 # or
-npx vr changelog --file <filename>
+npx vr changelog --file changelog.md
 
 # 检测 commit message
-npx vr lint-commit <gitMessagePath>
+npx vr lint-commit -p .git/COMMIT_EDITMSG
 ```
 
 ### 配置
@@ -75,9 +75,12 @@ npx vr lint-commit <gitMessagePath>
 
 #### lint-commit
 
-| 参数               | 说明                                                                        |
-| ------------------ | --------------------------------------------------------------------------- |
-| \<gitMessagePath\> | 提交 `git message` 的临时文件路径。`git` 钩子 `commit-msg` 会传递这个参数。 |
+| 参数                            | 说明                                                                        |
+| ------------------------------- | --------------------------------------------------------------------------- |
+| -p --commitMessagePath \<path\> | 提交 `git message` 的临时文件路径。`git` 钩子 `commit-msg` 会传递这个参数。 |
+| -r --commitMessageRe \<reg\>    | 验证 `commit message` 是否通过的正则                                        |
+| -e --errorMessage \<message\>   | 验证失败展示的错误信息                                                      |
+| -w --warningMessage \<message\> | 验证失败展示的提示信息                                                      |
 
 ### 自定义处理
 
@@ -117,7 +120,14 @@ interface ChangelogCommandOptions {
   releaseCount?: number
 }
 function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
-function commitLint(gitMessagePath: string): void
+
+interface CommitLintCommandOptions {
+  commitMessagePath: string
+  commitMessageRe?: string | RegExp
+  errorMessage?: string
+  warningMessage?: string
+}
+function commitLint(options: CommitLintCommandOptions): void
 ```
 
 ## License

package/bin/index.js

@@ -1,25 +1,29 @@
-#!/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 <gitMessagePath>')
-  .description('Lint commit message')
-  .action(async (option) => commitLint(option))
-
-program.parse()
+#!/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 <commitMessagePath>', '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

@@ -236,17 +236,8 @@ var import_semver2 = __toESM(require("semver"), 1);
 var import_fs_extra3 = __toESM(require("fs-extra"), 1);
 var { readFileSync } = import_fs_extra3.default;
 var COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor)(\(.+\))?!?: (.|\n)+/;
-function isVersionCommitMessage(message) {
-  return message.startsWith("v") && import_semver2.default.valid(message.slice(1));
-}
-function getCommitMessage(gitMessagePath) {
-  return readFileSync(gitMessagePath, "utf-8").trim();
-}
-function commitLint(gitMessagePath) {
-  const commitMessage = getCommitMessage(gitMessagePath);
-  if (!isVersionCommitMessage(commitMessage) && !COMMIT_MESSAGE_RE.test(commitMessage)) {
-    logger_default.error(`Commit message invalid`);
-    logger_default.warning(`The rules for commit messages are as follows
+var ERROR_MESSAGE = "Commit message invalid.";
+var WARNING_MESSAGE = `The rules for commit messages are as follows
 
 Example:
 
@@ -274,7 +265,25 @@ Allowed types:
 - revert
 
 Commit message reference: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y
-\u53C2\u8003\u962E\u4E00\u5CF0Commit message\u7F16\u5199\u6307\u5357: https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html`);
+\u53C2\u8003\u962E\u4E00\u5CF0Commit message\u7F16\u5199\u6307\u5357: https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html`;
+function isVersionCommitMessage(message) {
+  return message.startsWith("v") && import_semver2.default.valid(message.slice(1));
+}
+function getCommitMessage(commitMessagePath) {
+  return readFileSync(commitMessagePath, "utf-8").trim();
+}
+function commitLint(options) {
+  const {
+    commitMessagePath,
+    commitMessageRe = COMMIT_MESSAGE_RE,
+    errorMessage = ERROR_MESSAGE,
+    warningMessage = WARNING_MESSAGE
+  } = options;
+  const commitMessage = getCommitMessage(commitMessagePath);
+  const isValidCommitMessage = new RegExp(commitMessageRe).test(commitMessage);
+  if (!isVersionCommitMessage(commitMessage) && !isValidCommitMessage) {
+    logger_default.error(errorMessage);
+    logger_default.warning(warningMessage);
     process.exit(1);
   }
 }

package/dist/index.d.cts

@@ -12,7 +12,13 @@ declare function changelog({ releaseCount, file }?: ChangelogCommandOptions): Pr
 
 declare const COMMIT_MESSAGE_RE: RegExp;
 declare function isVersionCommitMessage(message: string): string | false | null;
-declare function getCommitMessage(gitMessagePath: string): string;
-declare function commitLint(gitMessagePath: string): void;
+declare function getCommitMessage(commitMessagePath: string): string;
+interface CommitLintCommandOptions {
+    commitMessagePath: string;
+    commitMessageRe?: string | RegExp;
+    errorMessage?: string;
+    warningMessage?: string;
+}
+declare function commitLint(options: CommitLintCommandOptions): void;
 
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, release };
+export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, release };

package/dist/index.d.ts

@@ -12,7 +12,13 @@ declare function changelog({ releaseCount, file }?: ChangelogCommandOptions): Pr
 
 declare const COMMIT_MESSAGE_RE: RegExp;
 declare function isVersionCommitMessage(message: string): string | false | null;
-declare function getCommitMessage(gitMessagePath: string): string;
-declare function commitLint(gitMessagePath: string): void;
+declare function getCommitMessage(commitMessagePath: string): string;
+interface CommitLintCommandOptions {
+    commitMessagePath: string;
+    commitMessageRe?: string | RegExp;
+    errorMessage?: string;
+    warningMessage?: string;
+}
+declare function commitLint(options: CommitLintCommandOptions): void;
 
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, release };
+export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isVersionCommitMessage, release };

package/dist/index.js

@@ -195,17 +195,8 @@ import semver2 from "semver";
 import fse3 from "fs-extra";
 var { readFileSync } = fse3;
 var COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor)(\(.+\))?!?: (.|\n)+/;
-function isVersionCommitMessage(message) {
-  return message.startsWith("v") && semver2.valid(message.slice(1));
-}
-function getCommitMessage(gitMessagePath) {
-  return readFileSync(gitMessagePath, "utf-8").trim();
-}
-function commitLint(gitMessagePath) {
-  const commitMessage = getCommitMessage(gitMessagePath);
-  if (!isVersionCommitMessage(commitMessage) && !COMMIT_MESSAGE_RE.test(commitMessage)) {
-    logger_default.error(`Commit message invalid`);
-    logger_default.warning(`The rules for commit messages are as follows
+var ERROR_MESSAGE = "Commit message invalid.";
+var WARNING_MESSAGE = `The rules for commit messages are as follows
 
 Example:
 
@@ -233,7 +224,25 @@ Allowed types:
 - revert
 
 Commit message reference: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y
-\u53C2\u8003\u962E\u4E00\u5CF0Commit message\u7F16\u5199\u6307\u5357: https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html`);
+\u53C2\u8003\u962E\u4E00\u5CF0Commit message\u7F16\u5199\u6307\u5357: https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html`;
+function isVersionCommitMessage(message) {
+  return message.startsWith("v") && semver2.valid(message.slice(1));
+}
+function getCommitMessage(commitMessagePath) {
+  return readFileSync(commitMessagePath, "utf-8").trim();
+}
+function commitLint(options) {
+  const {
+    commitMessagePath,
+    commitMessageRe = COMMIT_MESSAGE_RE,
+    errorMessage = ERROR_MESSAGE,
+    warningMessage = WARNING_MESSAGE
+  } = options;
+  const commitMessage = getCommitMessage(commitMessagePath);
+  const isValidCommitMessage = new RegExp(commitMessageRe).test(commitMessage);
+  if (!isVersionCommitMessage(commitMessage) && !isValidCommitMessage) {
+    logger_default.error(errorMessage);
+    logger_default.warning(warningMessage);
     process.exit(1);
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@varlet/release",
   "type": "module",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "release all packages and generate changelogs",
   "keywords": [
     "varlet",
@@ -33,7 +33,7 @@
   ],
   "simple-git-hooks": {
     "pre-commit": "pnpm exec lint-staged --allow-empty --concurrent false",
-    "commit-msg": "pnpm run commit-lint $1"
+    "commit-msg": "pnpm run commit-lint -p $1"
   },
   "lint-staged": {
     "*.{ts,tsx,js,vue,less}": "prettier --write",
@@ -72,6 +72,7 @@
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",
+    "postinstall": "simple-git-hooks",
     "dev": "tsup --watch",
     "build": "tsup",
     "release": "pnpm build && node bin/index.js release",