@@ -126,23 +126,92 @@ import { clear } from "code-genius";
126126})();
127127```
128128
129+ ## hooks 命令
130+
131+ 新增或修改 ` simple-git-hooks ` 配置后需要重新初始化, 支持命令模式和 ** API** 模式;
132+
133+ ### 命令模式
134+
135+ ``` bash
136+ codeg hooks
137+ ```
138+
139+ ### API 模式
140+
141+ ``` typescript
142+ import { gitInitSimpleHooks } from " code-genius"
143+
144+ (async () => {
145+ await gitInitSimpleHooks ();
146+ })();
147+ ```
148+
149+ ## depcheck 命令
150+
151+ 运行 ` npm-check ` 检查过时的、不正确的和未使用的依赖项, 支持命令模式和 ** API** 模式;
152+
153+ ### 命令模式
154+
155+ ``` bash
156+ codeg depcheck
157+ ```
158+
159+ ### API 模式
160+
161+ ``` typescript
162+ import { npmDepCheck } from " code-genius"
163+
164+ (async () => {
165+ await npmDepCheck ();
166+ })();
167+ ```
168+
169+ ## registry 命令
170+
171+ 切换 ** NPM** 镜像地址, 支持命令模式, 询问模式和 API 模式;
172+
173+ ### 命令模式
174+
175+ ``` bash
176+ # 设置 npm 官方源
177+ codeg registry -u https://registry.npmjs.org/
178+ ```
179+
180+ ### 询问模式
181+
182+ ``` bash
183+ # 启动询问模式
184+ codeg registry
185+ ```
186+
187+ ```
188+ # 询问过程
189+ 1. 请选择 NPM 镜像
190+ ```
191+
192+ ### API 模式
193+
194+ ``` typescript
195+ import { npmRegistry } from " code-genius"
196+
197+ (async () => {
198+ await npmRegistry (" https://registry.npmjs.org/"
199+ })();
200+ ```
201+
202+
203+
129204## 命令
130205
131- | 命令 | 参数 | 默认值 | 功能描述 |
132- | ---------- | ---------------------------------------------------------------------------------------- | --------- | --------------------------------------------------- |
133- | commit | --no-emoji | true | 生成 angualr 规范的提交信息 |
134- | verify | -- | -- | 校验 COMMIT_EDITMSG 中的信息是否符合 Angualr 规范 |
135- | clear | --pattern \< pattern\> | './dist/' | 运行 rimraf 删除不再需要的文件或文件夹 |
136- | hooks | -- | -- | 新增或修改 simple-git-hooks 配置后需要重新初始化 |
137- | depcheck | -- | -- | 运行 npm-check 检查过时的、不正确的和未使用的依赖项 |
138- | registry | -- | -- | 切换 NPM 镜像地址 |
139- | fix | --pattern \< pattern\> | './src' | 运行 eslint 静态扫描和修复代码中存在的问题 |
140- | format | --pattern \< pattern\> | './src' | 运行 prettier 格式化代码风格 |
141- | create | -- | -- | 运行 npm create 快速创建基础项目 |
142- | template | -n, --project-name \< project-name\> , -f, --framework \< framework\> , | -- | 快速创建 CodeGenius 基础项目 |
143- | lighthouse | --url \< url\> | -- | 运行 lighthouse 分析及收集 Web 应用的性能指标 |
144- | git-user | -n, --name \< name\> ,-e, --email \< email\> ,--rule-name \< regexp\> ,--rule-email \< regexp\> | -- | 设置或校验 git user 信息是否规范 |
145- | quantity | -p, --path <path > | -- | 运行 cloc 分析并统计代码量 |
206+ | 命令 | 参数 | 默认值 | 功能描述 |
207+ | ---------- | ---------------------------------------------------------------------------------------- | ------- | --------------------------------------------------- |
208+ | fix | --pattern \< pattern\> | './src' | 运行 eslint 静态扫描和修复代码中存在的问题 |
209+ | format | --pattern \< pattern\> | './src' | 运行 prettier 格式化代码风格 |
210+ | create | -- | -- | 运行 npm create 快速创建基础项目 |
211+ | template | -n, --project-name \< project-name\> , -f, --framework \< framework\> , | -- | 快速创建 CodeGenius 基础项目 |
212+ | lighthouse | --url \< url\> | -- | 运行 lighthouse 分析及收集 Web 应用的性能指标 |
213+ | git-user | -n, --name \< name\> ,-e, --email \< email\> ,--rule-name \< regexp\> ,--rule-email \< regexp\> | -- | 设置或校验 git user 信息是否规范 |
214+ | quantity | -p, --path <path > | -- | 运行 cloc 分析并统计代码量 |
146215
147216## 执照
148217
0 commit comments