Skip to content

CLI ​

In the project, some command-line tools are provided for common operations, located in scripts.

vsh ​

Used for some project operations, such as cleaning the project, checking the project, etc.

Usage ​

bash
pnpm vsh [command] [options]

vsh check-circular ​

Check for circular references throughout the project. If there are circular references, the modules involved will be output to the console.

Usage ​

bash
pnpm vsh check-circular

Options ​

OptionDescription
--stagedOnly check files in the git staging area, default false

vsh check-dep ​

Check the dependency situation of the entire project and output unused dependencies, uninstalled dependencies information to the console.

Usage ​

bash
pnpm vsh check-dep

vsh lint ​

Lint checks the project to see if the code in the project conforms to standards.

Usage ​

bash
pnpm vsh lint

Options ​

OptionDescription
--formatCheck and try to fix errors, default false

vsh publint ​

Perform package standard checks on Monorepo projects to see if the packages in the project conform to standards.

Usage ​

bash
pnpm vsh publint

Options ​

OptionDescription
--checkOnly perform checks, default false

vsh code-workspace ​

Generate vben-admin.code-workspace file. Currently, it does not need to be executed manually and will be executed automatically when code is committed.

Usage ​

bash
pnpm vsh code-workspace

Options ​

OptionDescription
--auto-commitAutomatically commit during git commit, default false
--spacesIndentation format, default 2 spaces

turbo-run ​

Used to quickly execute scripts in the large repository and provide option-based interactive selection.

Usage ​

bash
pnpm turbo-run [command]

turbo-run dev ​

Quickly execute the dev command and provide option-based interactive selection.

Contributors

The avatar of contributor named as vince vince
The avatar of contributor named as invalid w invalid w
The avatar of contributor named as Li Kui Li Kui

Changelog

Released under the MIT License.