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

dprint_plugin_markdown/configuration/
builder.rs
