Add option dedentHtmlTagChildren to dedent children of <html> tag…

… for HTML files
nthachus · Sep 14, 2022 · 7c4c31d · 7c4c31d
1 parent 00ec91b
commit 7c4c31d
Show file tree

Hide file tree

Showing 12 changed files with 132 additions and 228 deletions.
diff --git a/src/language-html/options.js b/src/language-html/options.js
@@ -36,4 +36,11 @@ module.exports = {
     default: false,
     description: "Indent script and style tags in Vue files.",
   },
+  dedentHtmlTagChildren: {
+    since: "2.0.5",
+    category: CATEGORY_HTML,
+    type: "boolean",
+    default: false,
+    description: "Dedent children of html tag in HTML files.",
+  },
 };
diff --git a/src/language-html/print/element.js b/src/language-html/print/element.js
@@ -92,6 +92,15 @@ function printElement(path, options, print) {
     ) {
       return childrenDoc;
     }
+    if (
+      node.parent.type === "root" &&
+      node.type === "element" &&
+      node.fullName.toLowerCase() === "html" &&
+      options.parser === "html" &&
+      options.dedentHtmlTagChildren
+    ) {
+      return dedentToRoot(childrenDoc);
+    }
     return indent(childrenDoc);
   };
 

diff --git a/tests/format/html/indent/__snapshots__/jsfmt.spec.js.snap b/tests/format/html/indent/__snapshots__/jsfmt.spec.js.snap
@@ -0,0 +1,53 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`simple.html - {"dedentHtmlTagChildren":false} format 1`] = `
+====================================options=====================================
+dedentHtmlTagChildren: false
+parsers: ["html"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+<!DOCTYPE html><html>
+<head><title>Sample page</title></head><body>
+<h1>Sample page</h1><p>This page is just a demo.</p></body></html>
+
+=====================================output=====================================
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Sample page</title>
+  </head>
+  <body>
+    <h1>Sample page</h1>
+    <p>This page is just a demo.</p>
+  </body>
+</html>
+
+================================================================================
+`;
+
+exports[`simple.html - {"dedentHtmlTagChildren":true} format 1`] = `
+====================================options=====================================
+dedentHtmlTagChildren: true
+parsers: ["html"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+<!DOCTYPE html><html>
+<head><title>Sample page</title></head><body>
+<h1>Sample page</h1><p>This page is just a demo.</p></body></html>
+
+=====================================output=====================================
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Sample page</title>
+</head>
+<body>
+  <h1>Sample page</h1>
+  <p>This page is just a demo.</p>
+</body>
+</html>
+
+================================================================================
+`;
diff --git a/tests/format/html/indent/jsfmt.spec.js b/tests/format/html/indent/jsfmt.spec.js
@@ -0,0 +1,2 @@
+run_spec(__dirname, ["html"], { dedentHtmlTagChildren: true });
+run_spec(__dirname, ["html"], { dedentHtmlTagChildren: false });
diff --git a/tests/format/html/indent/simple.html b/tests/format/html/indent/simple.html
@@ -0,0 +1,3 @@
+<!DOCTYPE html><html>
+<head><title>Sample page</title></head><body>
+<h1>Sample page</h1><p>This page is just a demo.</p></body></html>
diff --git a/tests/integration/__tests__/__snapshots__/early-exit.js.snap b/tests/integration/__tests__/__snapshots__/early-exit.js.snap
@@ -64,6 +64,9 @@ Format options:
   --bracket-same-line      Put > of opening tags on the last line instead of on a new line.
                            Defaults to false.
   --no-bracket-spacing     Do not print spaces between brackets.
+  --dedent-html-tag-children
+                           Dedent children of html tag in HTML files.
+                           Defaults to false.
   --embedded-language-formatting <auto|off>
                            Control how Prettier formats quoted code embedded in the file.
                            Defaults to auto.
