| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667 |
- ---
- description: 项目 CLI 工具
- globs:
- alwaysApply: false
- ---
- # Vben 项目 CLI 工具
- 项目在 `scripts/` 目录下提供了一些命令行工具，用于简化常用操作。
- ## vsh (`pnpm vsh`)
- `vsh` 是一个用于项目级别操作的工具，例如代码检查、依赖管理等。
- 代码位于 [scripts/vsh/](mdc:scripts/vsh)
- ### 用法
- ```bash
- pnpm vsh [command] [options]
- ```
- ### `vsh check-circular`
- 检查整个项目的循环引用。如果存在循环引用，会在控制台输出相关模块。
- - 用法: `pnpm vsh check-circular`
- - 选项:
- - `--staged`: 只检查 Git 暂存区内的文件 (默认 `false`)
- ### `vsh check-dep`
- 检查项目依赖情况，并在控制台输出"未使用的依赖"、"未安装的依赖"信息。
- - 用法: `pnpm vsh check-dep`
- - 选项:
- - `-r, --recursive`: 递归删除整个项目 (默认 `true`)
- - `--del-lock`: 是否删除 `pnpm-lock.yaml` 文件 (默认 `true`)
- ### `vsh lint`
- 对项目进行 lint 检查，确保代码符合规范。
- - 用法: `pnpm vsh lint`
- - 选项:
- - `--format`: 检查并尝试修复错误 (默认 `false`)
- ### `vsh publint`
- 对 Monorepo 项目进行包规范检查。
- - 用法: `pnpm vsh publint`
- - 选项:
- - `--check`: 仅执行检查 (默认 `false`)
- ### `vsh code-workspace`
- 生成 `vben-admin.code-workspace` 文件。通常在代码提交时自动执行。
- - 用法: `pnpm vsh code-workspace`
- - 选项:
- - `--auto-commit`: Git commit 时自动提交 (默认 `false`)
- - `--spaces`: 缩进格式 (默认 2个缩进)
- ## turbo-run (`pnpm turbo-run`)
- 用于快速执行 Monorepo 大仓中的脚本，并提供选项式交互选择。
- 代码位于 [scripts/turbo-run/](mdc:scripts/turbo-run)
- ### 用法
- ```bash
- pnpm turbo-run [command]
- ```
- ### `turbo-run dev`
- 快速执行 `dev` 命令，并提供选项式交互选择子项目进行开发。
- ## 脚本目录
- 所有 CLI 相关脚本都位于 [scripts/](mdc:scripts) 目录下。
|
