feat(fmt): add prefer_single_line option

g-plane · Aug 25, 2024 · 651e854 · 651e854
1 parent 89102f3
commit 651e854
Show file tree

Hide file tree

Showing 18 changed files with 422 additions and 104 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -11,6 +11,7 @@
   - [braceSpacing](./config/brace-spacing.md)
   - [bracketSpacing](./config/bracket-spacing.md)
   - [dashSpacing](./config/dash-spacing.md)
+  - [preferSingleLine](./config/prefer-single-line.md)
   - [trimTrailingWhitespaces](./config/trim-trailing-whitespaces.md)
   - [trimTrailingZero](./config/trim-trailing-zero.md)
   - [ignoreCommentDirective](./config/ignore-comment-directive.md)
diff --git a/docs/src/config/prefer-single-line.md b/docs/src/config/prefer-single-line.md
@@ -0,0 +1,80 @@
+# `preferSingleLine`
+
+Control whether items should be placed on single line as possible, even they're originally on multiple lines.
+
+Default option value is `false`.
+
+This global option can be overridden by different syntax nodes:
+
+- `flowSequence.preferSingleLine`
+- `flowMap.preferSingleLine`
+
+## Example for `false`
+
+```yaml
+- [1,
+2,
+3]
+
+- [
+    1, 2, 3
+]
+
+- {k1: v1,
+    k2: v2,
+    k3: v3}
+
+- {
+    k1: v1, k2: v2, k3: v3}
+```
+
+will be formatted as:
+
+```yaml
+- [1, 2, 3]
+
+- [
+    1,
+    2,
+    3,
+  ]
+
+- { k1: v1, k2: v2, k3: v3 }
+
+- {
+    k1: v1,
+    k2: v2,
+    k3: v3,
+  }
+```
+
+## Example for `true`
+
+```yaml
+- [1,
+2,
+3]
+
+- [
+    1, 2, 3
+]
+
+- {k1: v1,
+    k2: v2,
+    k3: v3}
+
+- {
+    k1: v1, k2: v2, k3: v3}
+```
+
+will be formatted as:
+
+```yaml
+- [1, 2, 3]
+
+- [1, 2, 3]
+
+- { k1: v1, k2: v2, k3: v3 }
+
+- { k1: v1, k2: v2, k3: v3 }
+```
diff --git a/dprint_plugin/deployment/schema.json b/dprint_plugin/deployment/schema.json
@@ -4,6 +4,13 @@
   "title": "Config",
   "description": "Configuration for dprint-plugin-yaml.",
   "type": "object",
+  "definitions": {
+    "preferSingleLine": {
+      "description": "Control whether items should be placed on single line as possible, even they're originally on multiple lines.",
+      "type": "boolean",
+      "default": false
+    }
+  },
   "properties": {
     "printWidth": {
       "description": "The line width limitation that Pretty YAML should *(but not must)* avoid exceeding. Pretty YAML will try its best to keep line width less than this value, but it may exceed for some cases, for example, a very very long single word.",
@@ -77,6 +84,15 @@
         }
       ]
     },
+    "preferSingleLine": {
+      "$ref": "#/definitions/preferSingleLine"
+    },
+    "flowSequence.preferSingleLine": {
+      "$ref": "#/definitions/preferSingleLine"
+    },
+    "flowMap.preferSingleLine": {
+      "$ref": "#/definitions/preferSingleLine"
+    },
     "trimTrailingWhitespaces": {
       "description": "Control whether trailing whitespaces should be trimmed or not.",
       "type": "boolean",

diff --git a/dprint_plugin/src/config.rs b/dprint_plugin/src/config.rs
@@ -1,6 +1,6 @@
 use dprint_core::configuration::{
-    get_unknown_property_diagnostics, get_value, ConfigKeyMap, ConfigurationDiagnostic,
-    GlobalConfiguration, NewLineKind, ResolveConfigurationResult,
+    get_nullable_value, get_unknown_property_diagnostics, get_value, ConfigKeyMap,
+    ConfigurationDiagnostic, GlobalConfiguration, NewLineKind, ResolveConfigurationResult,
 };
 use pretty_yaml::config::*;
 
@@ -88,6 +88,17 @@ pub(crate) fn resolve_config(
                     Default::default()
                 }
             },
+            prefer_single_line: get_value(&mut config, "preferSingleLine", false, &mut diagnostics),
+            flow_sequence_prefer_single_line: get_nullable_value(
+                &mut config,
+                "flowSequence.preferSingleLine",
+                &mut diagnostics,
+            ),
+            flow_map_prefer_single_line: get_nullable_value(
+                &mut config,
+                "flowMap.preferSingleLine",
+                &mut diagnostics,
+            ),
             trim_trailing_whitespaces: get_value(
                 &mut config,
                 "trimTrailingWhitespaces",

diff --git a/pretty_yaml/src/config.rs b/pretty_yaml/src/config.rs
@@ -88,6 +88,25 @@ pub struct LanguageOptions {
     #[cfg_attr(feature = "config_serde", serde(alias = "dashSpacing"))]
     pub dash_spacing: DashSpacing,
 
+    #[cfg_attr(feature = "config_serde", serde(alias = "preferSingleLine"))]
+    pub prefer_single_line: bool,
+    #[cfg_attr(
+        feature = "config_serde",
+        serde(
+            rename = "flow_sequence.prefer_single_line",
+            alias = "flowSequence.preferSingleLine"
+        )
+    )]
+    pub flow_sequence_prefer_single_line: Option<bool>,
+    #[cfg_attr(
+        feature = "config_serde",
+        serde(
+            rename = "flow_map.prefer_single_line",
+            alias = "flowMap.preferSingleLine"
+        )
+    )]
+    pub flow_map_prefer_single_line: Option<bool>,
+
     #[cfg_attr(feature = "config_serde", serde(alias = "trimTrailingWhitespaces"))]
     pub trim_trailing_whitespaces: bool,
 
@@ -108,6 +127,9 @@ impl Default for LanguageOptions {
             brace_spacing: true,
             bracket_spacing: false,
             dash_spacing: DashSpacing::default(),
+            prefer_single_line: false,
+            flow_sequence_prefer_single_line: None,
+            flow_map_prefer_single_line: None,
             trim_trailing_whitespaces: true,
             trim_trailing_zero: false,
             ignore_comment_directive: "pretty-yaml-ignore".into(),