@varlet/release 0.0.3-alpha.1700239118439 → 0.0.4

package/LICENCE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 varlet
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2022 varlet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,116 +1,125 @@
-<h1 align="center">Varlet Release</h1>
-
-<p align="center">
-  <span>English</span> | 
-  <a href="https://github.com/varletjs/release/blob/main/README.zh-CN.md">中文</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/varletjs/release/blob/main/LICENCE" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/github/license/varletjs/release" alt="License" /></a>
-</p>
-
-## Intro
-
-`Varlet Release` is a tool to release all packages and generate changelogs.
-
-## Installation
-
-### npm
-
-```shell
-npm i @varlet/release -D
-```
-
-### yarn
-
-```shell
-yarn add @varlet/release -D
-```
-
-### pnpm
-
-```shell
-pnpm add @varlet/release -D
-```
-
-## Usage
-
-### Using Command
-
-```shell
-# Release all packages and generate changelogs
-npx vr release
-
-# Specify remote name
-npx vr release -r <remote>
-# or
-npx vr release --remote <remote>
-
-# Just generate changelogs
-npx vr changelog
-
-# Specify changelog filename
-npx vr changelog -f <filename>
-# or
-npx vr changelog --file <filename>
-
-```
-
-### Configuration
-
-#### release
-
-| Params               | Instructions        |
-| -------------------- | ------------------- |
-| -r --remote <remote> | Specify remote name |
-
-#### changelog
-
-| Params                            | Instructions               |
-| --------------------------------- | -------------------------- |
-| -f --file <filename>              | Specify changelog filename |
-| -rc --releaseCount <releaseCount> | Release count              |
-
-### Custom Handle
-
-#### Example
-
-```js
-import { release, changelog } from '@varlet/release'
-
-// Do what you want to do...
-release()
-```
-
-You can pass in a task that will be called before the publish after the package version is changed.
-
-```js
-import { release, changelog } from '@varlet/release'
-
-async function task() {
-  await doSomething1()
-  await doSomething2()
-}
-
-release({ task })
-```
-
-#### Types
-
-```ts
-interface ReleaseCommandOptions {
-  remote?: string
-  task?(): Promise<void>
-}
-function release(options: ReleaseCommandOptions): Promise<void>
-
-interface ChangelogCommandOptions {
-  file?: string
-  releaseCount?: number
-}
-function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
-```
-
-## License
-
-[MIT](https://github.com/varletjs/release/blob/main/LICENCE)
+<h1 align="center">Varlet Release</h1>
+
+<p align="center">
+  <span>English</span> | 
+  <a href="https://github.com/varletjs/release/blob/main/README.zh-CN.md">中文</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/varletjs/release/blob/main/LICENCE" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/github/license/varletjs/release" alt="License" /></a>
+</p>
+
+## Intro
+
+`Varlet Release` is a tool to release all packages, generate changelogs and lint commit message.
+
+## Installation
+
+### npm
+
+```shell
+npm i @varlet/release -D
+```
+
+### yarn
+
+```shell
+yarn add @varlet/release -D
+```
+
+### pnpm
+
+```shell
+pnpm add @varlet/release -D
+```
+
+## Usage
+
+### Using Command
+
+```shell
+# Release all packages and generate changelogs
+npx vr release
+
+# Specify remote name
+npx vr release -r <remote>
+# or
+npx vr release --remote <remote>
+
+# Just generate changelogs
+npx vr changelog
+
+# Specify changelog filename
+npx vr changelog -f <filename>
+# or
+npx vr changelog --file <filename>
+
+# Lint commit message
+npx vr lint-commit <gitMessagePath>
+```
+
+### Configuration
+
+#### release
+
+| Params                 | Instructions        |
+| ---------------------- | ------------------- |
+| -r --remote \<remote\> | Specify remote name |
+
+#### changelog
+
+| Params                              | Instructions               |
+| ----------------------------------- | -------------------------- |
+| -f --file \<filename\>              | Specify changelog filename |
+| -rc --releaseCount \<releaseCount\> | Release count              |
+
+#### 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 |
+
+### Custom Handle
+
+#### Example
+
+```js
+import { release, changelog } from '@varlet/release'
+
+// Do what you want to do...
+release()
+```
+
+You can pass in a task that will be called before the publish after the package version is changed.
+
+```js
+import { release, changelog } from '@varlet/release'
+
+async function task() {
+  await doSomething1()
+  await doSomething2()
+}
+
+release({ task })
+```
+
+#### Types
+
+```ts
+interface ReleaseCommandOptions {
+  remote?: string
+  task?(): Promise<void>
+}
+function release(options: ReleaseCommandOptions): Promise<void>
+
+interface ChangelogCommandOptions {
+  file?: string
+  releaseCount?: number
+}
+function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
+function commitLint(gitMessagePath: string): void
+```
+
+## License
+
+[MIT](https://github.com/varletjs/release/blob/main/LICENCE)

package/README.zh-CN.md

@@ -1,116 +1,125 @@
-<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` 是一个用于发布所有包并生成变更日志的工具。
-
-## 安装
-
-### npm
-
-```shell
-npm i @varlet/release -D
-```
-
-### yarn
-
-```shell
-yarn add @varlet/release -D
-```
-
-### pnpm
-
-```shell
-pnpm add @varlet/release -D
-```
-
-## 使用
-
-### 使用命令
-
-```shell
-# 发布所有包并生成变更日志
-npx vr release
-
-# 指定远程仓库名称
-npx vr release -r <remote>
-# or
-npx vr release --remote <remote>
-
-# 仅生成变更日志
-npx vr changelog
-
-# 指定变更日志文件名
-npx vr changelog -f <filename>
-# or
-npx vr changelog --file <filename>
-
-```
-
-### 配置
-
-#### release
-
-| 参数                 | 说明             |
-| -------------------- | ---------------- |
-| -r --remote <remote> | 指定远程仓库名称 |
-
-#### changelog
-
-| 参数                              | 说明               |
-| --------------------------------- | ------------------ |
-| -f --file <filename>              | 指定变更日志文件名 |
-| -rc --releaseCount <releaseCount> | 发布数量           |
-
-### 自定义处理
-
-#### 示例
-
-```js
-import { release, changelog } from '@varlet/release'
-
-// Do what you want to do...
-release()
-```
-
-你可以传入一个 `task`，在包版本更改后，在发布之前会调用 `task`。
-
-```js
-import { release, changelog } from '@varlet/release'
-
-async function task() {
-  await doSomething1()
-  await doSomething2()
-}
-
-release({ task })
-```
-
-#### 类型
-
-```ts
-interface ReleaseCommandOptions {
-  remote?: string
-  task?(): Promise<void>
-}
-function release(options: ReleaseCommandOptions): Promise<void>
-
-interface ChangelogCommandOptions {
-  file?: string
-  releaseCount?: number
-}
-function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
-```
-
-## License
-
-[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` 的工具。
+
+## 安装
+
+### npm
+
+```shell
+npm i @varlet/release -D
+```
+
+### yarn
+
+```shell
+yarn add @varlet/release -D
+```
+
+### pnpm
+
+```shell
+pnpm add @varlet/release -D
+```
+
+## 使用
+
+### 使用命令
+
+```shell
+# 发布所有包并生成变更日志
+npx vr release
+
+# 指定远程仓库名称
+npx vr release -r <remote>
+# or
+npx vr release --remote <remote>
+
+# 仅生成变更日志
+npx vr changelog
+
+# 指定变更日志文件名
+npx vr changelog -f <filename>
+# or
+npx vr changelog --file <filename>
+
+# 检测 commit message
+npx vr lint-commit <gitMessagePath>
+```
+
+### 配置
+
+#### release
+
+| 参数                   | 说明             |
+| ---------------------- | ---------------- |
+| -r --remote \<remote\> | 指定远程仓库名称 |
+
+#### changelog
+
+| 参数                                | 说明               |
+| ----------------------------------- | ------------------ |
+| -f --file \<filename\>              | 指定变更日志文件名 |
+| -rc --releaseCount \<releaseCount\> | 发布数量           |
+
+#### lint-commit
+
+| 参数               | 说明                                                                        |
+| ------------------ | --------------------------------------------------------------------------- |
+| \<gitMessagePath\> | 提交 `git message` 的临时文件路径。`git` 钩子 `commit-msg` 会传递这个参数。 |
+
+### 自定义处理
+
+#### 示例
+
+```js
+import { release, changelog } from '@varlet/release'
+
+// Do what you want to do...
+release()
+```
+
+你可以传入一个 `task`，在包版本更改后，在发布之前会调用 `task`。
+
+```js
+import { release, changelog } from '@varlet/release'
+
+async function task() {
+  await doSomething1()
+  await doSomething2()
+}
+
+release({ task })
+```
+
+#### 类型
+
+```ts
+interface ReleaseCommandOptions {
+  remote?: string
+  task?(): Promise<void>
+}
+function release(options: ReleaseCommandOptions): Promise<void>
+
+interface ChangelogCommandOptions {
+  file?: string
+  releaseCount?: number
+}
+function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
+function commitLint(gitMessagePath: string): void
+```
+
+## License
+
+[MIT](https://github.com/varletjs/release/blob/main/LICENSE)

package/bin/index.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { release, changelog } from '../dist/index.js'
+import { release, changelog, commitLint } from '../dist/index.js'
 import { Command } from 'commander'
 
 const program = new Command()
@@ -17,4 +17,9 @@ program
   .description('Generate changelog')
   .action(async (options) => changelog(options))
 
+program
+  .command('commit-lint <gitMessagePath>')
+  .description('Lint commit message')
+  .action(async (option) => commitLint(option))
+
 program.parse()

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   changelog: () => changelog,
+  commitLint: () => commitLint,
   release: () => release
 });
 module.exports = __toCommonJS(src_exports);
@@ -226,8 +227,57 @@ async function release(options) {
     process.exit(1);
   }
 }
