chore: create newtype for string sets (#4404)

rome · Apr 24, 2023 · fc1fc10 · fc1fc10
1 parent 0ce9198
commit fc1fc10
Show file tree

Hide file tree

Showing 19 changed files with 178 additions and 160 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -10,7 +10,7 @@ indent_size = 2
 
 # YAML doesn't support hard tabs 🙃
 # Templates that will be weird with hard tabs in the website editor
-[{**.yml, **.md, **.rs, **.mdx}]
+[{**.yml, **.md, **.rs, **.mdx, justfile}]
 indent_style = space
 
 [*.rs]

diff --git a/crates/rome_cli/src/vcs.rs b/crates/rome_cli/src/vcs.rs
@@ -1,10 +1,9 @@
 use crate::diagnostics::{DisabledVcs, NoVcsFolderFound};
 use crate::{CliDiagnostic, CliSession};
-use indexmap::IndexSet;
 use rome_console::{markup, ConsoleExt};
 use rome_diagnostics::PrintDiagnostic;
 use rome_service::configuration::vcs::{VcsClientKind, VcsConfiguration};
-use rome_service::configuration::FilesConfiguration;
+use rome_service::configuration::{FilesConfiguration, StringSet};
 use rome_service::{Configuration, WorkspaceError};
 use std::path::PathBuf;
 
@@ -40,7 +39,7 @@ pub(crate) fn store_path_to_ignore_from_vcs(
             let files = configuration
                 .files
                 .get_or_insert_with(FilesConfiguration::default);
-            let ignored_files = files.ignore.get_or_insert_with(IndexSet::new);
+            let ignored_files = files.ignore.get_or_insert_with(StringSet::default);
             ignored_files.extend(files_to_ignore.into_iter());
         }
     }

diff --git a/crates/rome_service/src/configuration/formatter.rs b/crates/rome_service/src/configuration/formatter.rs
@@ -1,6 +1,6 @@
+use crate::configuration::string_set::StringSet;
 use crate::settings::FormatSettings;
 use crate::{ConfigurationDiagnostic, MatchOptions, Matcher, WorkspaceError};
-use indexmap::IndexSet;
 use rome_formatter::{IndentStyle, LineWidth};
 use serde::{Deserialize, Serialize};
 
