dprint_plugin_dockerfile/configuration/
builder.rs

1use dprint_core::configuration::ConfigKeyMap;
2use dprint_core::configuration::ConfigKeyValue;
3use dprint_core::configuration::GlobalConfiguration;
4use dprint_core::configuration::NewLineKind;
5
6use super::*;
7
8/// Formatting configuration builder.
9///
10/// # Example
11///
12/// ```
13/// use dprint_plugin_dockerfile::configuration::*;
14///
15/// let config = ConfigurationBuilder::new()
16///     .line_width(80)
17///     .build();
18/// ```
19pub struct ConfigurationBuilder {
20  pub(super) config: ConfigKeyMap,
21  global_config: Option<GlobalConfiguration>,
22}
23
24impl ConfigurationBuilder {
25  /// Constructs a new configuration builder.
26  pub fn new() -> ConfigurationBuilder {
27    ConfigurationBuilder {
28      config: ConfigKeyMap::new(),
29      global_config: None,
30    }
31  }
32
33  /// Gets the final configuration that can be used to format a file.
34  pub fn build(&self) -> Configuration {
35    if let Some(global_config) = &self.global_config {
36      resolve_config(self.config.clone(), global_config).config
37    } else {
38      let global_config = GlobalConfiguration::default();
39      resolve_config(self.config.clone(), &global_config).config
40    }
41  }
42
43  /// Set the global configuration.
44  pub fn global_config(&mut self, global_config: GlobalConfiguration) -> &mut Self {
45    self.global_config = Some(global_config);
46    self
47  }
48
49  /// The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.
50  /// Default: 120
51  pub fn line_width(&mut self, value: u32) -> &mut Self {
52    self.insert("lineWidth", (value as i32).into())
53  }
54
55  /// The kind of newline to use.
56  /// Default: `NewLineKind::LineFeed`
57  pub fn new_line_kind(&mut self, value: NewLineKind) -> &mut Self {
58    self.insert("newLineKind", value.to_string().into())
59  }
60
61  #[cfg(test)]
62  pub(super) fn get_inner_config(&self) -> ConfigKeyMap {
63    self.config.clone()
64  }
65
66  fn insert(&mut self, name: &str, value: ConfigKeyValue) -> &mut Self {
67    self.config.insert(String::from(name), value);
68    self
69  }
70}
71
72#[cfg(test)]
73mod tests {
74  use dprint_core::configuration::resolve_global_config;
75  use dprint_core::configuration::NewLineKind;
76
77  use super::*;
78
79  #[test]
80  fn check_all_values_set() {
81    let mut config = ConfigurationBuilder::new();
82    config.new_line_kind(NewLineKind::CarriageReturnLineFeed).line_width(90);
83
84    let inner_config = config.get_inner_config();
85    assert_eq!(inner_config.len(), 2);
86    let diagnostics = resolve_config(inner_config, &Default::default()).diagnostics;
87    assert_eq!(diagnostics.len(), 0);
88  }
89
90  #[test]
91  fn handle_global_config() {
92    let mut global_config = ConfigKeyMap::new();
93    global_config.insert(String::from("lineWidth"), 90.into());
94    global_config.insert(String::from("newLineKind"), "crlf".into());
95    global_config.insert(String::from("useTabs"), true.into());
96    let global_config = resolve_global_config(&mut global_config).config;
97    let mut config_builder = ConfigurationBuilder::new();
98    let config = config_builder.global_config(global_config).build();
99    assert_eq!(config.line_width, 90);
100    assert_eq!(config.new_line_kind == NewLineKind::CarriageReturnLineFeed, true);
101  }
102
103  #[test]
104  fn use_defaults_when_global_not_set() {
105    let global_config = Default::default();
106    let mut config_builder = ConfigurationBuilder::new();
107    let config = config_builder.global_config(global_config).build();
108    assert_eq!(config.new_line_kind == NewLineKind::LineFeed, true);
109  }
110}
dprint_plugin_dockerfile/configuration/builder.rs

dprint_plugin_dockerfile/configuration/
builder.rs
