Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,20 @@ Arguments:
[ROOT] Project root directory (default: current directory)

Options:
--host [HOST] Specify hostname
--port <PORT> Specify port
--open [PATH] Open browser on startup
--strictPort Exit if specified port is already in use
-c, --config <FILE> Use specified config file
--base <PATH> Public base path
-m, --mode <MODE> Set env mode
-h, --help Print help
--host [HOST] Specify hostname
--port <PORT> Specify port
--open [PATH] Open browser on startup
--cors Enable CORS
--strictPort Exit if specified port is already in use
--force Ignore the optimizer cache and re-bundle
--experimentalBundle Use experimental full bundle mode
--base <PATH> Public base path
-l, --logLevel <LEVEL> Set log level
--clearScreen Allow or disable clearing the screen
-d, --debug [FEAT] Show debug logs
-f, --filter <FILTER> Filter debug logs
-m, --mode <MODE> Set env mode
-h, --help Print help

Examples:
vp dev
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,42 +68,38 @@ Finished in <duration> on 1 files using <n> threads.
the local path checks the original `help` spelling; the global CLI renders help before local delegation

```
note: You are running `vp help` as a Vite+ built-in command. If you meant to run the help npm script, use `vpr help` instead.
vp/<version>
VITE+ - The Unified Toolchain for the Web

Usage:
$ vp [root]
Usage: vp dev [ROOT] [OPTIONS]

Commands:
[root] start dev server
build [root] build for production
optimize [root] pre-bundle dependencies (deprecated, the pre-bundle process runs automatically and does not need to be called)
preview [root] locally preview production build
Run the development server.
Options are forwarded to Vite.

For more info, run any command with the `--help` flag:
$ vp --help
$ vp build --help
$ vp optimize --help
$ vp preview --help
Arguments:
[ROOT] Project root directory (default: current directory)

Options:
--host [host] [string] specify hostname
--port <port> [number] specify port
--open [path] [boolean | string] open browser on startup
--cors [boolean] enable CORS
--strictPort [boolean] exit if specified port is already in use
--force [boolean] force the optimizer to ignore the cache and re-bundle
--experimentalBundle [boolean] use experimental full bundle mode (this is highly experimental)
-c, --config <file> [string] use specified config file
--base <path> [string] public base path (default: /)
-l, --logLevel <level> [string] info | warn | error | silent
--clearScreen [boolean] allow/disable clear screen when logging
--configLoader <loader> [string] use 'bundle' to bundle the config with Rolldown, or 'runner' (experimental) to process it on the fly, or 'native' (experimental) to load using the native runtime (default: bundle)
-d, --debug [feat] [string | boolean] show debug logs
-f, --filter <filter> [string] filter debug logs
-m, --mode <mode> [string] set env mode
-h, --help Display this message
-v, --version Display version number
--host [HOST] Specify hostname
--port <PORT> Specify port
--open [PATH] Open browser on startup
--cors Enable CORS
--strictPort Exit if specified port is already in use
--force Ignore the optimizer cache and re-bundle
--experimentalBundle Use experimental full bundle mode
--base <PATH> Public base path
-l, --logLevel <LEVEL> Set log level
--clearScreen Allow or disable clearing the screen
-d, --debug [FEAT] Show debug logs
-f, --filter <FILTER> Filter debug logs
-m, --mode <MODE> Set env mode
-h, --help Print help

Examples:
vp dev
vp dev --open
vp dev --host localhost --port 5173

Documentation: https://viteplus.dev/guide/dev
```

## `vp preview --port 12312312312`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Usage: vp check [OPTIONS] [PATHS]...

Run format, lint, and type checks.

Arguments:
[PATHS]... File paths to pass to fmt and lint

Options:
--fix Auto-fix format and lint issues
--no-fmt Skip format check
Expand All @@ -33,6 +36,9 @@ Usage: vp check [OPTIONS] [PATHS]...

Run format, lint, and type checks.

Arguments:
[PATHS]... File paths to pass to fmt and lint

Options:
--fix Auto-fix format and lint issues
--no-fmt Skip format check
Expand All @@ -57,6 +63,9 @@ Usage: vp check [OPTIONS] [PATHS]...

Run format, lint, and type checks.

Arguments:
[PATHS]... File paths to pass to fmt and lint

Options:
--fix Auto-fix format and lint issues
--no-fmt Skip format check
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,18 @@ Arguments:
[COMMAND]... Command and arguments to execute

