commit-pack 1.1.9 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -26
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,3 +1,8 @@
1
+ <div align="right">
2
+
3
+ [English](./README_EN.md)
4
+
5
+ </div>
1
6
  # commit-pack
2
7
 
3
8
  自动化的项目代码质量和提交标准化设置。集成 ESLint、Prettier、Husky、lint-staged、commitlint 和 commitizen,执行代码风格检查和标准化提交消息。
@@ -16,63 +21,56 @@
16
21
 
17
22
  ## 🎬 Demo
18
23
 
19
- <p align="center">
20
- <video src="https://img.jett191.site/video/commitpack.mp4"
21
- controls
22
- muted
23
- width="800">
24
- </video>
25
- </p>
24
+ https://github.com/user-attachments/assets/8d99c810-81f2-4678-bf62-22bc5d2eee2a
25
+
26
+
26
27
 
27
28
  ## 🚀 快速开始
28
29
 
29
30
  ### 安装
31
+ 1. `pnpm`
30
32
  ```bash
31
- # 使用 pnpm
32
33
  pnpm add -D commit-pack@latest
33
34
  ```
34
-
35
+ 2. `bun`
35
36
  ```bash
36
- # 使用 bun
37
37
  bun add -d commit-pack@latest
38
38
  ```
39
-
39
+ 3. `npm`
40
40
  ```bash
41
- # 使用 npm
42
41
  npm install -D commit-pack@latest
43
42
  ```
44
-
43
+ 4. `yarn`
45
44
  ```bash
46
- # 使用 yarn
47
45
  yarn add -D commit-pack@latest
48
46
  ```
49
47
 
50
- ### 初始化
48
+ ### 在项目根目录初始化
49
+
50
+ 1. `pnpm`
51
51
  ```bash
52
- # 在项目根目录初始化
53
52
  pnpm exec commit-pack-init
54
53
  ```
55
-
54
+ 2. `bun`
56
55
  ```bash
57
- # 使用 bun
58
56
  bunx commit-pack-init
59
57
  ```
60
-
58
+ 3. `npm`
61
59
  ```bash
62
- # 使用 npx
63
60
  npx commit-pack-init
64
61
  ```
65
-
62
+ 4. `yarn`
66
63
  ```bash
67
- # 使用 yarn
68
64
  yarn dlx commit-pack-init
69
65
  ```
70
66
 
71
- ### Monorepo 支持
67
+ ### Monorepo
68
+ `为 monorepo 中的特定工作区初始化`
72
69
  ```bash
73
- # 为 monorepo 中的特定工作区初始化
74
70
  pnpm exec commit-pack-init -w workspace-name
75
- # 或
71
+
72
+
73
+
76
74
  pnpm exec commit-pack-init --workspace=workspace-name
77
75
  ```
78
76
 
@@ -262,4 +260,4 @@ module.exports = {
262
260
 
263
261
  ## ©️ 许可证
264
262
 
265
- 此项目根据 MIT 许可证授权 - 详见 [LICENSE](LICENSE) 文件。
263
+ 此项目根据 MIT 许可证授权 - 详见 [LICENSE](LICENSE) 文件。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "commit-pack",
3
- "version": "1.1.9",
3
+ "version": "1.2.1",
4
4
  "description": "A setup package to automatly check project's style and commit configuration",
5
5
  "main": "lib/index.js",
6
6
  "bin": {