Skip to content

Commit a285687

Browse files
branchseerclaude
andcommitted
docs: replace fspy references with user-friendly language in inputs config
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 758c519 commit a285687

3 files changed

Lines changed: 18 additions & 18 deletions

File tree

crates/vite_task_graph/run-config.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,21 @@ export type Task = {
3030
*/
3131
passThroughEnvs?: Array<string>;
3232
/**
33-
* Input patterns for cache fingerprinting.
33+
* Files to include in the cache fingerprint.
3434
*
35-
* - Omitted: defaults to `[{auto: true}]` - infer from file accesses
36-
* - Empty array: no inputs, inference disabled
37-
* - Glob strings: explicit files to fingerprint
38-
* - `{auto: true}`: enable automatic inference via fspy
39-
* - Negative globs: exclude files (prefix with `!`)
35+
* - Omitted: automatically tracks which files the task reads
36+
* - `[]` (empty): disables file tracking entirely
37+
* - Glob patterns (e.g. `"src/**"`) select specific files
38+
* - `{auto: true}` enables automatic file tracking
39+
* - Negative patterns (e.g. `"!dist/**"`) exclude matched files
4040
*
41-
* Globs are relative to the package directory where the task is defined.
41+
* Patterns are relative to the package directory.
4242
*/
4343
inputs?: Array<
4444
| string
4545
| {
4646
/**
47-
* Whether automatic file access inference (via fspy) is enabled
47+
* Automatically track which files the task reads
4848
*/
4949
auto: boolean;
5050
}

crates/vite_task_graph/src/config/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,12 @@ pub struct CacheConfig {
9090
/// Resolved input configuration for cache fingerprinting.
9191
///
9292
/// This is the normalized form after parsing user config.
93-
/// - `includes_auto`: Whether automatic inference from fspy is enabled
93+
/// - `includes_auto`: Whether automatic file tracking is enabled
9494
/// - `positive_globs`: Glob patterns for files to include (without `!` prefix)
9595
/// - `negative_globs`: Glob patterns for files to exclude (without `!` prefix)
9696
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Encode, Decode)]
9797
pub struct ResolvedInputConfig {
98-
/// Whether automatic file access inference (via fspy) is enabled
98+
/// Whether automatic file tracking is enabled
9999
pub includes_auto: bool,
100100

101101
/// Positive glob patterns (files to include).

crates/vite_task_graph/src/config/user.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pub enum UserInputEntry {
2222
Glob(Str),
2323
/// Auto-inference directive
2424
Auto {
25-
/// Whether automatic file access inference (via fspy) is enabled
25+
/// Automatically track which files the task reads
2626
auto: bool,
2727
},
2828
}
@@ -81,15 +81,15 @@ pub struct EnabledCacheConfig {
8181
/// Environment variable names to be passed to the task without fingerprinting.
8282
pub pass_through_envs: Option<Vec<Str>>,
8383

84-
/// Input patterns for cache fingerprinting.
84+
/// Files to include in the cache fingerprint.
8585
///
86-
/// - Omitted: defaults to `[{auto: true}]` - infer from file accesses
87-
/// - Empty array: no inputs, inference disabled
88-
/// - Glob strings: explicit files to fingerprint
89-
/// - `{auto: true}`: enable automatic inference via fspy
90-
/// - Negative globs: exclude files (prefix with `!`)
86+
/// - Omitted: automatically tracks which files the task reads
87+
/// - `[]` (empty): disables file tracking entirely
88+
/// - Glob patterns (e.g. `"src/**"`) select specific files
89+
/// - `{auto: true}` enables automatic file tracking
90+
/// - Negative patterns (e.g. `"!dist/**"`) exclude matched files
9191
///
92-
/// Globs are relative to the package directory where the task is defined.
92+
/// Patterns are relative to the package directory.
9393
#[serde(default)]
9494
#[cfg_attr(all(test, not(clippy)), ts(inline))]
9595
pub inputs: Option<UserInputsConfig>,

0 commit comments

Comments
 (0)