Skip to content

Commit 3db2bb1

Browse files
authored
Update README.md
1 parent 7713220 commit 3db2bb1

File tree

1 file changed

+0
-219
lines changed

1 file changed

+0
-219
lines changed

README.md

Lines changed: 0 additions & 219 deletions
Original file line numberDiff line numberDiff line change
@@ -100,126 +100,6 @@ export default defineConfig({
100100
});
101101
```
102102

103-
## verify 命令
104-
105-
校验 `COMMIT_EDITMSG` 中的信息是否符合 **Angualr** 规范, 支持命令模式和 **API** 模式;
106-
107-
使用场景: 用于校验正在执行 `git commit` 时所提交的信息是否符合规范.
108-
109-
### 命令模式
110-
111-
```bash
112-
codeg verify
113-
```
114-
115-
### API 模式
116-
117-
```typescript
118-
import { gitCommitVerify } from "code-genius";
119-
120-
(async () => {
121-
await gitCommitVerify();
122-
console.log("Git 提交信息校验通过, 正在执行后续逻辑...");
123-
})();
124-
```
125-
126-
## clear 命令
127-
128-
运行 `rimraf` 删除不再需要的文件或文件夹, 支持命令模式, 询问模式和 **API** 模式;
129-
130-
使用场景: 用于删除可以通过项目运行自动生成的文件, 如: `dist` 目录, 还有顽固的 `node_modules`.
131-
132-
### 命令模式
133-
134-
```bash
135-
# 删除 dist 文件夹
136-
codeg clear -p ./dist
137-
138-
# 删除 dist 和 node_modules 两个文件夹
139-
codeg clear -p ./dist -p ./node_modules
140-
```
141-
142-
| 选项 | 描述 |
143-
| ------------------------- | ------------ |
144-
| -p, --pattern \<pattern\> | 设置匹配规则 |
145-
| -a, --ask | 启用询问模式 |
146-
147-
### 询问模式
148-
149-
```bash
150-
# 启动询问模式
151-
codeg clear --ask
152-
```
153-
154-
```
155-
# 询问过程
156-
1. 请选择需要清理的文件/夹
157-
```
158-
159-
### API 模式
160-
161-
```typescript
162-
import { clear } from "code-genius";
163-
164-
(async () => {
165-
await clear(["./dist"]);
166-
})();
167-
```
168-
169-
### 配置文件
170-
171-
```typescript
172-
# 覆盖默认的 `files` 配置
173-
import { defineConfig } from "code-genius";
174-
175-
export default defineConfig({
176-
commands: {
177-
clear: {
178-
files: ["./dist"]
179-
},
180-
},
181-
});
182-
```
183-
184-
## template 命令
185-
186-
基于 **CodeGenius** 内置模板快速创建新项目, 仅支持询问模式;
187-
188-
使用场景: 用于创建青睐 **CodeGenius** 模板的新的项目 (目前模板为 `vitejs` 内置, 主要在模拟功能, 模板后续更新后可用).
189-
190-
### 询问模式
191-
192-
```bash
193-
# 启动询问模式(默认)
194-
codeg template
195-
```
196-
197-
```
198-
# 询问过程
199-
1. 请输入项目名称
200-
2. 请输入 package name
201-
3. 请选择下列的有效模板
202-
4. 请选择下列的有效变体
203-
```
204-
205-
```bash
206-
# 启动询问模式(带参)
207-
codeg template -n project-salkdyfT -f vue
208-
```
209-
210-
| 选项 | 描述 |
211-
| ----------------------------------- | -------- |
212-
| -n, --project-name \<project-name\> | 项目名称 |
213-
| -f, --framework \<framework\> | 项目框架 |
214-
215-
```
216-
# 询问过程
217-
1. 请输入项目名称 (-n 输入则仅需确认)
218-
2. 请输入 package name
219-
3. 请选择下列的有效模板 (-f 输入有效则跳过)
220-
4. 请选择下列的有效变体
221-
```
222-
223103
## fix 命令
224104

225105
运行 `eslint` 静态扫描和修复代码中存在的问题, 仅支持命令模式;
@@ -259,105 +139,6 @@ export default defineConfig({
259139
});
260140
```
261141

262-
## format 命令
263-
264-
运行 `prettier` 格式化代码风格, 仅支持命令模式;
265-
266-
使用场景: 用于替代 `prettier --write`, 功能雷同, 可以使用 **API** 模式来运行命令.
267-
268-
### 命令模式
269-
270-
```bash
271-
# 格式化 src 文件夹下的文件
272-
codeg format
273-
```
274-
275-
```bash
276-
# 格式化 src 和 components 文件夹下的文件
277-
codeg format -p ./src -p ./components
278-
```
279-
280-
| 选项 | 描述 |
281-
| ------------------------- | ------------ |
282-
| -p, --pattern \<pattern\> | 设置匹配规则 |
283-
284-
PS: 依赖 `prettier` CLI 模式, 同时对项目配置的 `.prettierignore``.prettierrc.json` 生效.
285-
286-
### 配置文件
287-
288-
```typescript
289-
# 覆盖默认的 `format` 配置
290-
import { defineConfig } from "code-genius";
291-
292-
export default defineConfig({
293-
commands: {
294-
format: {
295-
paths: ["./src", "./scripts"],
296-
},
297-
},
298-
});
299-
```
300-
301-
## impsort 命令
302-
303-
运行 `eslint` 对模块导入进行分组&按字母排序, 支持命令模式, 询问模式和 API 模式;
304-
305-
使用场景: 用于通过 `simple-import-sort` 插件来对导入模块进行排序且未直接配置插件到 `.eslintrc` 情况.
306-
307-
### 命令模式
308-
309-
```bash
310-
# 尝试修复 src 文件夹中模块的导入顺序
311-
codeg impsort -p ./src
312-
313-
# 尝试修复 src 和 components 文件夹中模块的导入顺序
314-
codeg impsort -p ./src -p ./components
315-
```
316-
317-
| 选项 | 描述 |
318-
| ------------------------- | ------------ |
319-
| -p, --pattern \<pattern\> | 设置匹配规则 |
320-
| -a, --ask | 启用询问模式 |
321-
322-
### 询问模式
323-
324-
```bash
325-
# 启动询问模式
326-
codeg impsort --ask
327-
```
328-
329-
```
330-
# 询问过程
331-
1. 请选择需要尝试修复的文件/夹
332-
```
333-
334-
### API 模式
335-
336-
```typescript
337-
import { impSort } from "../src/index";
338-
339-
(async () => {
340-
await impSort(["./src"]);
341-
})();
342-
```
343-
344-
PS: 依赖 `eslint` API 模式, 依赖 `simple-import-sort` 插件的同时依旧会读取项目配置的 `.eslintignore``.eslintrc.json` 文件, 使用 `impsort` 的同时将同步进行 `fix` 检测和修复.
345-
346-
### 配置文件
347-
348-
```typescript
349-
# 覆盖默认的 `impsort` 配置
350-
import { defineConfig } from "code-genius";
351-
352-
export default defineConfig({
353-
commands: {
354-
format: {
355-
impsort: ["./src", "./scripts"],
356-
},
357-
},
358-
});
359-
```
360-
361142
## script 命令
362143

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

0 commit comments

Comments
 (0)