Skip to content

Commit 86cf493

Browse files
branchseerclaude
andcommitted
docs: reword PackageQueryArgs help to be command-agnostic
The flags are shared by `vp run` and future commands like `vp exec`, so the help text should not mention "tasks". Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6fce91e commit 86cf493

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

crates/vite_workspace/src/package_filter.rs

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -213,20 +213,34 @@ pub enum PackageQueryError {
213213
/// Call [`into_package_query`](Self::into_package_query) to convert into an opaque [`PackageQuery`].
214214
#[derive(Debug, Clone, clap::Args)]
215215
pub struct PackageQueryArgs {
216-
/// Run tasks found in all packages in the workspace, in topological order based on package dependencies.
216+
/// Select all packages in the workspace.
217217
#[clap(default_value = "false", short, long)]
218218
recursive: bool,
219219

220-
/// Run tasks found in the current package and all its transitive dependencies, in topological order based on package dependencies.
220+
/// Select the current package and its transitive dependencies.
221221
#[clap(default_value = "false", short, long)]
222222
transitive: bool,
223223

224-
/// Run task in the workspace root package.
224+
/// Select the workspace root package.
225225
#[clap(default_value = "false", short = 'w', long = "workspace-root")]
226226
workspace_root: bool,
227227

228-
/// Filter packages (pnpm --filter syntax). Can be specified multiple times.
229-
#[clap(short = 'F', long, num_args = 1)]
228+
/// Match packages by name, directory, or glob pattern.
229+
#[clap(
230+
short = 'F',
231+
long,
232+
num_args = 1,
233+
long_help = "\
234+
Match packages by name, directory, or glob pattern.
235+
236+
--filter <pattern> Select by package name (e.g. foo, @scope/*)
237+
--filter ./<dir> Select packages under a directory
238+
--filter {<dir>} Same as ./<dir>, but allows traversal suffixes
239+
--filter <pattern>... Select package and its dependencies
240+
--filter ...<pattern> Select package and its dependents
241+
--filter <pattern>^... Select only the dependencies (exclude the package itself)
242+
--filter !<pattern> Exclude packages matching the pattern"
243+
)]
230244
filter: Vec<Str>,
231245
}
232246

0 commit comments

Comments
 (0)