Skip to content

Commit 5bbf524

Browse files
committed
📚 docs(docs): 更新文档
1 parent c63bd70 commit 5bbf524

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ code-genius --help
3030

3131
生成 **Angualr** 规范的提交信息, 支持命令模式, 询问模式和 **API** 模式;
3232

33+
使用场景: 用于没有安装其他插件且对 **Angualr** 规范不熟悉的情况下生成提交信息.
34+
3335
### 命令模式
3436

3537
```bash
@@ -73,6 +75,8 @@ import { gitCommit } from "code-genius";
7375

7476
校验 `COMMIT_EDITMSG` 中的信息是否符合 **Angualr** 规范, 支持命令模式和 **API** 模式;
7577

78+
使用场景: 用于校验正在执行 `git commit` 时所提交的信息是否符合规范.
79+
7680
### 命令模式
7781

7882
```bash
@@ -94,6 +98,8 @@ import { gitCommitVerify } from "code-genius";
9498

9599
运行 `rimraf` 删除不再需要的文件或文件夹, 支持命令模式, 询问模式和 **API** 模式;
96100

101+
使用场景: 用于删除可以通过项目运行自动生成的文件, 如: `dist` 目录, 还有顽固的 `node_modules`.
102+
97103
### 命令模式
98104

99105
```bash
@@ -134,6 +140,8 @@ import { clear } from "code-genius";
134140

135141
新增或修改 `simple-git-hooks` 配置后需要重新初始化, 支持命令模式和 **API** 模式;
136142

143+
使用场景: 用于 `simple-git-hooks` 来配置 `git hooks` 的使用, 方便初始化和更新时使用, 混用过 `husky` 的会按其文档进行删除操作.
144+
137145
### 命令模式
138146

139147
```bash
@@ -154,6 +162,8 @@ import { gitInitSimpleHooks } from "code-genius";
154162

155163
运行 `npm-check` 检查过时的、不正确的和未使用的依赖项, 支持命令模式和 **API** 模式;
156164

165+
使用场景: 用于检测当前项目的依赖项安装情况.
166+
157167
### 命令模式
158168

159169
```bash
@@ -174,6 +184,8 @@ import { npmDepCheck } from "code-genius";
174184

175185
切换 **NPM** 镜像地址, 支持命令模式, 询问模式和 API 模式;
176186

187+
使用场景: 用于没有安装其他插件且对于切换命令地址不熟悉的情况下切换常见的景象地址.
188+
177189
### 命令模式
178190

179191
```bash
@@ -209,6 +221,8 @@ import { npmRegistry } from "code-genius";
209221

210222
设置或校验 `git user` 信息是否规范, 支持命令模式和 **API** 模式;
211223

224+
使用场景: 用于校验那些不应该出现的邮箱地址会名称出现在 `git` 提交记录中, 常见的使用公司内部邮箱提交 `github` 的开源项目, 这通常是不允许的.
225+
212226
### 命令模式
213227

214228
```bash
@@ -254,9 +268,10 @@ import { setGitUserName, setGitUserEmail, checkGitUserInfo } from "code-genius";
254268

255269
## template 命令
256270

257-
快速创建 CodeGenius 基础项目
258271
基于 **CodeGenius** 内置模板快速创建新项目, 仅支持询问模式;
259272

273+
使用场景: 用于创建青睐 **CodeGenius** 模板的新的项目 (目前模板为 `vitejs` 内置, 主要在模拟功能, 模板后续更新后可用).
274+
260275
### 询问模式
261276

262277
```bash
@@ -294,6 +309,8 @@ codeg template -n project-salkdyfT -f vue
294309

295310
运行 `eslint` 静态扫描和修复代码中存在的问题, 仅支持命令模式;
296311

312+
使用场景: 用于替代 `eslint --fix`, 功能雷同, 可以使用 **API** 模式来运行命令.
313+
297314
### 命令模式
298315

299316
```bash
@@ -316,6 +333,8 @@ PS: 依赖 `eslint` CLI 模式, 同时对项目配置的 `.eslintignore` 和 `.e
316333

317334
运行 `prettier` 格式化代码风格, 仅支持命令模式;
318335

336+
使用场景: 用于替代 `prettier --write`, 功能雷同, 可以使用 **API** 模式来运行命令.
337+
319338
### 命令模式
320339

321340
```bash
@@ -337,6 +356,8 @@ PS: 依赖 `prettier` CLI 模式, 同时对项目配置的 `.prettierignore` 和
337356

338357
运行 `eslint` 对模块导入进行分组&按字母排序, 支持命令模式, 询问模式和 API 模式;
339358

359+
使用场景: 用于通过 `simple-import-sort` 插件来对导入模块进行排序且未直接配置插件到 `.eslintrc` 情况.
360+
340361
### 命令模式
341362

342363
```bash
@@ -379,6 +400,8 @@ PS: 依赖 `eslint` API 模式, 依赖 `simple-import-sort` 插件的同时依
379400

380401
代理运行 `package.scripts` 脚本, 仅支持询问模式;
381402

403+
使用场景: 用于项目有大量 `scripts` 的情况, 可以生成单独的配置文件用来注册每个 `script` 的作用, 并通过询问模式来执行对应的 `script`.
404+
382405
### 询问模式
383406

384407
```bash

0 commit comments

Comments
 (0)