dprint_plugin_dockerfile/
format_text.rs

1use anyhow::Result;
2use dockerfile_parser::Dockerfile;
3use dprint_core::configuration::resolve_new_line_kind;
4use dprint_core::formatting::PrintOptions;
5use std::path::Path;
6
7use crate::configuration::Configuration;
8use crate::generation::generate;
9
10pub fn format_text(_file_path: &Path, text: &str, config: &Configuration) -> Result<Option<String>> {
11  let result = format_inner(text, config)?;
12  if result == text {
13    Ok(None)
14  } else {
15    Ok(Some(result))
16  }
17}
18
19fn format_inner(text: &str, config: &Configuration) -> Result<String> {
20  let text = strip_bom(text);
21  let node = parse_node(text)?;
22
23  Ok(dprint_core::formatting::format(
24    || generate(&node, text, config),
25    config_to_print_options(text, config),
26  ))
27}
28
29#[cfg(feature = "tracing")]
30pub fn trace_file(_file_path: &Path, text: &str, config: &Configuration) -> dprint_core::formatting::TracingResult {
31  let node = parse_node(text).unwrap();
32
33  dprint_core::formatting::trace_printing(|| generate(&node, text, config), config_to_print_options(text, config))
34}
35
36fn parse_node(text: &str) -> Result<Dockerfile> {
37  Ok(Dockerfile::parse(text)?)
38}
39
40fn strip_bom(text: &str) -> &str {
41  text.strip_prefix("\u{FEFF}").unwrap_or(text)
42}
43
44fn config_to_print_options(text: &str, config: &Configuration) -> PrintOptions {
45  PrintOptions {
46    indent_width: 1,
47    max_width: config.line_width,
48    use_tabs: false,
49    new_line_text: resolve_new_line_kind(text, config.new_line_kind),
50  }
51}
52
53#[cfg(test)]
54mod test {
55  use super::*;
56
57  #[test]
58  fn strips_bom() {
59    for input_text in ["\u{FEFF}FROM example:12.16.1\n", "\u{FEFF}FROM    example:12.16.1\n"] {
60      let text = format_text(
61        &std::path::PathBuf::from("test.dockerfile"),
62        input_text,
63        &crate::configuration::ConfigurationBuilder::new().build(),
64      )
65      .unwrap()
66      .unwrap();
67      assert_eq!(text, "FROM example:12.16.1\n");
68    }
69  }
70}