feat(fmt): add trim_trailing_whitespaces option

(close #1)

docs/config.md

@@ -186,6 +186,12 @@ outer:
  key2: value2
 ```
 
+## `trimTrailingWhitespaces`
+
+Control whether trailing whitespaces should be trimmed or not.
+
+Default option is `true`.
+
 ## `ignoreCommentDirective`
 
 Text directive for ignoring formatting specific content.

dprint_plugin/deployment/schema.json

@@ -82,6 +82,11 @@
  }
  ]
  },
+ "trimTrailingWhitespaces": {
+ "description": "Control whether trailing whitespaces should be trimmed or not.",
+ "type": "boolean",
+ "default": true
+ },
  "ignoreCommentDirective": {
  "description": "Text directive for ignoring formatting specific content.",
  "type": "string",

dprint_plugin/src/config.rs

@@ -94,6 +94,12 @@ pub(crate) fn resolve_config(
  Default::default()
  }
  },
+ trim_trailing_whitespaces: get_value(
+ &mut config,
+ "trimTrailingWhitespaces",
+ true,
+ &mut diagnostics,
+ ),
  ignore_comment_directive: get_value(
  &mut config,
  "ignoreCommentDirective",

pretty_yaml/src/config.rs

@@ -102,6 +102,10 @@ pub struct LanguageOptions {
  /// See [`dashSpacing`](https://github.com/g-plane/pretty_yaml/blob/main/docs/config.md#dashspacing) on GitHub
  pub dash_spacing: DashSpacing,
 
+ #[cfg_attr(feature = "config_serde", serde(alias = "trimTrailingWhitespaces"))]
+ /// See [`trimTrailingWhitespaces`](https://github.com/g-plane/pretty_yaml/blob/main/docs/config.md#trimtrailingwhitespaces) on GitHub
+ pub trim_trailing_whitespaces: bool,
+
  #[cfg_attr(feature = "config_serde", serde(alias = "ignoreCommentDirective"))]
  /// See [`ignoreCommentDirective`](https://github.com/g-plane/pretty_yaml/blob/main/docs/config.md#ignorecommentdirective) on GitHub
  pub ignore_comment_directive: String,
@@ -117,6 +121,7 @@ impl Default for LanguageOptions {
  brace_spacing: true,
  bracket_spacing: false,
  dash_spacing: DashSpacing::default(),
+ trim_trailing_whitespaces: true,
  ignore_comment_directive: "pretty-yaml-ignore".into(),
  }
  }

pretty_yaml/src/printer.rs

@@ -154,8 +154,10 @@ impl DocGen for BlockScalar {
  let lines = text.lines().map(|s| {
  if s.trim().is_empty() {
  String::new()
- } else {
+ } else if ctx.options.trim_trailing_whitespaces {
  s[space_len..].trim_end().to_owned()
+ } else {
+ s[space_len..].to_owned()
  }
  });
  let mut docs = vec![];
@@ -341,7 +343,7 @@ impl DocGen for Flow {
  (Some(&ctx.options.quotes), "'")
  };
  docs.push(Doc::text(quote));
- format_quoted_scalar(text, quotes_option, &mut docs);
+ format_quoted_scalar(text, quotes_option, &mut docs, ctx);
  docs.push(Doc::text(quote));
  } else if let Some(single_quoted) = self.single_quoted_scalar() {
  let text = single_quoted.text();
@@ -355,7 +357,7 @@ impl DocGen for Flow {
  (Some(&ctx.options.quotes), "\"")
  };
  docs.push(Doc::text(quote));
- format_quoted_scalar(text, quotes_option, &mut docs);
+ format_quoted_scalar(text, quotes_option, &mut docs, ctx);
  docs.push(Doc::text(quote));
  } else if let Some(plain) = self.plain_scalar() {
  let lines = plain.text().lines().map(|s| s.trim().to_owned());
@@ -1118,7 +1120,12 @@ fn format_comment(token: &SyntaxToken, ctx: &Ctx) -> Doc<'static> {
  }
 }
 
-fn format_quoted_scalar(text: &str, quotes_option: Option<&Quotes>, docs: &mut Vec<Doc<'static>>) {
+fn format_quoted_scalar(
+ text: &str,
+ quotes_option: Option<&Quotes>,
+ docs: &mut Vec<Doc<'static>>,
+ ctx: &Ctx,
+) {
  if text.is_empty() {
  return;
  }
@@ -1128,7 +1135,7 @@ fn format_quoted_scalar(text: &str, quotes_option: Option<&Quotes>, docs: &mut V
  if i > 0 {
  line = line.trim_start();
  }
- if i < last_index {
+ if i < last_index && ctx.options.trim_trailing_whitespaces {
  line = line.trim_end();
  }
  if i == 0 {

pretty_yaml/tests/fmt.rs

@@ -35,11 +35,13 @@ fn run_format_test(path: &Path, input: &str, options: &FormatOptions) -> String
  let output = format_text(&input, &options)
  .map_err(|err| format!("failed to format '{}': {:?}", path.display(), err))
  .unwrap();
- assert!(
- !output.contains(" \n"),
- "'{}' has trailing whitespace",
- path.display()
- );
+ if options.language.trim_trailing_whitespaces {
+ assert!(
+ !output.contains(" \n"),
+ "'{}' has trailing whitespaces",
+ path.display()
+ );
+ }
  let regression_format = format_text(&output, &options)
  .map_err(|err| {
  format!(

pretty_yaml/tests/fmt/trailing-whitespaces/config.toml

@@ -0,0 +1,2 @@
+[disabled]
+trimTrailingWhitespaces = false

pretty_yaml/tests/fmt/trailing-whitespaces/trailing.disabled.snap

@@ -0,0 +1,13 @@
+---
+source: pretty_yaml/tests/fmt.rs
+---
+- example: |
+ foo
+ bar 
+
+ baz
+
+- "
+ text  
+
+"

pretty_yaml/tests/fmt/trailing-whitespaces/trailing.yaml

@@ -0,0 +1,10 @@
+- example: |
+ foo
+ bar 
+ 
+ baz
+
+- "
+ text 
+ 
+ "