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 type of heading to use.
83  /// Default: `HeadingKind::Atx`
84  pub fn heading_kind(&mut self, value: HeadingKind) -> &mut Self {
85    self.insert("headingKind", value.to_string().into())
86  }
87
88  /// The directive used to ignore a line.
89  /// Default: `dprint-ignore`
90  pub fn ignore_directive(&mut self, value: &str) -> &mut Self {
91    self.insert("ignoreDirective", value.to_string().into())
92  }
93
94  /// The directive used to ignore a file.
95  /// Default: `dprint-ignore-file`
96  pub fn ignore_file_directive(&mut self, value: &str) -> &mut Self {
97    self.insert("ignoreFileDirective", value.to_string().into())
98  }
99
100  /// The directive used to mark start of ignored section.
101  /// Default: `dprint-ignore-start`
102  pub fn ignore_start_directive(&mut self, value: &str) -> &mut Self {
103    self.insert("ignoreStartDirective", value.to_string().into())
104  }
105
106  /// The directive used to mark end of ignored section.
107  /// Default: `dprint-ignore-end`
108  pub fn ignore_end_directive(&mut self, value: &str) -> &mut Self {
109    self.insert("ignoreEndDirective", value.to_string().into())
110  }
111
112  pub fn deno(&mut self) -> &mut Self {
113    self
114      .text_wrap(TextWrap::Always)
115      .ignore_directive("deno-fmt-ignore")
116      .ignore_start_directive("deno-fmt-ignore-start")
117      .ignore_end_directive("deno-fmt-ignore-end")
118      .ignore_file_directive("deno-fmt-ignore-file")
119  }
120
121  #[cfg(test)]
122  pub(super) fn get_inner_config(&self) -> ConfigKeyMap {
123    self.config.clone()
124  }
125
126  fn insert(&mut self, name: &str, value: ConfigKeyValue) -> &mut Self {
127    self.config.insert(String::from(name), value);
128    self
129  }
130}
131
132#[cfg(test)]
133mod tests {
134  use dprint_core::configuration::resolve_global_config;
135  use dprint_core::configuration::NewLineKind;
136
137  use super::*;
138
139  #[test]
140  fn check_all_values_set() {
141    let mut config = ConfigurationBuilder::new();
142    config
143      .new_line_kind(NewLineKind::CarriageReturnLineFeed)
144      .line_width(90)
145      .text_wrap(TextWrap::Always)
146      .emphasis_kind(EmphasisKind::Asterisks)
147      .strong_kind(StrongKind::Underscores)
148      .unordered_list_kind(UnorderedListKind::Asterisks)
149      .heading_kind(HeadingKind::Atx)
150      .ignore_directive("test")
151      .ignore_file_directive("test")
152      .ignore_start_directive("test")
153      .ignore_end_directive("test");
154
155    let inner_config = config.get_inner_config();
156    assert_eq!(inner_config.len(), 11);
157    let diagnostics = resolve_config(inner_config, &Default::default()).diagnostics;
158    assert_eq!(diagnostics.len(), 0);
159  }
160
161  #[test]
162  fn handle_global_config() {
163    let mut global_config = ConfigKeyMap::new();
164    global_config.insert(String::from("lineWidth"), 90.into());
165    global_config.insert(String::from("newLineKind"), "crlf".into());
166    global_config.insert(String::from("useTabs"), true.into());
167    let global_config = resolve_global_config(&mut global_config).config;
168    let mut config_builder = ConfigurationBuilder::new();
169    let config = config_builder.global_config(global_config).build();
170    assert_eq!(config.line_width, 90);
171    assert_eq!(config.new_line_kind == NewLineKind::CarriageReturnLineFeed, true);
172  }
173
174  #[test]
175  fn use_markdown_defaults_when_global_not_set() {
176    let global_config = GlobalConfiguration::default();
177    let mut config_builder = ConfigurationBuilder::new();
178    let config = config_builder.global_config(global_config).build();
179    assert_eq!(config.line_width, 80); // this is different
180    assert_eq!(config.new_line_kind == NewLineKind::LineFeed, true);
181  }
182
183  #[test]
184  fn tags_valid_object() {
185    let mut config = ConfigKeyMap::new();
186    let mut tags_obj = ConfigKeyMap::new();
187    tags_obj.insert("markdown".into(), "md".into());
188    tags_obj.insert("JSX".into(), "tsx".into());
189    config.insert("tags".into(), ConfigKeyValue::Object(tags_obj));
190
191    let result = resolve_config(config, &Default::default());
192    assert_eq!(result.diagnostics.len(), 0);
193    assert_eq!(result.config.tags.get("markdown").unwrap(), "md");
194    // keys should be lowercased
195    assert_eq!(result.config.tags.get("jsx").unwrap(), "tsx");
196    assert!(result.config.tags.get("JSX").is_none());
197  }
198
199  #[test]
200  fn tags_extension_with_period() {
201    let mut config = ConfigKeyMap::new();
202    let mut tags_obj = ConfigKeyMap::new();
203    tags_obj.insert("markdown".into(), ".md".into());
204    config.insert("tags".into(), ConfigKeyValue::Object(tags_obj));
205
206    let result = resolve_config(config, &Default::default());
207    assert_eq!(result.diagnostics.len(), 1);
208    assert_eq!(result.diagnostics[0].property_name, "tags.markdown");
209    assert!(result.diagnostics[0].message.contains("without a period"));
210  }
211
212  #[test]
213  fn tags_non_string_value() {
214    let mut config = ConfigKeyMap::new();
215    let mut tags_obj = ConfigKeyMap::new();
216    tags_obj.insert("markdown".into(), true.into());
217    config.insert("tags".into(), ConfigKeyValue::Object(tags_obj));
218
219    let result = resolve_config(config, &Default::default());
220    assert_eq!(result.diagnostics.len(), 1);
221    assert_eq!(result.diagnostics[0].property_name, "tags.markdown");
222    assert!(result.diagnostics[0].message.contains("Expected string value"));
223  }
224
225  #[test]
226  fn tags_not_an_object() {
227    let mut config = ConfigKeyMap::new();
228    config.insert("tags".into(), "not_an_object".into());
229
230    let result = resolve_config(config, &Default::default());
231    assert_eq!(result.diagnostics.len(), 1);
232    assert_eq!(result.diagnostics[0].property_name, "tags");
233    assert!(result.diagnostics[0].message.contains("Expected an object"));
234  }
235}
dprint_plugin_markdown/configuration/builder.rs

dprint_plugin_markdown/configuration/
builder.rs
