use std::hash::Hash;
use indexmap::IndexMap;
use serde::Deserialize;
use serde::Serialize;
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParseConfigurationError(pub String);
impl std::fmt::Display for ParseConfigurationError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
format!("Found invalid value '{}'.", self.0).fmt(f)
}
}
#[macro_export]
macro_rules! generate_str_to_from {
($enum_name:ident, $([$member_name:ident, $string_value:expr]),* ) => {
impl std::str::FromStr for $enum_name {
type Err = ParseConfigurationError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
$($string_value => Ok($enum_name::$member_name)),*,
_ => Err(ParseConfigurationError(String::from(s))),
}
}
}
impl std::fmt::Display for $enum_name {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
$($enum_name::$member_name => write!(f, $string_value)),*,
}
}
}
};
}
#[derive(Clone, PartialEq, Eq, Debug, Copy, Serialize, Deserialize, Hash)]
pub enum RawNewLineKind {
#[serde(rename = "auto")]
Auto,
#[serde(rename = "lf")]
LineFeed,
#[serde(rename = "crlf")]
CarriageReturnLineFeed,
#[serde(rename = "system")]
System,
}
generate_str_to_from![
RawNewLineKind,
[Auto, "auto"],
[LineFeed, "lf"],
[CarriageReturnLineFeed, "crlf"],
[System, "system"]
];
#[derive(Clone, PartialEq, Eq, Debug, Copy, Serialize, Deserialize, Hash)]
pub enum NewLineKind {
#[serde(rename = "auto")]
Auto,
#[serde(rename = "lf")]
LineFeed,
#[serde(rename = "crlf")]
CarriageReturnLineFeed,
}
generate_str_to_from![NewLineKind, [Auto, "auto"], [LineFeed, "lf"], [CarriageReturnLineFeed, "crlf"]];
#[derive(Clone, Serialize, Deserialize, PartialEq, Eq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct ConfigurationDiagnostic {
pub property_name: String,
pub message: String,
}
impl std::fmt::Display for ConfigurationDiagnostic {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{} ({})", self.message, self.property_name)
}
}
pub type ConfigKeyMap = IndexMap<String, ConfigKeyValue>;
#[derive(Clone, PartialEq, Eq, Debug, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ConfigKeyValue {
String(String),
Number(i32),
Bool(bool),
Array(Vec<ConfigKeyValue>),
Object(ConfigKeyMap),
Null,
}
impl ConfigKeyValue {
pub fn as_string(&self) -> Option<&String> {
match self {
ConfigKeyValue::String(value) => Some(value),
_ => None,
}
}
pub fn as_number(&self) -> Option<i32> {
match self {
ConfigKeyValue::Number(value) => Some(*value),
_ => None,
}
}
pub fn as_bool(&self) -> Option<bool> {
match self {
ConfigKeyValue::Bool(value) => Some(*value),
_ => None,
}
}
pub fn as_array(&self) -> Option<&Vec<ConfigKeyValue>> {
match self {
ConfigKeyValue::Array(values) => Some(values),
_ => None,
}
}
pub fn as_object(&self) -> Option<&ConfigKeyMap> {
match self {
ConfigKeyValue::Object(values) => Some(values),
_ => None,
}
}
pub fn into_string(self) -> Option<String> {
match self {
ConfigKeyValue::String(value) => Some(value),
_ => None,
}
}
pub fn into_number(self) -> Option<i32> {
match self {
ConfigKeyValue::Number(value) => Some(value),
_ => None,
}
}
pub fn into_bool(self) -> Option<bool> {
match self {
ConfigKeyValue::Bool(value) => Some(value),
_ => None,
}
}
pub fn into_array(self) -> Option<Vec<ConfigKeyValue>> {
match self {
ConfigKeyValue::Array(values) => Some(values),
_ => None,
}
}
pub fn into_object(self) -> Option<ConfigKeyMap> {
match self {
ConfigKeyValue::Object(values) => Some(values),
_ => None,
}
}
pub fn is_null(&self) -> bool {
matches!(self, ConfigKeyValue::Null)
}
#[allow(clippy::should_implement_trait)]
pub fn hash(&self, hasher: &mut impl std::hash::Hasher) {
match self {
ConfigKeyValue::String(value) => {
hasher.write_u8(0);
hasher.write(value.as_bytes())
}
ConfigKeyValue::Number(value) => {
hasher.write_u8(1);
hasher.write_i32(*value)
}
ConfigKeyValue::Bool(value) => {
hasher.write_u8(2);
hasher.write_u8(if *value { 1 } else { 0 })
}
ConfigKeyValue::Array(values) => {
hasher.write_u8(3);
for value in values {
value.hash(hasher);
}
}
ConfigKeyValue::Object(key_values) => {
hasher.write_u8(4);
for (key, value) in key_values {
hasher.write(key.as_bytes());
value.hash(hasher);
}
}
ConfigKeyValue::Null => {
hasher.write_u8(5);
}
}
}
pub fn from_i32(value: i32) -> ConfigKeyValue {
ConfigKeyValue::Number(value)
}
#[allow(clippy::should_implement_trait)]
pub fn from_str(value: &str) -> ConfigKeyValue {
ConfigKeyValue::String(value.to_string())
}
pub fn from_bool(value: bool) -> ConfigKeyValue {
ConfigKeyValue::Bool(value)
}
}
impl From<i32> for ConfigKeyValue {
fn from(item: i32) -> Self {
ConfigKeyValue::from_i32(item)
}
}
impl From<bool> for ConfigKeyValue {
fn from(item: bool) -> Self {
ConfigKeyValue::from_bool(item)
}
}
impl From<String> for ConfigKeyValue {
fn from(item: String) -> Self {
ConfigKeyValue::from_str(&item)
}
}
impl From<&str> for ConfigKeyValue {
fn from(item: &str) -> Self {
ConfigKeyValue::from_str(item)
}
}
#[derive(Clone, Serialize, Deserialize, PartialEq, Eq, Debug, Default, Hash)]
#[serde(rename_all = "camelCase")]
pub struct GlobalConfiguration {
pub line_width: Option<u32>,
pub use_tabs: Option<bool>,
pub indent_width: Option<u8>,
pub new_line_kind: Option<NewLineKind>,
}
pub const RECOMMENDED_GLOBAL_CONFIGURATION: RecommendedGlobalConfiguration = RecommendedGlobalConfiguration {
line_width: 120,
indent_width: 2,
use_tabs: false,
new_line_kind: NewLineKind::LineFeed,
};
pub struct RecommendedGlobalConfiguration {
pub line_width: u32,
pub use_tabs: bool,
pub indent_width: u8,
pub new_line_kind: NewLineKind,
}
impl From<RecommendedGlobalConfiguration> for GlobalConfiguration {
fn from(config: RecommendedGlobalConfiguration) -> Self {
Self {
line_width: Some(config.line_width),
use_tabs: Some(config.use_tabs),
indent_width: Some(config.indent_width),
new_line_kind: Some(config.new_line_kind),
}
}
}
#[derive(Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ResolveConfigurationResult<T>
where
T: Clone + Serialize,
{
pub diagnostics: Vec<ConfigurationDiagnostic>,
pub config: T,
}
pub fn resolve_global_config(config: &mut ConfigKeyMap) -> ResolveConfigurationResult<GlobalConfiguration> {
let mut diagnostics = Vec::new();
let raw_new_line_kind = get_nullable_value::<RawNewLineKind>(config, "newLineKind", &mut diagnostics);
let resolved_config = GlobalConfiguration {
line_width: get_nullable_value(config, "lineWidth", &mut diagnostics),
use_tabs: get_nullable_value(config, "useTabs", &mut diagnostics),
indent_width: get_nullable_value(config, "indentWidth", &mut diagnostics),
new_line_kind: raw_new_line_kind.map(|kind| match kind {
RawNewLineKind::Auto => NewLineKind::Auto,
RawNewLineKind::LineFeed => NewLineKind::LineFeed,
RawNewLineKind::CarriageReturnLineFeed => NewLineKind::CarriageReturnLineFeed,
RawNewLineKind::System => {
if cfg!(windows) {
NewLineKind::CarriageReturnLineFeed
} else {
NewLineKind::LineFeed
}
}
}),
};
ResolveConfigurationResult {
config: resolved_config,
diagnostics,
}
}
pub fn get_value<T>(config: &mut ConfigKeyMap, key: &str, default_value: T, diagnostics: &mut Vec<ConfigurationDiagnostic>) -> T
where
T: std::str::FromStr,
<T as std::str::FromStr>::Err: std::fmt::Display,
{
get_nullable_value(config, key, diagnostics).unwrap_or(default_value)
}
pub fn get_nullable_value<T>(config: &mut ConfigKeyMap, key: &str, diagnostics: &mut Vec<ConfigurationDiagnostic>) -> Option<T>
where
T: std::str::FromStr,
<T as std::str::FromStr>::Err: std::fmt::Display,
{
if let Some(raw_value) = config.shift_remove(key) {
let parsed_value = match raw_value {
ConfigKeyValue::Bool(value) => value.to_string().parse::<T>().map_err(|e| e.to_string()),
ConfigKeyValue::Number(value) => value.to_string().parse::<T>().map_err(|e| e.to_string()),
ConfigKeyValue::String(value) => value.parse::<T>().map_err(|e| e.to_string()),
ConfigKeyValue::Object(_) | ConfigKeyValue::Array(_) => Err("Arrays and objects are not supported for this value".to_string()),
ConfigKeyValue::Null => return None,
};
match parsed_value {
Ok(parsed_value) => Some(parsed_value),
Err(message) => {
diagnostics.push(ConfigurationDiagnostic {
property_name: key.to_string(),
message,
});
None
}
}
} else {
None
}
}
pub fn handle_renamed_config_property(config: &mut ConfigKeyMap, old_key: &str, new_key: &str, diagnostics: &mut Vec<ConfigurationDiagnostic>) {
if let Some(raw_value) = config.shift_remove(old_key) {
if !config.contains_key(new_key) {
config.insert(new_key.to_string(), raw_value);
}
diagnostics.push(ConfigurationDiagnostic {
property_name: old_key.to_string(),
message: format!("The configuration key was renamed to '{}'", new_key),
});
}
}
pub fn resolve_new_line_kind(file_text: &str, new_line_kind: NewLineKind) -> &'static str {
match new_line_kind {
NewLineKind::LineFeed => "\n",
NewLineKind::CarriageReturnLineFeed => "\r\n",
NewLineKind::Auto => {
let mut found_slash_n = false;
for c in file_text.as_bytes().iter().rev() {
if found_slash_n {
if c == &(b'\r') {
return "\r\n";
} else {
return "\n";
}
}
if c == &(b'\n') {
found_slash_n = true;
}
}
"\n"
}
}
}
pub fn get_unknown_property_diagnostics(config: ConfigKeyMap) -> Vec<ConfigurationDiagnostic> {
let mut diagnostics = Vec::new();
for (key, _) in config {
diagnostics.push(ConfigurationDiagnostic {
property_name: key.to_string(),
message: "Unknown property in configuration".to_string(),
});
}
diagnostics
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn get_default_config_when_empty() {
let config_result = resolve_global_config(&mut ConfigKeyMap::new());
let config = config_result.config;
assert_eq!(config_result.diagnostics.len(), 0);
assert_eq!(config.line_width, None);
assert_eq!(config.indent_width, None);
assert!(config.new_line_kind.is_none());
assert_eq!(config.use_tabs, None);
}
#[test]
fn get_values_when_filled() {
let mut global_config = ConfigKeyMap::from([
(String::from("lineWidth"), ConfigKeyValue::from_i32(80)),
(String::from("indentWidth"), ConfigKeyValue::from_i32(8)),
(String::from("newLineKind"), ConfigKeyValue::from_str("crlf")),
(String::from("useTabs"), ConfigKeyValue::from_bool(true)),
]);
let config_result = resolve_global_config(&mut global_config);
let config = config_result.config;
assert_eq!(config_result.diagnostics.len(), 0);
assert_eq!(config.line_width, Some(80));
assert_eq!(config.indent_width, Some(8));
assert_eq!(config.new_line_kind, Some(NewLineKind::CarriageReturnLineFeed));
assert_eq!(config.use_tabs, Some(true));
}
#[test]
fn get_diagnostic_for_invalid_enum_config() {
let mut global_config = ConfigKeyMap::from([(String::from("newLineKind"), ConfigKeyValue::from_str("something"))]);
let diagnostics = resolve_global_config(&mut global_config).diagnostics;
assert_eq!(diagnostics.len(), 1);
assert_eq!(diagnostics[0].message, "Found invalid value 'something'.");
assert_eq!(diagnostics[0].property_name, "newLineKind");
}
#[test]
fn get_diagnostic_for_invalid_primitive() {
let mut global_config = ConfigKeyMap::from([(String::from("useTabs"), ConfigKeyValue::from_str("something"))]);
let diagnostics = resolve_global_config(&mut global_config).diagnostics;
assert_eq!(diagnostics.len(), 1);
assert_eq!(diagnostics[0].message, "provided string was not `true` or `false`");
assert_eq!(diagnostics[0].property_name, "useTabs");
}
#[test]
fn get_diagnostic_for_excess_property() {
let global_config = ConfigKeyMap::from([(String::from("something"), ConfigKeyValue::from_str("value"))]);
let diagnostics = get_unknown_property_diagnostics(global_config);
assert_eq!(diagnostics.len(), 1);
assert_eq!(diagnostics[0].message, "Unknown property in configuration");
assert_eq!(diagnostics[0].property_name, "something");
}
#[test]
fn add_diagnostic_for_renamed_property() {
let mut config = ConfigKeyMap::new();
let mut diagnostics = Vec::new();
config.insert("oldProp".to_string(), ConfigKeyValue::from_str("value"));
handle_renamed_config_property(&mut config, "oldProp", "newProp", &mut diagnostics);
assert_eq!(config.len(), 1);
assert_eq!(config.remove("newProp").unwrap(), ConfigKeyValue::from_str("value"));
assert_eq!(diagnostics.len(), 1);
assert_eq!(diagnostics[0].message, "The configuration key was renamed to 'newProp'");
assert_eq!(diagnostics[0].property_name, "oldProp");
}
#[test]
fn add_diagnostic_for_renamed_property_when_already_exists() {
let mut config = ConfigKeyMap::new();
let mut diagnostics = Vec::new();
config.insert("oldProp".to_string(), ConfigKeyValue::from_str("new_value"));
config.insert("newProp".to_string(), ConfigKeyValue::from_str("value"));
handle_renamed_config_property(&mut config, "oldProp", "newProp", &mut diagnostics);
assert_eq!(config.len(), 1);
assert_eq!(config.remove("newProp").unwrap(), ConfigKeyValue::from_str("value"));
assert_eq!(diagnostics.len(), 1);
assert_eq!(diagnostics[0].message, "The configuration key was renamed to 'newProp'");
assert_eq!(diagnostics[0].property_name, "oldProp");
}
}