@@ -30,6 +30,8 @@ code-genius --help
30
30
31
31
生成 ** Angualr** 规范的提交信息, 支持命令模式, 询问模式和 ** API** 模式;
32
32
33
+ 使用场景: 用于没有安装其他插件且对 ** Angualr** 规范不熟悉的情况下生成提交信息.
34
+
33
35
### 命令模式
34
36
35
37
``` bash
@@ -73,6 +75,8 @@ import { gitCommit } from "code-genius";
73
75
74
76
校验 ` COMMIT_EDITMSG ` 中的信息是否符合 ** Angualr** 规范, 支持命令模式和 ** API** 模式;
75
77
78
+ 使用场景: 用于校验正在执行 ` git commit ` 时所提交的信息是否符合规范.
79
+
76
80
### 命令模式
77
81
78
82
``` bash
@@ -94,6 +98,8 @@ import { gitCommitVerify } from "code-genius";
94
98
95
99
运行 ` rimraf ` 删除不再需要的文件或文件夹, 支持命令模式, 询问模式和 ** API** 模式;
96
100
101
+ 使用场景: 用于删除可以通过项目运行自动生成的文件, 如: ` dist ` 目录, 还有顽固的 ` node_modules ` .
102
+
97
103
### 命令模式
98
104
99
105
``` bash
@@ -134,6 +140,8 @@ import { clear } from "code-genius";
134
140
135
141
新增或修改 ` simple-git-hooks ` 配置后需要重新初始化, 支持命令模式和 ** API** 模式;
136
142
143
+ 使用场景: 用于 ` simple-git-hooks ` 来配置 ` git hooks ` 的使用, 方便初始化和更新时使用, 混用过 ` husky ` 的会按其文档进行删除操作.
144
+
137
145
### 命令模式
138
146
139
147
``` bash
@@ -154,6 +162,8 @@ import { gitInitSimpleHooks } from "code-genius";
154
162
155
163
运行 ` npm-check ` 检查过时的、不正确的和未使用的依赖项, 支持命令模式和 ** API** 模式;
156
164
165
+ 使用场景: 用于检测当前项目的依赖项安装情况.
166
+
157
167
### 命令模式
158
168
159
169
``` bash
@@ -174,6 +184,8 @@ import { npmDepCheck } from "code-genius";
174
184
175
185
切换 ** NPM** 镜像地址, 支持命令模式, 询问模式和 API 模式;
176
186
187
+ 使用场景: 用于没有安装其他插件且对于切换命令地址不熟悉的情况下切换常见的景象地址.
188
+
177
189
### 命令模式
178
190
179
191
``` bash
@@ -209,6 +221,8 @@ import { npmRegistry } from "code-genius";
209
221
210
222
设置或校验 ` git user ` 信息是否规范, 支持命令模式和 ** API** 模式;
211
223
224
+ 使用场景: 用于校验那些不应该出现的邮箱地址会名称出现在 ` git ` 提交记录中, 常见的使用公司内部邮箱提交 ` github ` 的开源项目, 这通常是不允许的.
225
+
212
226
### 命令模式
213
227
214
228
``` bash
@@ -254,9 +268,10 @@ import { setGitUserName, setGitUserEmail, checkGitUserInfo } from "code-genius";
254
268
255
269
## template 命令
256
270
257
- 快速创建 CodeGenius 基础项目
258
271
基于 ** CodeGenius** 内置模板快速创建新项目, 仅支持询问模式;
259
272
273
+ 使用场景: 用于创建青睐 ** CodeGenius** 模板的新的项目 (目前模板为 ` vitejs ` 内置, 主要在模拟功能, 模板后续更新后可用).
274
+
260
275
### 询问模式
261
276
262
277
``` bash
@@ -294,6 +309,8 @@ codeg template -n project-salkdyfT -f vue
294
309
295
310
运行 ` eslint ` 静态扫描和修复代码中存在的问题, 仅支持命令模式;
296
311
312
+ 使用场景: 用于替代 ` eslint --fix ` , 功能雷同, 可以使用 ** API** 模式来运行命令.
313
+
297
314
### 命令模式
298
315
299
316
``` bash
@@ -316,6 +333,8 @@ PS: 依赖 `eslint` CLI 模式, 同时对项目配置的 `.eslintignore` 和 `.e
316
333
317
334
运行 ` prettier ` 格式化代码风格, 仅支持命令模式;
318
335
336
+ 使用场景: 用于替代 ` prettier --write ` , 功能雷同, 可以使用 ** API** 模式来运行命令.
337
+
319
338
### 命令模式
320
339
321
340
``` bash
@@ -337,6 +356,8 @@ PS: 依赖 `prettier` CLI 模式, 同时对项目配置的 `.prettierignore` 和
337
356
338
357
运行 ` eslint ` 对模块导入进行分组&按字母排序, 支持命令模式, 询问模式和 API 模式;
339
358
359
+ 使用场景: 用于通过 ` simple-import-sort ` 插件来对导入模块进行排序且未直接配置插件到 ` .eslintrc ` 情况.
360
+
340
361
### 命令模式
341
362
342
363
``` bash
@@ -379,6 +400,8 @@ PS: 依赖 `eslint` API 模式, 依赖 `simple-import-sort` 插件的同时依
379
400
380
401
代理运行 ` package.scripts ` 脚本, 仅支持询问模式;
381
402
403
+ 使用场景: 用于项目有大量 ` scripts ` 的情况, 可以生成单独的配置文件用来注册每个 ` script ` 的作用, 并通过询问模式来执行对应的 ` script ` .
404
+
382
405
### 询问模式
383
406
384
407
``` bash
0 commit comments