You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rename the user-facing CLI binary and all command references from `vite`
to `vp`. Internal crate names, `vite-task.json` config, `VITE_*` env
vars, and `vpr` shorthand are unchanged.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: crates/vite_task/docs/terminologies.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,4 +31,4 @@ The two task groups generates 3 tasks:
31
31
32
32
These are **task names**. They are for displaying and filtering.
33
33
34
-
The user could execute `vite run build` under the `app` package, or execute `vite run app#build` from anywhere. The parameter `build` and `app#build` after `vite run` are **task requests**. They are used to match against task names to determine what tasks to run.
34
+
The user could execute `vp run build` under the `app` package, or execute `vp run app#build` from anywhere. The parameter `build` and `app#build` after `vp run` are **task requests**. They are used to match against task names to determine what tasks to run.
Copy file name to clipboardExpand all lines: crates/vite_task/docs/vite-run.md
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
-
# `vite-plus run`
1
+
# `vp run`
2
2
3
3
Vite-plus run has two modes:
4
4
5
-
1. Implicit mode is running `vite-plus` without `run` command, it will run the task in the current package, it supposed to replace the `pnpm/yarn run` command.
6
-
2. Explicit mode is running `vite-plus run` with run command, like `vite-plus run vite-plus#build`.
5
+
1. Implicit mode is running `vp` without `run` command, it will run the task in the current package, it supposed to replace the `pnpm/yarn run` command.
6
+
2. Explicit mode is running `vp run` with run command, like `vp run vite-plus#build`.
7
7
8
8
## Implicit mode
9
9
@@ -15,7 +15,7 @@ Vite-plus run has two modes:
15
15
>
16
16
> This documentation describes the current behavior and should be updated when the Implicit Mode RFC is done.
17
17
18
-
With implicit mode, `vite` will run the task in the current package. It can't accept more than on task. The first argument will be treated as the task name; the args following the command will be treated as the task args and bypass to the task.
18
+
With implicit mode, `vp` will run the task in the current package. It can't accept more than on task. The first argument will be treated as the task name; the args following the command will be treated as the task args and bypass to the task.
19
19
20
20
Given the following `package.json` file:
21
21
@@ -31,54 +31,54 @@ Given the following `package.json` file:
31
31
This command equivalent to `vite build`:
32
32
33
33
```bash
34
-
vite-plus build
34
+
vp build
35
35
```
36
36
37
37
This command equivalent to `vite build --mode production`:
38
38
39
39
```bash
40
-
vite-plus build --mode production
40
+
vp build --mode production
41
41
```
42
42
43
43
This command equivalent to `oxlint packages/cli/binding/index.js`:
44
44
45
45
```bash
46
-
vite-plus lint packages/cli/binding/index.js
46
+
vp lint packages/cli/binding/index.js
47
47
```
48
48
49
49
If the command contains `#`, the command will be treated as a task in the workspace subpackage.
50
50
51
-
This command equivalent to `vite-plus run cli#build`:
51
+
This command equivalent to `vp run cli#build`:
52
52
53
53
```bash
54
-
vite-plus cli#build
54
+
vp cli#build
55
55
```
56
56
57
57
## Explicit mode
58
58
59
-
With explicit mode, `vite-plus run` will run the task in the workspace subpackage. It can accept more than one task. The arguments will be treated as the task names; the args following the `--` will be treated as the task args and bypass to the task.
59
+
With explicit mode, `vp run` will run the task in the workspace subpackage. It can accept more than one task. The arguments will be treated as the task names; the args following the `--` will be treated as the task args and bypass to the task.
60
60
61
61
### Default behavior
62
62
63
-
The `vite-plus run` command will run the scoped tasks in dependency order.
63
+
The `vp run` command will run the scoped tasks in dependency order.
64
64
65
65
Task names without `#` will be resolved in the current package (the package containing the nearest package.json file from the current working directory). For example:
66
66
67
-
-`vite-plus run build` - runs the build task in the current package
68
-
-`vite-plus run test lint` - Throw `OnlyOneTaskRequest` error
69
-
-`vite-plus run @other/package#build` - runs the build task in @other/package
67
+
-`vp run build` - runs the build task in the current package
68
+
-`vp run test lint` - Throw `OnlyOneTaskRequest` error
69
+
-`vp run @other/package#build` - runs the build task in @other/package
70
70
71
71
Behaviors when the package root and/or the workspace root is not found:
| found | not found | No possible: workspace root always fallbacks to package root. |
76
+
| not found | found |`vp run build` should throw an `CurrentPackageNotFound` error. `vp run @other/package#build` is still allowed |
77
+
| not found | not found | Throw an error on any `vp run`. The workspace root must always exist as it's where we store the cache. |
78
78
79
79
### `--recursive,-r`
80
80
81
-
With the `--recursive,-r` flag, the `vite-plus run` command will run the tasks in all monorepo packages.
81
+
With the `--recursive,-r` flag, the `vp run` command will run the tasks in all monorepo packages.
82
82
83
83
The task name should't contain `#` with the `--recursive,-r` flag. If any task name contains `#`, it would cause an `RecursiveRunWithScope` error.
84
84
@@ -98,16 +98,16 @@ Examples:
98
98
99
99
```bash
100
100
# Recursive build with topological ordering (default)
101
-
vite-plus run build -r
101
+
vp run build -r
102
102
103
103
# Recursive build WITHOUT topological ordering
104
-
vite-plus run build -r --no-topological
104
+
vp run build -r --no-topological
105
105
106
106
# Single package with topological ordering enabled
107
-
vite-plus run app#build -t
107
+
vp run app#build -t
108
108
109
109
# Multiple packages without topological ordering (default)
110
-
vite-plus run app#build web#build
110
+
vp run app#build web#build
111
111
```
112
112
113
113
Note: `--topological` and `--no-topological` are mutually exclusive and cannot be used together. See [boolean-flags.md](./boolean-flags.md) for more information about boolean flag patterns.
@@ -172,7 +172,7 @@ Task Dependencies (explicit):
172
172
utils#build → utils#test
173
173
```
174
174
175
-
The execution flow for `vite-plus run build -r --topological`:
175
+
The execution flow for `vp run build -r --topological`:
@@ -342,12 +342,12 @@ The final step creates an execution plan:
342
342
343
343
Task requests are in form of `task_name` or `pkg#task_name`. They occur in two places:
344
344
345
-
- one or multiple parameters following after `vite run`.
345
+
- one or multiple parameters following after `vp run`.
346
346
- items in `dependsOn`.
347
347
348
348
How task requests work:
349
349
350
-
-`build` in `vite run build` matches task `build` in the current package determined by cwd.
350
+
-`build` in `vp run build` matches task `build` in the current package determined by cwd.
351
351
-`build` in `dependsOn: ["build"]` matches task `build` in the package where the config file is.
352
352
-`app#build` matches task `build` in package `app`.
353
353
-`app#build` raises an error if there are multiple packages named `app`.
@@ -357,4 +357,4 @@ How task requests work:
357
357
-`#build` raises an error if there are multiple nameless packages.
358
358
-`build` does not match task `build` in the nameless package.
359
359
360
-
While task requests with multiple `#` are invalid, packages with `#` in their names are valid. For example, a package named `pkg#special` can have a task named `build`. It can be referenced by executing `vite run build` under the folder of package `pkg#special`.
360
+
While task requests with multiple `#` are invalid, packages with `#` in their names are valid. For example, a package named `pkg#special` can have a task named `build`. It can be referenced by executing `vp run build` under the folder of package `pkg#special`.
0 commit comments