+
+// src/commitLint.ts
+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
+
+Example:
+
+feat: add a new feature
+feat(ui/button): add a new feature in the ui/button scope
+
+fix: fix a bug
+fix(ui/button): fix a bug in the ui/button scope
+
+docs: fix an error in the documentation
+docs(ui/button): fix a documentation error in the ui/button scope
+
+Allowed types:
+- fix
+- feat
+- docs
+- perf
+- test
+- types
+- style
+- build
+- chore
+- release
+- refactor
+- 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`);
+    process.exit(1);
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   changelog,
+  commitLint,
   release
 });

package/dist/index.d.cts

@@ -10,4 +10,6 @@ interface ChangelogCommandOptions {
 }
 declare function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>;
 
-export { changelog, release };
+declare function commitLint(gitMessagePath: string): void;
+
+export { changelog, commitLint, release };

package/dist/index.d.ts

@@ -10,4 +10,6 @@ interface ChangelogCommandOptions {
 }
 declare function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>;
 
-export { changelog, release };
+declare function commitLint(gitMessagePath: string): void;
+
+export { changelog, commitLint, release };

package/dist/index.js

@@ -189,7 +189,56 @@ async function release(options) {
     process.exit(1);
   }
 }
+
+// src/commitLint.ts
+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
+
+Example:
+
+feat: add a new feature
+feat(ui/button): add a new feature in the ui/button scope
+
+fix: fix a bug
+fix(ui/button): fix a bug in the ui/button scope
+
+docs: fix an error in the documentation
+docs(ui/button): fix a documentation error in the ui/button scope
+
+Allowed types:
+- fix
+- feat
+- docs
+- perf
+- test
+- types
+- style
+- build
+- chore
+- release
+- refactor
+- 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`);
+    process.exit(1);
+  }
+}
 export {
   changelog,
+  commitLint,
   release
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@varlet/release",
   "type": "module",
-  "version": "0.0.3-alpha.1700239118439",
+  "version": "0.0.4",
   "description": "release all packages and generate changelogs",
   "keywords": [
     "varlet",
@@ -31,6 +31,14 @@
   "files": [
     "dist"
   ],
+  "simple-git-hooks": {
+    "pre-commit": "pnpm exec lint-staged --allow-empty --concurrent false",
+    "commit-msg": "pnpm run commit-lint $1"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,vue,less}": "prettier --write",
+    "*.{ts,tsx,js,vue}": "eslint --fix"
+  },
   "packageManager": "pnpm@8.7.5",
   "engines": {
     "node": ">=16.0.0",
@@ -44,28 +52,30 @@
     "@types/semver": "^7.5.5",
     "@varlet/eslint-config": "^2.18.4",
     "eslint": "^8.53.0",
+    "lint-staged": "^15.2.0",
     "prettier": "^3.1.0",
+    "simple-git-hooks": "^2.9.0",
+    "tsup": "^8.0.1",
     "typescript": "^5.2.2",
     "unbuild": "^2.0.0"
   },
   "dependencies": {
     "commander": "^11.1.0",
     "conventional-changelog": "^5.1.0",
-    "picocolors": "^1.0.0",
     "execa": "^8.0.1",
     "fs-extra": "^11.1.1",
     "glob": "^10.3.10",
     "inquirer": "^9.2.12",
     "nanospinner": "^1.1.0",
-    "rslog": "^1.1.0",
-    "semver": "^7.5.4",
-    "tsup": "^7.2.0"
+    "picocolors": "^1.0.0",
+    "semver": "^7.5.4"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",
     "dev": "tsup --watch",
     "build": "tsup",
     "release": "pnpm build && node bin/index.js release",
-    "lint": "eslint --ext .ts,.js"
+    "lint": "eslint --ext .ts,.js",
+    "commit-lint": "node bin/index.js commit-lint"
   }
 }