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 Default for ConfigurationBuilder {
25  fn default() -> Self {
26    Self::new()
27  }
28}
29
30impl ConfigurationBuilder {
31  /// Constructs a new configuration builder.
32  pub fn new() -> ConfigurationBuilder {
33    ConfigurationBuilder {
34      config: ConfigKeyMap::new(),
35      global_config: None,
36    }
37  }
38
39  /// Gets the final configuration that can be used to format a file.
40  pub fn build(&self) -> Configuration {
41    if let Some(global_config) = &self.global_config {
42      resolve_config(self.config.clone(), global_config).config
43    } else {
44      let global_config = GlobalConfiguration::default();
45      resolve_config(self.config.clone(), &global_config).config
46    }
47  }
48
49  /// Set the global configuration.
50  pub fn global_config(&mut self, global_config: GlobalConfiguration) -> &mut Self {
51    self.global_config = Some(global_config);
52    self
53  }
54
55  /// The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.
56  /// Default: 120
57  pub fn line_width(&mut self, value: u32) -> &mut Self {
58    self.insert("lineWidth", (value as i32).into())
59  }
60
61  /// The kind of newline to use.
62  /// Default: `NewLineKind::LineFeed`
63  pub fn new_line_kind(&mut self, value: NewLineKind) -> &mut Self {
64    self.insert("newLineKind", value.to_string().into())
65  }
66
67  /// Whether to always break a `HEALTHCHECK` command onto its own continuation
68  /// line when the instruction has options, even if it would fit on one line.
69  /// Default: `false`
70  pub fn healthcheck_cmd_new_line(&mut self, value: bool) -> &mut Self {
71    self.insert("healthcheckCmdNewLine", value.into())
72  }
73
74  #[cfg(test)]
75  pub(super) fn get_inner_config(&self) -> ConfigKeyMap {
76    self.config.clone()
77  }
78
79  fn insert(&mut self, name: &str, value: ConfigKeyValue) -> &mut Self {
80    self.config.insert(String::from(name), value);
81    self
82  }
83}
84
85#[cfg(test)]
86mod tests {
87  use dprint_core::configuration::NewLineKind;
88  use dprint_core::configuration::resolve_global_config;
89
90  use super::*;
91
92  #[test]
93  fn check_all_values_set() {
94    let mut config = ConfigurationBuilder::new();
95    config
96      .new_line_kind(NewLineKind::CarriageReturnLineFeed)
97      .line_width(90)
98      .healthcheck_cmd_new_line(true);
99
100    let inner_config = config.get_inner_config();
101    assert_eq!(inner_config.len(), 3);
102    let diagnostics = resolve_config(inner_config, &Default::default()).diagnostics;
103    assert_eq!(diagnostics.len(), 0);
104  }
105
106  #[test]
107  fn handle_global_config() {
108    let mut global_config = ConfigKeyMap::new();
109    global_config.insert(String::from("lineWidth"), 90.into());
110    global_config.insert(String::from("newLineKind"), "crlf".into());
111    global_config.insert(String::from("useTabs"), true.into());
112    let global_config = resolve_global_config(&mut global_config).config;
113    let mut config_builder = ConfigurationBuilder::new();
114    let config = config_builder.global_config(global_config).build();
115    assert_eq!(config.line_width, 90);
116    assert_eq!(config.new_line_kind, NewLineKind::CarriageReturnLineFeed);
117  }
118
119  #[test]
120  fn use_defaults_when_global_not_set() {
121    let global_config = Default::default();
122    let mut config_builder = ConfigurationBuilder::new();
123    let config = config_builder.global_config(global_config).build();
124    assert_eq!(config.new_line_kind, NewLineKind::LineFeed);
125  }
126}
dprint_plugin_dockerfile/configuration/builder.rs

dprint_plugin_dockerfile/configuration/
builder.rs
