Don't default publishDecorations to true on the server

If the client doesn't specify this explicitly, that very likely means it doesn't
know about it and so we shouldn't send decorations. In particular, the recent
change to this default caused decorations to be sent to emacs, resulting in a
lot of warning spam.
This commit is contained in:
Florian Diebold 2019-03-07 21:06:25 +01:00 committed by Florian Diebold
parent bfea379d88
commit c30c5fb4dd

View file

@ -1,39 +1,61 @@
use serde::{Deserialize, Deserializer}; use serde::{Deserialize, Deserializer};
/// Client provided initialization options /// Client provided initialization options
#[derive(Deserialize, Clone, Copy, Debug)] #[derive(Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase", default)]
pub struct InitializationOptions { pub struct InitializationOptions {
/// Whether the client supports our custom highlighting publishing decorations. /// Whether the client supports our custom highlighting publishing decorations.
/// This is different to the highlightingOn setting, which is whether the user /// This is different to the highlightingOn setting, which is whether the user
/// wants our custom highlighting to be used. /// wants our custom highlighting to be used.
/// ///
/// Defaults to `true` /// Defaults to `false`
#[serde(default = "bool_true", deserialize_with = "nullable_bool_true")] #[serde(deserialize_with = "nullable_bool_false")]
pub publish_decorations: bool, pub publish_decorations: bool,
/// Whether or not the workspace loaded notification should be sent /// Whether or not the workspace loaded notification should be sent
/// ///
/// Defaults to `true` /// Defaults to `true`
#[serde(default = "bool_true", deserialize_with = "nullable_bool_true")] #[serde(deserialize_with = "nullable_bool_true")]
pub show_workspace_loaded: bool, pub show_workspace_loaded: bool,
} }
impl Default for InitializationOptions { impl Default for InitializationOptions {
fn default() -> InitializationOptions { fn default() -> InitializationOptions {
InitializationOptions { publish_decorations: true, show_workspace_loaded: true } InitializationOptions { publish_decorations: false, show_workspace_loaded: true }
} }
} }
fn bool_true() -> bool { /// Deserializes a null value to a bool false by default
true fn nullable_bool_false<'de, D>(deserializer: D) -> Result<bool, D::Error>
} where
D: Deserializer<'de>,
/// Deserializes a null value to a bool true by default {
fn nullable_bool_true<'de, D>(deserializer: D) -> Result<bool, D::Error> let opt = Option::deserialize(deserializer)?;
where Ok(opt.unwrap_or(false))
D: Deserializer<'de>, }
{
let opt = Option::deserialize(deserializer)?; /// Deserializes a null value to a bool true by default
Ok(opt.unwrap_or(true)) fn nullable_bool_true<'de, D>(deserializer: D) -> Result<bool, D::Error>
} where
D: Deserializer<'de>,
{
let opt = Option::deserialize(deserializer)?;
Ok(opt.unwrap_or(true))
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn deserialize_init_options_defaults() {
// check that null == default for both fields
let default = InitializationOptions::default();
assert_eq!(default, serde_json::from_str(r#"{}"#).unwrap());
assert_eq!(
default,
serde_json::from_str(r#"{"publishDecorations":null, "showWorkspaceLoaded":null}"#)
.unwrap()
);
}
}