ZIm/crates/snippet_provider/src/format.rs
Michael Sloan c74ecb4654
Warn about unknown fields when editing settings json (#33678)
Closes #30017

* While generating the settings JSON schema, defaults all schema
definitions to reject unknown fields via `additionalProperties: false`.

* Uses `unevaluatedProperties: false` at the top level to check fields
that remain after the settings field names + release stage override
field names.

* Changes json schema version from `draft07` to `draft_2019_09` to have
support for `unevaluatedProperties`.

Release Notes:

- Added warnings for unknown fields when editing `settings.json`.
2025-06-30 23:34:25 +00:00

76 lines
2.1 KiB
Rust

use collections::HashMap;
use schemars::{JsonSchema, json_schema};
use serde::Deserialize;
use serde_json_lenient::Value;
use std::borrow::Cow;
#[derive(Deserialize)]
pub struct VsSnippetsFile {
#[serde(flatten)]
pub(crate) snippets: HashMap<String, VsCodeSnippet>,
}
impl VsSnippetsFile {
pub fn generate_json_schema() -> Value {
let schema = schemars::generate::SchemaSettings::draft2019_09()
.into_generator()
.root_schema_for::<Self>();
serde_json_lenient::to_value(schema).unwrap()
}
}
impl JsonSchema for VsSnippetsFile {
fn schema_name() -> Cow<'static, str> {
"VsSnippetsFile".into()
}
fn json_schema(generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
let snippet_schema = generator.subschema_for::<VsCodeSnippet>();
json_schema!({
"type": "object",
"additionalProperties": snippet_schema
})
}
}
#[derive(Deserialize, JsonSchema)]
#[serde(untagged)]
pub(crate) enum ListOrDirect {
Single(String),
List(Vec<String>),
}
impl From<ListOrDirect> for Vec<String> {
fn from(list: ListOrDirect) -> Self {
match list {
ListOrDirect::Single(entry) => vec![entry],
ListOrDirect::List(entries) => entries,
}
}
}
impl std::fmt::Display for ListOrDirect {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(
f,
"{}",
match self {
Self::Single(v) => v.to_owned(),
Self::List(v) => v.join("\n"),
}
)
}
}
#[derive(Deserialize, JsonSchema)]
pub(crate) struct VsCodeSnippet {
/// The snippet prefix used to decide whether a completion menu should be shown.
pub(crate) prefix: Option<ListOrDirect>,
/// The snippet content. Use `$1` and `${1:defaultText}` to define cursor positions and `$0` for final cursor position.
pub(crate) body: ListOrDirect,
/// The snippet description displayed inside the completion menu.
pub(crate) description: Option<ListOrDirect>,
}