Merge branch 'main' into fix/break-children

withastro · Dec 27, 2023 · 5db1e33 · 5db1e33
2 parents abef6ef + 4354afd
commit 5db1e33
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 25 deletions.
diff --git a/.changeset/khaki-parrots-yawn.md b/.changeset/khaki-parrots-yawn.md
@@ -0,0 +1,5 @@
+---
+'prettier-plugin-astro': minor
+---
+
+Fix plugin sometimes including significant whitespace inside components, fragments and custom elements
diff --git a/README.md b/README.md
@@ -42,12 +42,15 @@ export default {
 
 To customize formatting behavior, see the [Configuration](#configuration) section below.
 
-## Using in VS Code
+## Formatting with the VS Code Prettier extension directly
 
 > **Note**
-> If you're using [Astro's VS Code extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode), Prettier and this plugin are already included. Only follow the guide below to format using Prettier's official extension.
+[The Astro VS Code extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode) uses Prettier and this plugin (`prettier-plugin-astro`) to format your code. You will only need to install the VS Code Prettier extension separately for formatting if:
 
-First install the [VS Code Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and add the following settings to your VS Code configuration:
+- You are not using Astro's VS Code extension.
+- You want to use features of the Prettier extension that not supported by Astro's own VS Code extension, such as the toolbar panel showing Prettier's status.
+
+Install the [VS Code Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and add the following settings to your VS Code configuration:
 
 ```json
 {
@@ -92,7 +95,7 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up your
 
 ## Sponsors
 
-Astro is generously supported by Netlify, Storyblok, and several other amazing organizations.
+Astro is free, open source software made possible by these wonderful sponsors.
 
 [❤️ Sponsor Astro! ❤️](https://github.com/withastro/.github/blob/main/FUNDING.md)
 

diff --git a/src/printer/index.ts b/src/printer/index.ts
@@ -242,7 +242,7 @@ export function print(path: AstPath, opts: ParserOptions, print: printFn): Doc {
 					}
 					if (!hugEnd && lastChild && isTextNode(lastChild)) {
 						if (isInlineElement(path, opts, node) && !didSetEndSeparator) {
-							noHugSeparatorEnd = softline;
+							noHugSeparatorEnd = line;
 						}
 						trimTextNodeRight(lastChild);
 					}

diff --git a/src/printer/utils.ts b/src/printer/utils.ts
@@ -32,7 +32,7 @@ export const dotReplace = 'ωP_';
 export const interrogationReplace = 'ΔP_';
 
 export function isInlineElement(path: AstPath, opts: ParserOptions, node: anyNode): boolean {
-	return node && node.type === 'element' && !isBlockElement(node, opts) && !isPreTagContent(path);
+	return node && isTagLikeNode(node) && !isBlockElement(node, opts) && !isPreTagContent(path);
 }
 
 export function isBreakChildrenElement(node: anyNode): boolean {
@@ -41,13 +41,10 @@ export function isBreakChildrenElement(node: anyNode): boolean {
 
 export function isBlockElement(node: anyNode, opts: ParserOptions): boolean {
 	return (
-		(node &&
-			node.type === 'element' &&
-			opts.htmlWhitespaceSensitivity !== 'strict' &&
-			(opts.htmlWhitespaceSensitivity === 'ignore' ||
-				blockElements.includes(node.name as TagName))) ||
-		node.type === 'component' ||
-		node.type === 'fragment'
+		node &&
+		node.type === 'element' &&
+		opts.htmlWhitespaceSensitivity !== 'strict' &&
+		(opts.htmlWhitespaceSensitivity === 'ignore' || blockElements.includes(node.name as TagName))
 	);
 }
 
@@ -136,10 +133,6 @@ export function shouldHugStart(node: anyNode, opts: ParserOptions): boolean {
 		return false;
 	}
 
-	if (node.type === 'fragment') {
-		return false;
-	}
-
 	if (!isNodeWithChildren(node)) {
 		return false;
 	}

diff --git a/test/fixtures/basic/html-custom-elements/output.astro b/test/fixtures/basic/html-custom-elements/output.astro
@@ -1 +1 @@
-<custom-element></custom-element>
+<custom-element> </custom-element>
diff --git a/test/fixtures/markdown/embedded-in-markdown/input.md b/test/fixtures/markdown/embedded-in-markdown/input.md
@@ -59,9 +59,7 @@ For best results, you should only have one `<style>` tag per-Astro component. Th
       }
     </style>
   </head>
-  <body>
-    ...
-  </body>
+  <body> ...</body>
 </html>
 ```
 

diff --git a/test/fixtures/other/fragment/input.astro b/test/fixtures/other/fragment/input.astro
@@ -11,5 +11,9 @@
             Hello world!</>
           <Fragment>
             <span>lorem</span></Fragment>
+						<>Hello world!
+						</>
+          <Fragment><span>lorem</span>
+					</Fragment>
         </body>
 </html>
diff --git a/test/fixtures/other/fragment/output.astro b/test/fixtures/other/fragment/output.astro
@@ -7,9 +7,9 @@
     <title>Document</title>
   </head>
   <body>
-    <>Hello world!</>
-    <Fragment>
-      <span>lorem</span>
-    </Fragment>
+    <> Hello world!</>
+    <Fragment> <span>lorem</span></Fragment>
+    <>Hello world! </>
+    <Fragment><span>lorem</span> </Fragment>
   </body>
 </html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<custom-element></custom-element>
		<custom-element> </custom-element>
-Original file line number
+Diff line change
@@ Expand Up @@
           }
         </style>
       </head>
-      <body>
-        ...
-      </body>
+      <body> ...</body>
     </html>
     ```
@@ Expand Down @@