@@ -239,6 +242,9 @@ Format options:
   --bracket-same-line      Put > of opening tags on the last line instead of on a new line.
                            Defaults to false.
   --no-bracket-spacing     Do not print spaces between brackets.
+  --dedent-html-tag-children
+                           Dedent children of html tag in HTML files.
+                           Defaults to false.
   --embedded-language-formatting <auto|off>
                            Control how Prettier formats quoted code embedded in the file.
                            Defaults to auto.

diff --git a/tests/integration/__tests__/__snapshots__/help-options.js.snap b/tests/integration/__tests__/__snapshots__/help-options.js.snap
@@ -154,6 +154,19 @@ Default: -1
 
 exports[`show detailed usage with --help cursor-offset (write) 1`] = `[]`;
 
+exports[`show detailed usage with --help dedent-html-tag-children (stderr) 1`] = `""`;
+
+exports[`show detailed usage with --help dedent-html-tag-children (stdout) 1`] = `
+"--dedent-html-tag-children
+
+  Dedent children of html tag in HTML files.
+
+Default: false
+"
+`;
+
+exports[`show detailed usage with --help dedent-html-tag-children (write) 1`] = `[]`;
+
 exports[`show detailed usage with --help editorconfig (stderr) 1`] = `""`;
 
 exports[`show detailed usage with --help editorconfig (stdout) 1`] = `

diff --git a/tests/integration/__tests__/__snapshots__/plugin-options-string.js.snap b/tests/integration/__tests__/__snapshots__/plugin-options-string.js.snap
@@ -18,7 +18,7 @@ exports[`show external options with \`--help\` 1`] = `
 - First value
 + Second value
 
-@@ -22,16 +22,18 @@
+@@ -25,16 +25,18 @@
                              Control how Prettier formats quoted code embedded in the file.
                              Defaults to auto.
     --end-of-line <lf|crlf|cr|auto>

diff --git a/tests/integration/__tests__/__snapshots__/plugin-options.js.snap b/tests/integration/__tests__/__snapshots__/plugin-options.js.snap
@@ -61,7 +61,7 @@ exports[`show external options with \`--help\` 1`] = `
 - First value
 + Second value
 
-@@ -22,16 +22,18 @@
+@@ -25,16 +25,18 @@
                              Control how Prettier formats quoted code embedded in the file.
                              Defaults to auto.
     --end-of-line <lf|crlf|cr|auto>

diff --git a/tests/integration/__tests__/__snapshots__/schema.js.snap b/tests/integration/__tests__/__snapshots__/schema.js.snap
@@ -40,6 +40,11 @@ exports[`schema 1`] = `
 This option cannot be used with --range-start and --range-end.",
           "type": "integer",
         },
+        "dedentHtmlTagChildren": {
+          "default": false,
+          "description": "Dedent children of html tag in HTML files.",
+          "type": "boolean",
+        },
         "embeddedLanguageFormatting": {
           "default": "auto",
           "description": "Control how Prettier formats quoted code embedded in the file.",

diff --git a/tests/integration/__tests__/__snapshots__/support-info.js.snap b/tests/integration/__tests__/__snapshots__/support-info.js.snap
@@ -112,6 +112,10 @@ exports[`API getSupportInfo() 1`] = `
       },
       "type": "int",
     },
+    "dedentHtmlTagChildren": {
+      "default": false,
+      "type": "boolean",
+    },
     "embeddedLanguageFormatting": {
       "choices": [
         "auto",
@@ -835,6 +839,15 @@ exports[`CLI --support-info (stdout) 1`] = `
       "since": "1.4.0",
       "type": "int"
     },
+    {
+      "category": "HTML",
+      "default": false,
+      "description": "Dedent children of html tag in HTML files.",
+      "name": "dedentHtmlTagChildren",
+      "pluginDefaults": {},
+      "since": "2.0.5",
+      "type": "boolean"
+    },
     {
       "category": "Global",
       "choices": [