@@ -30,12 +30,8 @@ pub struct FormatterConfiguration {
 
     /// A list of Unix shell style patterns. The formatter will ignore files/folders that will
     /// match these patterns.
-    #[serde(
-        skip_serializing_if = "Option::is_none",
-        deserialize_with = "crate::deserialize_set_of_strings",
-        serialize_with = "crate::serialize_set_of_strings"
-    )]
-    pub ignore: Option<IndexSet<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ignore: Option<StringSet>,
 }
 
 impl FormatterConfiguration {
@@ -76,8 +72,8 @@ impl TryFrom<FormatterConfiguration> for FormatSettings {
             require_literal_separator: false,
         });
         if let Some(ignore) = conf.ignore {
-            for pattern in ignore {
-                matcher.add_pattern(&pattern).map_err(|err| {
+            for pattern in ignore.index_set() {
+                matcher.add_pattern(pattern).map_err(|err| {
                     WorkspaceError::Configuration(
                         ConfigurationDiagnostic::new_invalid_ignore_pattern(
                             pattern.to_string(),

diff --git a/crates/rome_service/src/configuration/javascript.rs b/crates/rome_service/src/configuration/javascript.rs
@@ -1,4 +1,4 @@
-use indexmap::IndexSet;
+use crate::configuration::string_set::StringSet;
 use rome_js_formatter::context::{
     trailing_comma::TrailingComma, QuoteProperties, QuoteStyle, Semicolons,
 };
@@ -14,12 +14,8 @@ pub struct JavascriptConfiguration {
     /// A list of global bindings that should be ignored by the analyzers
     ///
     /// If defined here, they should not emit diagnostics.
-    #[serde(
-        skip_serializing_if = "Option::is_none",
-        deserialize_with = "crate::deserialize_set_of_strings",
-        serialize_with = "crate::serialize_set_of_strings"
-    )]
-    pub globals: Option<IndexSet<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub globals: Option<StringSet>,
 
     #[serde(skip_serializing_if = "Option::is_none")]
     pub organize_imports: Option<JavascriptOrganizeImports>,

diff --git a/crates/rome_service/src/configuration/linter/mod.rs b/crates/rome_service/src/configuration/linter/mod.rs
@@ -2,9 +2,9 @@
 mod rules;
 
 pub use crate::configuration::linter::rules::Rules;
+use crate::configuration::string_set::StringSet;
 use crate::settings::LinterSettings;
 use crate::{ConfigurationDiagnostic, MatchOptions, Matcher, WorkspaceError};
-use indexmap::IndexSet;
 use rome_diagnostics::Severity;
 pub use rules::*;
 #[cfg(feature = "schemars")]
@@ -24,12 +24,8 @@ pub struct LinterConfiguration {
 
     /// A list of Unix shell style patterns. The formatter will ignore files/folders that will
     /// match these patterns.
-    #[serde(
-        skip_serializing_if = "Option::is_none",
-        deserialize_with = "crate::deserialize_set_of_strings",
-        serialize_with = "crate::serialize_set_of_strings"
-    )]
-    pub ignore: Option<IndexSet<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ignore: Option<StringSet>,
 }
 
 impl LinterConfiguration {
@@ -56,8 +52,8 @@ impl TryFrom<LinterConfiguration> for LinterSettings {
             require_literal_separator: false,
         });
         if let Some(ignore) = conf.ignore {
-            for pattern in ignore {
-                matcher.add_pattern(&pattern).map_err(|err| {
+            for pattern in ignore.index_set() {
+                matcher.add_pattern(pattern).map_err(|err| {
                     WorkspaceError::Configuration(
                         ConfigurationDiagnostic::new_invalid_ignore_pattern(
                             pattern.to_string(),

diff --git a/crates/rome_service/src/configuration/mod.rs b/crates/rome_service/src/configuration/mod.rs
@@ -4,14 +4,10 @@
 //! by language. The language might further options divided by tool.
 
 use crate::{DynRef, WorkspaceError};
-use indexmap::IndexSet;
 use rome_fs::{FileSystem, OpenOptions};
-use serde::de::{SeqAccess, Visitor};
-use serde::ser::SerializeSeq;
 use serde::{Deserialize, Serialize};
 use std::fmt::Debug;
 use std::io::ErrorKind;
-use std::marker::PhantomData;
 use std::num::NonZeroU64;
 use std::path::{Path, PathBuf};
 
@@ -22,11 +18,13 @@ mod javascript;
 pub mod linter;
 pub mod organize_imports;
 mod parse;
+pub mod string_set;
 pub mod vcs;
 
 pub use crate::configuration::diagnostics::ConfigurationDiagnostic;
 use crate::configuration::generated::push_to_analyzer_rules;
 use crate::configuration::organize_imports::OrganizeImports;
+pub use crate::configuration::string_set::StringSet;
 use crate::configuration::vcs::VcsConfiguration;
 use crate::settings::{LanguagesSettings, LinterSettings};
 pub use formatter::{FormatterConfiguration, PlainIndentStyle};
@@ -135,12 +133,8 @@ pub struct FilesConfiguration {
 
     /// A list of Unix shell style patterns. Rome tools will ignore files/folders that will
     /// match these patterns.
-    #[serde(
-        skip_serializing_if = "Option::is_none",
-        deserialize_with = "crate::deserialize_set_of_strings",
-        serialize_with = "crate::serialize_set_of_strings"
-    )]
-    pub ignore: Option<IndexSet<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ignore: Option<StringSet>,
 }
 
 impl FilesConfiguration {
@@ -257,70 +251,6 @@ pub fn create_config(
     Ok(())
 }
 
-/// Some documentation
-pub fn deserialize_set_of_strings<'de, D>(
-    deserializer: D,
-) -> Result<Option<IndexSet<String>>, D::Error>
-where
-    D: serde::de::Deserializer<'de>,
-{
-    struct IndexVisitor {
-        marker: PhantomData<fn() -> Option<IndexSet<String>>>,
-    }
-
-    impl IndexVisitor {
-        fn new() -> Self {
-            IndexVisitor {
-                marker: PhantomData,
-            }
-        }
-    }
-
-    impl<'de> Visitor<'de> for IndexVisitor {
-        type Value = Option<IndexSet<String>>;
-
-        // Format a message stating what data this Visitor expects to receive.
-        fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
-            formatter.write_str("expecting a sequence")
-        }
-
-        fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
-        where
-            A: SeqAccess<'de>,
-        {
-            let mut index_set = IndexSet::with_capacity(seq.size_hint().unwrap_or(0));
-
-            while let Some(value) = seq.next_element()? {
-                index_set.insert(value);
-            }
-
-            Ok(Some(index_set))
-        }
-    }
-
-    deserializer.deserialize_seq(IndexVisitor::new())
-}
-
-pub fn serialize_set_of_strings<S>(
-    set_of_strings: &Option<IndexSet<String>>,
-    s: S,
-) -> Result<S::Ok, S::Error>
-where
-    S: serde::ser::Serializer,
-{
-    if let Some(set_of_strings) = set_of_strings {
-        let mut sequence = s.serialize_seq(Some(set_of_strings.len()))?;
-        let iter = set_of_strings.into_iter();
-        for global in iter {
-            sequence.serialize_element(global)?;
-        }
-
-        sequence.end()
-    } else {
-        s.serialize_none()
-    }
-}
-
 /// Converts a [WorkspaceSettings] into a suited [configuration for the analyzer].
 ///
 /// The function needs access to a filter, in order to have an easy access to the [metadata] of the

diff --git a/crates/rome_service/src/configuration/organize_imports.rs b/crates/rome_service/src/configuration/organize_imports.rs
@@ -1,6 +1,6 @@
+use crate::configuration::string_set::StringSet;
 use crate::settings::OrganizeImportsSettings;
 use crate::{ConfigurationDiagnostic, MatchOptions, Matcher, WorkspaceError};
-use indexmap::IndexSet;
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Default, Serialize, Deserialize, Eq, PartialEq)]
@@ -12,12 +12,8 @@ pub struct OrganizeImports {
 
     /// A list of Unix shell style patterns. The formatter will ignore files/folders that will
     /// match these patterns.
-    #[serde(
-        skip_serializing_if = "Option::is_none",
-        deserialize_with = "crate::deserialize_set_of_strings",
-        serialize_with = "crate::serialize_set_of_strings"
-    )]
-    pub ignore: Option<IndexSet<String>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ignore: Option<StringSet>,
 }
 
 impl TryFrom<OrganizeImports> for OrganizeImportsSettings {
@@ -30,8 +26,8 @@ impl TryFrom<OrganizeImports> for OrganizeImportsSettings {
             require_literal_separator: false,
         });
         if let Some(ignore) = organize_imports.ignore {
-            for pattern in ignore {
-                matcher.add_pattern(&pattern).map_err(|err| {
+            for pattern in ignore.index_set() {
+                matcher.add_pattern(pattern).map_err(|err| {
                     WorkspaceError::Configuration(
                         ConfigurationDiagnostic::new_invalid_ignore_pattern(
                             pattern.to_string(),

diff --git a/crates/rome_service/src/configuration/parse/json/files.rs b/crates/rome_service/src/configuration/parse/json/files.rs
@@ -1,3 +1,4 @@
+use crate::configuration::string_set::StringSet;
 use crate::configuration::FilesConfiguration;
 use rome_deserialize::json::{has_only_known_keys, VisitJsonNode};
 use rome_deserialize::{DeserializationDiagnostic, VisitNode};
@@ -30,7 +31,9 @@ impl VisitNode<JsonLanguage> for FilesConfiguration {
                     NonZeroU64::new(self.map_to_u64(&value, name_text, u64::MAX, diagnostics)?);
             }
             "ignore" => {
-                self.ignore = self.map_to_index_set_string(&value, name_text, diagnostics);
+                self.ignore = self
+                    .map_to_index_set_string(&value, name_text, diagnostics)
+                    .map(StringSet::new);
             }
             _ => {}
         }

diff --git a/crates/rome_service/src/configuration/parse/json/formatter.rs b/crates/rome_service/src/configuration/parse/json/formatter.rs
@@ -1,3 +1,4 @@
+use crate::configuration::string_set::StringSet;
 use crate::configuration::{FormatterConfiguration, PlainIndentStyle};
 use rome_console::markup;
 use rome_deserialize::json::{has_only_known_keys, with_only_known_variants, VisitJsonNode};
@@ -33,7 +34,9 @@ impl VisitNode<JsonLanguage> for FormatterConfiguration {
                 self.enabled = self.map_to_boolean(&value, name_text, diagnostics)?;
             }
             "ignore" => {
-                self.ignore = self.map_to_index_set_string(&value, name_text, diagnostics);
+                self.ignore = self
+                    .map_to_index_set_string(&value, name_text, diagnostics)
+                    .map(StringSet::new);
             }
             "indentStyle" => {
                 let mut indent_style = PlainIndentStyle::default();

diff --git a/crates/rome_service/src/configuration/parse/json/javascript.rs b/crates/rome_service/src/configuration/parse/json/javascript.rs
@@ -1,4 +1,5 @@
 use crate::configuration::javascript::JavascriptOrganizeImports;
+use crate::configuration::string_set::StringSet;
 use crate::configuration::{JavascriptConfiguration, JavascriptFormatter};
 use rome_deserialize::json::{has_only_known_keys, VisitJsonNode};
 use rome_deserialize::{DeserializationDiagnostic, VisitNode};
@@ -34,7 +35,9 @@ impl VisitNode<JsonLanguage> for JavascriptConfiguration {
                 self.formatter = Some(javascript_formatter);
             }
             "globals" => {
-                self.globals = self.map_to_index_set_string(&value, name_text, diagnostics);
+                self.globals = self
+                    .map_to_index_set_string(&value, name_text, diagnostics)
+                    .map(StringSet::new);
             }
             "organizeImports" => {
                 let mut javascript_organize_imports = JavascriptOrganizeImports::default();

diff --git a/crates/rome_service/src/configuration/parse/json/linter.rs b/crates/rome_service/src/configuration/parse/json/linter.rs
@@ -1,4 +1,5 @@
 use crate::configuration::linter::{RulePlainConfiguration, RuleWithOptions};
+use crate::configuration::string_set::StringSet;
 use crate::configuration::LinterConfiguration;
 use crate::{RuleConfiguration, Rules};
 use rome_console::markup;
@@ -28,7 +29,9 @@ impl VisitNode<JsonLanguage> for LinterConfiguration {
         let name_text = name.text();
         match name_text {
             "ignore" => {
-                self.ignore = self.map_to_index_set_string(&value, name_text, diagnostics);
+                self.ignore = self
+                    .map_to_index_set_string(&value, name_text, diagnostics)
+                    .map(StringSet::new);
             }
             "enabled" => {
                 self.enabled = self.map_to_boolean(&value, name_text, diagnostics)?;

diff --git a/crates/rome_service/src/configuration/parse/json/organize_imports.rs b/crates/rome_service/src/configuration/parse/json/organize_imports.rs
@@ -1,4 +1,5 @@
 use crate::configuration::organize_imports::OrganizeImports;
+use crate::configuration::string_set::StringSet;
 use rome_deserialize::json::{has_only_known_keys, VisitJsonNode};
 use rome_deserialize::{DeserializationDiagnostic, VisitNode};
 use rome_json_syntax::{JsonLanguage, JsonSyntaxNode};
@@ -28,7 +29,9 @@ impl VisitNode<JsonLanguage> for OrganizeImports {
                 self.enabled = self.map_to_boolean(&value, name_text, diagnostics)?;
             }
             "ignore" => {
-                self.ignore = self.map_to_index_set_string(&value, name_text, diagnostics);
+                self.ignore = self
+                    .map_to_index_set_string(&value, name_text, diagnostics)
+                    .map(StringSet::new);
             }
             _ => {}
         }