dprint_plugin_markdown/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/// Markdown formatting configuration builder.
9///
10/// # Example
11///
12/// ```
13/// use dprint_plugin_markdown::configuration::*;
14///
15/// let config = ConfigurationBuilder::new()
16///     .line_width(80)
17///     .build();
18/// ```
19#[derive(Default)]
20pub struct ConfigurationBuilder {
21  pub(super) config: ConfigKeyMap,
22  global_config: Option<GlobalConfiguration>,
23}
24
25impl ConfigurationBuilder {
26  /// Constructs a new configuration builder.
27  pub fn new() -> Self {
28    Self::default()
29  }
30
31  /// Gets the final configuration that can be used to format a file.
32  pub fn build(&self) -> Configuration {
33    if let Some(global_config) = &self.global_config {
34      resolve_config(self.config.clone(), global_config).config
35    } else {
36      resolve_config(self.config.clone(), &Default::default()).config
37    }
38  }
39
40  /// Set the global configuration.
41  pub fn global_config(&mut self, global_config: GlobalConfiguration) -> &mut Self {
42    self.global_config = Some(global_config);
43    self
44  }
45
46  /// The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.
47  /// Default: 80
48  pub fn line_width(&mut self, value: u32) -> &mut Self {
49    self.insert("lineWidth", (value as i32).into())
50  }
51
52  /// The kind of newline to use.
53  /// Default: `NewLineKind::LineFeed`
54  pub fn new_line_kind(&mut self, value: NewLineKind) -> &mut Self {
55    self.insert("newLineKind", value.to_string().into())
56  }
57
58  /// The kind of text wrapping to use.
59  /// Default: `TextWrap::Maintain`
60  pub fn text_wrap(&mut self, value: TextWrap) -> &mut Self {
61    self.insert("textWrap", value.to_string().into())
62  }
63
64  /// The character to use for emphasis/italics.
65  /// Default: `EmphasisKind::Underscores`
66  pub fn emphasis_kind(&mut self, value: EmphasisKind) -> &mut Self {
67    self.insert("emphasisKind", value.to_string().into())
68  }
69
70  /// The character to use for strong emphasis/bold.
71  /// Default: `StrongKind::Underscores`
72  pub fn strong_kind(&mut self, value: StrongKind) -> &mut Self {
73    self.insert("strongKind", value.to_string().into())
74  }
75
76  /// The character to use for lists.
77  /// Default: `UnorderedListKind::Dashes`
78  pub fn unordered_list_kind(&mut self, value: UnorderedListKind) -> &mut Self {
79    self.insert("unorderedListKind", value.to_string().into())
80  }
81
82  /// The directive used to ignore a line.
83  /// Default: `dprint-ignore`
84  pub fn ignore_directive(&mut self, value: &str) -> &mut Self {
85    self.insert("ignoreDirective", value.to_string().into())
86  }
87
88  /// The directive used to ignore a file.
89  /// Default: `dprint-ignore-file`
90  pub fn ignore_file_directive(&mut self, value: &str) -> &mut Self {
91    self.insert("ignoreFileDirective", value.to_string().into())
92  }
93
94  /// The directive used to mark start of ignored section.
95  /// Default: `dprint-ignore-start`
96  pub fn ignore_start_directive(&mut self, value: &str) -> &mut Self {
97    self.insert("ignoreStartDirective", value.to_string().into())
98  }
99
100  /// The directive used to mark end of ignored section.
101  /// Default: `dprint-ignore-end`
102  pub fn ignore_end_directive(&mut self, value: &str) -> &mut Self {
103    self.insert("ignoreEndDirective", value.to_string().into())
104  }
105
106  pub fn deno(&mut self) -> &mut Self {
107    self
108      .text_wrap(TextWrap::Always)
109      .ignore_directive("deno-fmt-ignore")
110      .ignore_start_directive("deno-fmt-ignore-start")
111      .ignore_end_directive("deno-fmt-ignore-end")
112      .ignore_file_directive("deno-fmt-ignore-file")
113  }
114
115  #[cfg(test)]
116  pub(super) fn get_inner_config(&self) -> ConfigKeyMap {
117    self.config.clone()
118  }
119
120  fn insert(&mut self, name: &str, value: ConfigKeyValue) -> &mut Self {
121    self.config.insert(String::from(name), value);
122    self
123  }
124}
125
126#[cfg(test)]
127mod tests {
128  use dprint_core::configuration::resolve_global_config;
129  use dprint_core::configuration::NewLineKind;
130
131  use super::*;
132
133  #[test]
134  fn check_all_values_set() {
135    let mut config = ConfigurationBuilder::new();
136    config
137      .new_line_kind(NewLineKind::CarriageReturnLineFeed)
138      .line_width(90)
139      .text_wrap(TextWrap::Always)
140      .emphasis_kind(EmphasisKind::Asterisks)
141      .strong_kind(StrongKind::Underscores)
142      .unordered_list_kind(UnorderedListKind::Asterisks)
143      .ignore_directive("test")
144      .ignore_file_directive("test")
145      .ignore_start_directive("test")
146      .ignore_end_directive("test");
147
148    let inner_config = config.get_inner_config();
149    assert_eq!(inner_config.len(), 10);
150    let diagnostics = resolve_config(inner_config, &Default::default()).diagnostics;
151    assert_eq!(diagnostics.len(), 0);
152  }
153
154  #[test]
155  fn handle_global_config() {
156    let mut global_config = ConfigKeyMap::new();
157    global_config.insert(String::from("lineWidth"), 90.into());
158    global_config.insert(String::from("newLineKind"), "crlf".into());
159    global_config.insert(String::from("useTabs"), true.into());
160    let global_config = resolve_global_config(&mut global_config).config;
161    let mut config_builder = ConfigurationBuilder::new();
162    let config = config_builder.global_config(global_config).build();
163    assert_eq!(config.line_width, 90);
164    assert_eq!(config.new_line_kind == NewLineKind::CarriageReturnLineFeed, true);
165  }
166
167  #[test]
168  fn use_markdown_defaults_when_global_not_set() {
169    let global_config = GlobalConfiguration::default();
170    let mut config_builder = ConfigurationBuilder::new();
171    let config = config_builder.global_config(global_config).build();
172    assert_eq!(config.line_width, 80); // this is different
173    assert_eq!(config.new_line_kind == NewLineKind::LineFeed, true);
174  }
175}
dprint_plugin_markdown/configuration/builder.rs

dprint_plugin_markdown/configuration/
builder.rs
