add perfer_attrs_single_line option (fix #10)

docs/config.md

@@ -235,6 +235,8 @@ Default option is `"fit"`.
 Control the maximum number of attributes in one line.
 If this option is unset, there won't be any limitations.
 
+This option conflicts with `perferAttrsSingleLine` option.
+
 Default option is `null`. This option can't be `0`.
 
 ### Example for `null`
@@ -262,6 +264,35 @@ Default option is `null`. This option can't be `0`.
 ></div>
 ```
 
+## `preferAttrsSingleLine`
+
+Control whether attributes should be put on single line when possible.
+
+This option conflicts with `maxAttrsPerLine` option.
+
+Default option is `false`.
+
+### Example for `false`
+
+This `<div>` is short enough to be put on single line,
+but it won't because attributes in source code span multiple lines.
+
+```html
+<div
+  data-a
+  data-b
+></div>
+```
+
+### Example for `true`
+
+This `<div>` is short enough so it will be put on single line
+though attributes span multiple lines in source code.
+
+```html
+<div data-a data-b></div>
+```
+
 ## `*.selfClosing`
 
 This group of options controls whether an element should be self-closed or not if

dprint_plugin/deployment/schema.json

@@ -87,6 +87,10 @@
       "default": null,
       "minimum": 1
     },
+    "preferAttrsSingleLine": {
+      "type": "boolean",
+      "default": false
+    },
     "html.normal.selfClosing": {
       "type": ["boolean", "null"],
       "default": null

dprint_plugin/src/config.rs

@@ -138,6 +138,12 @@ pub(crate) fn resolve_config(
                 "maxAttrsPerLine",
                 &mut diagnostics,
             ),
+            prefer_attrs_single_line: get_value(
+                &mut config,
+                "preferAttrsSingleLine",
+                false,
+                &mut diagnostics,
+            ),
             html_normal_self_closing: get_nullable_value(
                 &mut config,
                 "html.normal.selfClosing",

markup_fmt/src/ast.rs

@@ -45,6 +45,7 @@ pub struct VueDirective<'s> {
 pub struct Element<'s> {
     pub tag_name: &'s str,
     pub attrs: Vec<Attribute<'s>>,
+    pub first_attr_same_line: bool,
     pub children: Vec<Node<'s>>,
     pub self_closing: bool,
     pub void_element: bool,

markup_fmt/src/config.rs

@@ -151,6 +151,10 @@ pub struct LanguageOptions {
     /// See [`maxAttrsPerLine`](https://github.com/g-plane/markup_fmt/blob/main/docs/config.md#maxattrsperline) on GitHub
     pub max_attrs_per_line: Option<NonZeroUsize>,
 
+    #[cfg_attr(feature = "config_serde", serde(alias = "preferAttrsSingleLine"))]
+    /// See [`preferAttrsSingleLine`](https://github.com/g-plane/markup_fmt/blob/main/docs/config.md#preferattrssingleline) on GitHub
+    pub prefer_attrs_single_line: bool,
+
     #[cfg_attr(
         feature = "config_serde",
         serde(rename = "html.normal.self_closing", alias = "html.normal.selfClosing")

markup_fmt/src/parser.rs

@@ -412,15 +412,16 @@ impl<'s> Parser<'s> {
         let void_element = helpers::is_void_element(tag_name, self.language.clone());
 
         let mut attrs = vec![];
+        let mut first_attr_same_line = true;
         loop {
-            self.skip_ws();
             match self.chars.peek() {
                 Some((_, '/')) => {
                     self.chars.next();
                     if self.chars.next_if(|(_, c)| *c == '>').is_some() {
                         return Ok(Element {
                             tag_name,
                             attrs,
+                            first_attr_same_line,
                             children: vec![],
                             self_closing: true,
                             void_element,
@@ -434,13 +435,23 @@ impl<'s> Parser<'s> {
                         return Ok(Element {
                             tag_name,
                             attrs,
+                            first_attr_same_line,
                             children: vec![],
                             self_closing: false,
                             void_element,
                         });
                     }
                     break;
                 }
+                Some((_, '\n')) => {
+                    if attrs.is_empty() {
+                        first_attr_same_line = false;
+                    }
+                    self.chars.next();
+                }
+                Some((_, c)) if c.is_ascii_whitespace() => {
+                    self.chars.next();
+                }
                 _ => {
                     attrs.push(self.parse_attr()?);
                 }
@@ -501,6 +512,7 @@ impl<'s> Parser<'s> {
         Ok(Element {
             tag_name,
             attrs,
+            first_attr_same_line,
             children,
             self_closing: false,
             void_element,

markup_fmt/src/printer.rs

@@ -206,6 +206,19 @@ impl<'s> DocGen<'s> for Element<'s> {
             Cow::from(self.tag_name)
         }));
 
+        let attrs_sep = if !self.first_attr_same_line
+            && !ctx.options.prefer_attrs_single_line
+            && self.attrs.len() > 1
+            && !ctx
+                .options
+                .max_attrs_per_line
+                .map(|value| value.get() > 1)
+                .unwrap_or_default()
+        {
+            Doc::hard_line()
+        } else {
+            Doc::line_or_space()
+        };
         let attrs = if let Some(max) = ctx.options.max_attrs_per_line {
             // fix #2
             if self.attrs.is_empty() {
@@ -218,7 +231,7 @@ impl<'s> DocGen<'s> for Element<'s> {
                     Doc::list(
                         itertools::intersperse(
                             chunk.iter().map(|attr| attr.doc(ctx)),
-                            Doc::line_or_space(),
+                            attrs_sep.clone(),
                         )
                         .collect(),
                     )
@@ -231,7 +244,7 @@ impl<'s> DocGen<'s> for Element<'s> {
             Doc::list(
                 self.attrs
                     .iter()
-                    .flat_map(|attr| [Doc::line_or_space(), attr.doc(ctx)].into_iter())
+                    .flat_map(|attr| [attrs_sep.clone(), attr.doc(ctx)].into_iter())
                     .collect(),
             )
             .nest_with_ctx(ctx)

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.default.snap

@@ -0,0 +1,17 @@
+---
+source: markup_fmt/tests/fmt.rs
+---
+<div></div>
+
+<div a="a"></div>
+
+<div a="a" b="b" c="c" d="d"></div>
+
+<div
+  a="a"
+  b="b"
+  c="c"
+  d="d"
+>
+</div>
+

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.disabled-with-max-one-attr-per-line.snap

@@ -0,0 +1,23 @@
+---
+source: markup_fmt/tests/fmt.rs
+---
+<div></div>
+
+<div a="a"></div>
+
+<div
+  a="a"
+  b="b"
+  c="c"
+  d="d"
+>
+</div>
+
+<div
+  a="a"
+  b="b"
+  c="c"
+  d="d"
+>
+</div>
+

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.disabled-with-max-two-attr-per-line.snap

@@ -0,0 +1,19 @@
+---
+source: markup_fmt/tests/fmt.rs
+---
+<div></div>
+
+<div a="a"></div>
+
+<div
+  a="a" b="b"
+  c="c" d="d"
+>
+</div>
+
+<div
+  a="a" b="b"
+  c="c" d="d"
+>
+</div>
+

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.disabled.snap

@@ -0,0 +1,17 @@
+---
+source: markup_fmt/tests/fmt.rs
+---
+<div></div>
+
+<div a="a"></div>
+
+<div a="a" b="b" c="c" d="d"></div>
+
+<div
+  a="a"
+  b="b"
+  c="c"
+  d="d"
+>
+</div>
+

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.enabled-with-max-one-attr-per-line.snap

@@ -0,0 +1,23 @@
+---
+source: markup_fmt/tests/fmt.rs
+---
+<div></div>
+
+<div a="a"></div>
+
+<div
+  a="a"
+  b="b"
+  c="c"
+  d="d"
+>
+</div>
+
+<div
+  a="a"
+  b="b"
+  c="c"
+  d="d"
+>
+</div>
+

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.enabled-with-max-two-attr-per-line.snap

@@ -0,0 +1,19 @@
+---
+source: markup_fmt/tests/fmt.rs
+---
+<div></div>
+
+<div a="a"></div>
+
+<div
+  a="a" b="b"
+  c="c" d="d"
+>
+</div>
+
+<div
+  a="a" b="b"
+  c="c" d="d"
+>
+</div>
+

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.enabled.snap

@@ -0,0 +1,11 @@
+---
+source: markup_fmt/tests/fmt.rs
+---
+<div></div>
+
+<div a="a"></div>
+
+<div a="a" b="b" c="c" d="d"></div>
+
+<div a="a" b="b" c="c" d="d"></div>
+

markup_fmt/tests/fmt/html/prefer-attrs-single-line/attrs.html

@@ -0,0 +1,11 @@
+<div>
+</div>
+
+<div
+    a="a"
+></div>
+
+<div a="a" b="b" c="c" d="d"></div>
+
+<div
+    a="a" b="b" c="c" d="d"></div>

markup_fmt/tests/fmt/html/prefer-attrs-single-line/config.toml

@@ -0,0 +1,23 @@
+[default]
+
+[disabled]
+preferAttrsSingleLine = false
+
+[enabled]
+preferAttrsSingleLine = true
+
+[disabled-with-max-one-attr-per-line]
+preferAttrsSingleLine = false
+maxAttrsPerLine = 1
+
+[enabled-with-max-one-attr-per-line]
+preferAttrsSingleLine = true
+maxAttrsPerLine = 1
+
+[disabled-with-max-two-attr-per-line]
+preferAttrsSingleLine = false
+maxAttrsPerLine = 2
+
+[enabled-with-max-two-attr-per-line]
+preferAttrsSingleLine = true
+maxAttrsPerLine = 2

markup_fmt/tests/fmt/html/tags/marquee.large-print-width.snap

@@ -5,7 +5,13 @@ source: markup_fmt/tests/fmt.rs
 
 <marquee direction="up">This text will scroll from bottom to top</marquee>
 
-<marquee direction="down" width="250" height="200" behavior="alternate" style="border:solid">
+<marquee
+  direction="down"
+  width="250"
+  height="200"
+  behavior="alternate"
+  style="border:solid"
+>
   <marquee behavior="alternate"> This text will bounce </marquee>
 </marquee>
 

markup_fmt/tests/fmt/html/tags/opening-at-end.large-print-width.snap

@@ -5,5 +5,13 @@ source: markup_fmt/tests/fmt.rs
 
 <p>Want to write us a letter? Use our<a href="contacts.html#Mailing_address"><b><a>mailing address</a></b></a>.</p>
 
-<p>Want to write us a letter? Use our<a href="contacts.html#Mailing_address" href1="contacts.html#Mailing_address" href2="contacts.html#Mailing_address" href3="contacts.html#Mailing_address" href4="contacts.html#Mailing_address"><b><a>mailing address</a></b></a>.</p>
+<p>
+  Want to write us a letter? Use our<a
+    href="contacts.html#Mailing_address"
+    href1="contacts.html#Mailing_address"
+    href2="contacts.html#Mailing_address"
+    href3="contacts.html#Mailing_address"
+    href4="contacts.html#Mailing_address"
+  ><b><a>mailing address</a></b></a>.
+</p>
 

markup_fmt/tests/fmt/html/tags/tags.default.snap

@@ -108,7 +108,12 @@ source: markup_fmt/tests/fmt.rs
   <div>string</div>
 </div>
 <ul>
-  123<li class="foo" id="bar">First</li>
+  123<li
+    class="foo"
+    id="bar"
+  >
+    First
+  </li>
   456<li class="baz">Second</li>
   789
 </ul>