dprint_plugin_sql/configuration/
builder.rs

1use dprint_core::configuration::{
2  resolve_global_config, ConfigKeyMap, ConfigKeyValue, GlobalConfiguration, NewLineKind,
3};
4
5use super::*;
6
7/// Formatting configuration builder.
8///
9/// # Example
10///
11/// ```
12/// use dprint_plugin_sql::configuration::*;
13///
14/// let config = ConfigurationBuilder::new()
15///     .uppercase(true)
16///     .build();
17/// ```
18pub struct ConfigurationBuilder {
19  pub(super) config: ConfigKeyMap,
20  global_config: Option<GlobalConfiguration>,
21}
22
23impl ConfigurationBuilder {
24  /// Constructs a new configuration builder.
25  pub fn new() -> ConfigurationBuilder {
26    ConfigurationBuilder {
27      config: Default::default(),
28      global_config: None,
29    }
30  }
31
32  /// Gets the final configuration that can be used to format a file.
33  pub fn build(&self) -> Configuration {
34    if let Some(global_config) = &self.global_config {
35      resolve_config(self.config.clone(), global_config).config
36    } else {
37      let global_config = resolve_global_config(Default::default(), &Default::default()).config;
38      resolve_config(self.config.clone(), &global_config).config
39    }
40  }
41
42  /// Set the global configuration.
43  pub fn global_config(&mut self, global_config: GlobalConfiguration) -> &mut Self {
44    self.global_config = Some(global_config);
45    self
46  }
47
48  /// Whether to use tabs (true) or spaces (false).
49  ///
50  /// Default: `false`
51  pub fn use_tabs(&mut self, value: bool) -> &mut Self {
52    self.insert("useTabs", value.into())
53  }
54
55  /// The number of columns for an indent.
56  ///
57  /// Default: `4`
58  pub fn indent_width(&mut self, value: u8) -> &mut Self {
59    self.insert("indentWidth", (value as i32).into())
60  }
61
62  /// The kind of newline to use.
63  /// Default: `NewLineKind::LineFeed`
64  pub fn new_line_kind(&mut self, value: NewLineKind) -> &mut Self {
65    self.insert("newLineKind", value.to_string().into())
66  }
67
68  /// Use ALL CAPS for reserved words.
69  /// Default: `false`
70  pub fn uppercase(&mut self, value: bool) -> &mut Self {
71    self.insert("uppercase", value.into())
72  }
73
74  /// Number of line breaks between queries.
75  /// Default: `1`
76  pub fn lines_between_queries(&mut self, value: u8) -> &mut Self {
77    self.insert("linesBetweenQueries", (value as i32).into())
78  }
79
80  #[cfg(test)]
81  pub(super) fn get_inner_config(&self) -> ConfigKeyMap {
82    self.config.clone()
83  }
84
85  fn insert(&mut self, name: &str, value: ConfigKeyValue) -> &mut Self {
86    self.config.insert(String::from(name), value);
87    self
88  }
89}
90
91#[cfg(test)]
92mod tests {
93  use dprint_core::configuration::{resolve_global_config, NewLineKind};
94
95  use super::*;
96
97  #[test]
98  fn check_all_values_set() {
99    let mut config = ConfigurationBuilder::new();
100    config
101      .new_line_kind(NewLineKind::CarriageReturnLineFeed)
102      .use_tabs(true)
103      .indent_width(4)
104      .uppercase(true)
105      .lines_between_queries(2);
106
107    let inner_config = config.get_inner_config();
108    assert_eq!(inner_config.len(), 5);
109    let diagnostics = resolve_config(
110      inner_config,
111      &resolve_global_config(Default::default(), &Default::default()).config,
112    )
113    .diagnostics;
114    assert_eq!(diagnostics.len(), 0);
115  }
116
117  #[test]
118  fn handle_global_config() {
119    let mut global_config = ConfigKeyMap::new();
120    global_config.insert(String::from("newLineKind"), "crlf".into());
121    global_config.insert(String::from("useTabs"), true.into());
122    let global_config = resolve_global_config(global_config, &Default::default()).config;
123    let mut config_builder = ConfigurationBuilder::new();
124    let config = config_builder.global_config(global_config).build();
125    assert_eq!(config.new_line_kind == NewLineKind::CarriageReturnLineFeed, true);
126    assert_eq!(config.use_tabs, true);
127  }
128
129  #[test]
130  fn use_defaults_when_global_not_set() {
131    let global_config = resolve_global_config(Default::default(), &Default::default()).config;
132    let mut config_builder = ConfigurationBuilder::new();
133    let config = config_builder.global_config(global_config).build();
134    assert_eq!(config.indent_width, 2);
135    assert_eq!(config.new_line_kind == NewLineKind::LineFeed, true);
136  }
137}
dprint_plugin_sql/configuration/builder.rs

dprint_plugin_sql/configuration/
builder.rs
