Skip to content

Commit baffef6

Browse files
committed
🔧 chore(app): 更新配置文件及说明文档
1 parent 3dc34a9 commit baffef6

File tree

2 files changed

+106
-0
lines changed

2 files changed

+106
-0
lines changed

README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,34 @@ import { gitCommit } from "code-genius";
7171
})();
7272
```
7373

74+
### 配置文件
75+
76+
```typescript
77+
# 覆盖默认的 `gitCommitTypes``gitCommitScopes` 配置
78+
import { defineConfig } from "code-genius";
79+
80+
export default defineConfig({
81+
commands: {
82+
commit: {
83+
gitCommitTypes: [
84+
{
85+
emoji: "🎉",
86+
code: "feat",
87+
description: "增加新功能/特性",
88+
},
89+
],
90+
gitCommitScopes: [
91+
{
92+
emoji: "🐛",
93+
code: "fix",
94+
description: "修复bug",
95+
},
96+
],
97+
},
98+
},
99+
});
100+
```
101+
74102
## verify 命令
75103

76104
校验 `COMMIT_EDITMSG` 中的信息是否符合 **Angualr** 规范, 支持命令模式和 **API** 模式;
@@ -136,6 +164,21 @@ import { clear } from "code-genius";
136164
})();
137165
```
138166

167+
### 配置文件
168+
169+
```typescript
170+
# 覆盖默认的 `files` 配置
171+
import { defineConfig } from "code-genius";
172+
173+
export default defineConfig({
174+
commands: {
175+
clear: {
176+
files: ["./dist"]
177+
},
178+
},
179+
});
180+
```
181+
139182
## hooks 命令
140183

141184
新增或修改 `simple-git-hooks` 配置后需要重新初始化, 支持命令模式和 **API** 模式;
@@ -266,6 +309,21 @@ import { setGitUserName, setGitUserEmail, checkGitUserInfo } from "code-genius";
266309
})();
267310
```
268311

312+
### 配置文件
313+
314+
```typescript
315+
# 覆盖默认的 `gituser` 配置
316+
import { defineConfig } from "code-genius";
317+
318+
export default defineConfig({
319+
commands: {
320+
gituser: {
321+
ruleEmail: "^[a-zA-Z0-9._%+-]+@(gmail)\\.(com)$",
322+
},
323+
},
324+
});
325+
```
326+
269327
## template 命令
270328

271329
基于 **CodeGenius** 内置模板快速创建新项目, 仅支持询问模式;
@@ -329,6 +387,21 @@ codeg fix -p ./src -p ./components
329387

330388
PS: 依赖 `eslint` CLI 模式, 同时对项目配置的 `.eslintignore``.eslintrc.json` 生效.
331389

390+
### 配置文件
391+
392+
```typescript
393+
# 覆盖默认的 `fix` 配置
394+
import { defineConfig } from "code-genius";
395+
396+
export default defineConfig({
397+
commands: {
398+
fix: {
399+
paths: ["./src", "./scripts"],
400+
},
401+
},
402+
});
403+
```
404+
332405
## format 命令
333406

334407
运行 `prettier` 格式化代码风格, 仅支持命令模式;
@@ -352,6 +425,21 @@ codeg format -p ./src -p ./components
352425

353426
PS: 依赖 `prettier` CLI 模式, 同时对项目配置的 `.prettierignore``.prettierrc.json` 生效.
354427

428+
### 配置文件
429+
430+
```typescript
431+
# 覆盖默认的 `format` 配置
432+
import { defineConfig } from "code-genius";
433+
434+
export default defineConfig({
435+
commands: {
436+
format: {
437+
paths: ["./src", "./scripts"],
438+
},
439+
},
440+
});
441+
```
442+
355443
## impsort 命令
356444

357445
运行 `eslint` 对模块导入进行分组&按字母排序, 支持命令模式, 询问模式和 API 模式;
@@ -396,6 +484,21 @@ import { impSort } from "../src/index";
396484

397485
PS: 依赖 `eslint` API 模式, 依赖 `simple-import-sort` 插件的同时依旧会读取项目配置的 `.eslintignore``.eslintrc.json` 文件, 使用 `impsort` 的同时将同步进行 `fix` 检测和修复.
398486

487+
### 配置文件
488+
489+
```typescript
490+
# 覆盖默认的 `impsort` 配置
491+
import { defineConfig } from "code-genius";
492+
493+
export default defineConfig({
494+
commands: {
495+
format: {
496+
impsort: ["./src", "./scripts"],
497+
},
498+
},
499+
});
500+
```
501+
399502
## script 命令
400503

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

codeg.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ export default defineConfig({
55
gituser: {
66
ruleEmail: "^[a-zA-Z0-9._%+-]+@(gmail)\\.(com)$",
77
},
8+
clear: {
9+
files: ["./dist"]
10+
},
811
fix: {
912
paths: ["./src", "./scripts"],
1013
},

0 commit comments

Comments
 (0)