Options:
-r, --recursive Select all packages in the workspace
-t, --transitive Select the current package and its transitive dependencies
-w, --workspace-root Select the workspace root package
-F, --filter <FILTERS> Match packages by name, directory, or glob pattern
--fail-if-no-match Exit with a non-zero status if a filter matches no packages
-c, --shell-mode Execute the command within a shell environment
--parallel Run concurrently without topological ordering
--reverse Reverse execution order
--resume-from <RESUME_FROM> Resume from a specific package
--report-summary Save results to vp-exec-summary.json
-h, --help Print help (see more with '--help')
-r, --recursive Select all packages in the workspace
-t, --transitive Select the current package and its transitive dependencies
-w, --workspace-root Select the workspace root package
-F, --filter <FILTERS> Match packages by name, directory, or glob pattern
--fail-if-no-match Exit with a non-zero status if a `--filter` expression matches no packages
Without this flag, unmatched filters only warn and exit successfully
-c, --shell-mode Execute the command within a shell environment
--parallel Run concurrently without topological ordering
--reverse Reverse execution order
--resume-from <PACKAGE> Resume from a specific package
--report-summary Save results to vp-exec-summary.json
-h, --help Print help

Filter Patterns:
--filter <pattern> Select by package name (e.g. foo, @scope/*)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,64 +64,46 @@ hello from subdir
help message

```
Execute a command from local node_modules/.bin
VITE+ - The Unified Toolchain for the Web

Usage: vp exec [OPTIONS] [COMMAND]...

Execute a command from local node_modules/.bin.

Arguments:
[COMMAND]...
Command and arguments to execute
[COMMAND]... Command and arguments to execute

Options:
-r, --recursive
Select all packages in the workspace

-t, --transitive
Select the current package and its transitive dependencies

-w, --workspace-root
Select the workspace root package

-F, --filter <FILTERS>
Match packages by name, directory, or glob pattern.

--filter <pattern> Select by package name (e.g. foo, @scope/*)
--filter ./<dir> Select packages under a directory
--filter {<dir>} Same as ./<dir>, but allows traversal suffixes
--filter <pattern>... Select package and its dependencies
--filter ...<pattern> Select package and its dependents
--filter <pattern>^... Select only the dependencies (exclude the package itself)
--filter !<pattern> Exclude packages matching the pattern

--fail-if-no-match
Exit with a non-zero status if a `--filter` expression matches no packages.

Without this flag, an unmatched filter (a typo, an empty glob, or a traversal like `{.}^...` that collapses to zero on a leaf package) only produces a warning and the command exits successfully.

-c, --shell-mode
Execute the command within a shell environment

--parallel
Run concurrently without topological ordering

--reverse
Reverse execution order

--resume-from <RESUME_FROM>
Resume from a specific package

--report-summary
Save results to vp-exec-summary.json

-h, --help
Print help (see a summary with '-h')
-r, --recursive Select all packages in the workspace
-t, --transitive Select the current package and its transitive dependencies
-w, --workspace-root Select the workspace root package
-F, --filter <FILTERS> Match packages by name, directory, or glob pattern
--fail-if-no-match Exit with a non-zero status if a `--filter` expression matches no packages
Without this flag, unmatched filters only warn and exit successfully
-c, --shell-mode Execute the command within a shell environment
--parallel Run concurrently without topological ordering
--reverse Reverse execution order
--resume-from <PACKAGE> Resume from a specific package
--report-summary Save results to vp-exec-summary.json
-h, --help Print help

Filter Patterns:
--filter <pattern> Select by package name (e.g. foo, @scope/*)
--filter ./<dir> Select packages under a directory
--filter {<dir>} Same as ./<dir>, but allows traversal suffixes
--filter <pattern>... Select package and its dependencies
--filter ...<pattern> Select package and its dependents
--filter <pattern>^... Select only the dependencies (exclude the package itself)
--filter !<pattern> Exclude packages matching the pattern

Examples:
vp exec node --version # Run local node
vp exec tsc --noEmit # Run local TypeScript compiler
vp exec -c 'tsc --noEmit && prettier --check .' # Shell mode
vp exec -r -- tsc --noEmit # Run in all workspace packages
vp exec --filter 'app...' -- tsc # Run in filtered packages

Documentation: https://viteplus.dev/guide/vpx
```

## `vp exec`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ steps = [
{ argv = ["vp", "fmt", "-h"], continue-on-failure = true },
{ argv = ["vp", "fmt", "--help"], continue-on-failure = true },
{ argv = ["vp", "help", "fmt"], continue-on-failure = true },
{ argv = ["vp", "format", "--help"], continue-on-failure = true },
]
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,27 @@ Usage: vp fmt [PATH]... [OPTIONS]
Format code.
Options are forwarded to Oxfmt.

Arguments:
[PATH]... Files, directories, or glob patterns (default: current directory)

Mode Options:
--stdin-filepath <PATH> Specify the file name used to infer the parser for stdin

Output Options:
--write Format and write files in place
--check Check whether files are formatted and show statistics
--list-different List files that would be changed

Ignore Options:
--ignore-path <PATH> Path to an ignore file; may be specified multiple times
--with-node-modules Format files in node_modules, which are skipped by default

Runtime Options:
--no-error-on-unmatched-pattern Do not exit with an error when the pattern is unmatched
--threads <INT> Number of threads to use; set to 1 to use one CPU core

Options:
--write Format and write files in place
--check Check if files are formatted
--list-different List files that would be changed
--ignore-path <PATH> Path to ignore file(s)
--threads <INT> Number of threads to use
-h, --help Print help
-h, --help Print help information

Examples:
vp fmt
Expand All @@ -36,13 +50,27 @@ Usage: vp fmt [PATH]... [OPTIONS]
Format code.
Options are forwarded to Oxfmt.

Arguments:
[PATH]... Files, directories, or glob patterns (default: current directory)

Mode Options:
--stdin-filepath <PATH> Specify the file name used to infer the parser for stdin

Output Options:
--write Format and write files in place
--check Check whether files are formatted and show statistics
--list-different List files that would be changed

Ignore Options:
--ignore-path <PATH> Path to an ignore file; may be specified multiple times
--with-node-modules Format files in node_modules, which are skipped by default

Runtime Options:
--no-error-on-unmatched-pattern Do not exit with an error when the pattern is unmatched
--threads <INT> Number of threads to use; set to 1 to use one CPU core

Options:
--write Format and write files in place
--check Check if files are formatted
--list-different List files that would be changed
--ignore-path <PATH> Path to ignore file(s)
--threads <INT> Number of threads to use
-h, --help Print help
-h, --help Print help information

Examples:
vp fmt
Expand All @@ -62,13 +90,67 @@ Usage: vp fmt [PATH]... [OPTIONS]
Format code.
Options are forwarded to Oxfmt.

Arguments:
[PATH]... Files, directories, or glob patterns (default: current directory)

Mode Options:
--stdin-filepath <PATH> Specify the file name used to infer the parser for stdin

Output Options:
--write Format and write files in place
--check Check whether files are formatted and show statistics
--list-different List files that would be changed

Ignore Options:
--ignore-path <PATH> Path to an ignore file; may be specified multiple times
--with-node-modules Format files in node_modules, which are skipped by default

Runtime Options:
--no-error-on-unmatched-pattern Do not exit with an error when the pattern is unmatched
--threads <INT> Number of threads to use; set to 1 to use one CPU core

Options:
-h, --help Print help information

Examples:
vp fmt
vp fmt src --check
vp fmt . --write

Documentation: https://viteplus.dev/guide/fmt
```

## `vp format --help`

```
VITE+ - The Unified Toolchain for the Web

Usage: vp fmt [PATH]... [OPTIONS]

Format code.
Options are forwarded to Oxfmt.

Arguments:
[PATH]... Files, directories, or glob patterns (default: current directory)

Mode Options:
--stdin-filepath <PATH> Specify the file name used to infer the parser for stdin

Output Options:
--write Format and write files in place
--check Check whether files are formatted and show statistics
--list-different List files that would be changed

Ignore Options:
--ignore-path <PATH> Path to an ignore file; may be specified multiple times
--with-node-modules Format files in node_modules, which are skipped by default

Runtime Options:
--no-error-on-unmatched-pattern Do not exit with an error when the pattern is unmatched
--threads <INT> Number of threads to use; set to 1 to use one CPU core

Options:
--write Format and write files in place
--check Check if files are formatted
--list-different List files that would be changed
--ignore-path <PATH> Path to ignore file(s)
--threads <INT> Number of threads to use
-h, --help Print help
-h, --help Print help information

Examples:
vp fmt
Expand Down
Loading
Loading