edit predictions: Clarify disabled_globs documentation (#24460)

This PR clarifies how the `disabled_globs` work.

Release Notes:

- N/A

---------

Co-authored-by: Bennet Bo Fenner <53836821+bennetbo@users.noreply.github.com>
This commit is contained in:
Danilo Leal 2025-02-07 15:35:55 -03:00 committed by GitHub
parent 8ff8dbdb2b
commit a7a14e59bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 9 additions and 3 deletions

View file

@ -783,6 +783,8 @@
"load_direnv": "direct",
"edit_predictions": {
// A list of globs representing files that edit predictions should be disabled for.
// There's a sensible default list of globs already included.
// Any addition to this list will be merged with the default list.
"disabled_globs": [
"**/.env*",
"**/*.pem",

View file

@ -224,6 +224,8 @@ pub struct EditPredictionSettings {
/// The provider that supplies edit predictions.
pub provider: EditPredictionProvider,
/// A list of globs representing files that edit predictions should be disabled for.
/// This list adds to a pre-existing, sensible default set of globs.
/// Any additional ones you add are combined with them.
pub disabled_globs: Vec<GlobMatcher>,
/// When to show edit predictions previews in buffer.
pub inline_preview: InlineCompletionPreviewMode,
@ -428,6 +430,8 @@ pub struct LanguageSettingsContent {
#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, PartialEq)]
pub struct InlineCompletionSettingsContent {
/// A list of globs representing files that edit predictions should be disabled for.
/// This list adds to a pre-existing, sensible default set of globs.
/// Any additional ones you add are combined with them.
#[serde(default)]
pub disabled_globs: Option<Vec<String>>,
/// When to show edit predictions previews in buffer.

View file

@ -398,13 +398,13 @@ There are two options to choose from:
### Disabled Globs
- Description: A list of globs representing files that edit predictions should be disabled for.
- Description: A list of globs for which edit predictions should be disabled for. This list adds to a pre-existing, sensible default set of globs. Any additional ones you add are combined with them.
- Setting: `disabled_globs`
- Default: `[".env"]`
- Default: `["**/.env*", "**/*.pem", "**/*.key", "**/*.cert", "**/*.crt", "**/secrets.yml"]`
**Options**
List of `string` values
List of `string` values.
## Edit Predictions Disabled in