[FEAT] Add option to skip formatting the Frontmatter (#417)

* feat: astroSkipFrontmatter

* chore: add tests

* style: missing commas and semis

* Create thirty-rockets-confess.md

---------

Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>

.changeset/thirty-rockets-confess.md

@@ -0,0 +1,5 @@
+---
+"prettier-plugin-astro": minor
+---
+
+Adds a new option called `astroSkipFrontmatter` to disable formatting the frontmatter. This can be useful when using other tools to format the frontmatter, such as Biome or dprint.

README.md

@@ -79,11 +79,20 @@ Set if attributes with the same name as their expression should be formatted to
 | ------- | -------------------------------- | ----------------------------- |
 | `false` | `--astro-allow-shorthand <bool>` | `astroAllowShorthand: <bool>` |
 
+### Astro Skip Frontmatter
+
+If you are using another tool to format your JavaScript code, like Biome for example, it is possible to skip formatting the frontmatter.
+
+| Default | CLI Override                     | API Override                  |
+| ------- | -------------------------------- | ----------------------------- |
+| `false` | `--astro-skip-frontmatter <bool>` | `astroSkipFrontmatter: <bool>` |
+
 ### Example `.prettierrc.cjs`
 
 ```js
 {
   astroAllowShorthand: false;
+  astroSkipFrontmatter: false;
 }
 ```
 

src/options.ts

@@ -2,6 +2,7 @@ import type { SupportOption } from 'prettier';
 
 interface PluginOptions {
 	astroAllowShorthand: boolean;
+	astroSkipFrontmatter: boolean;
 }
 
 declare module 'prettier' {
@@ -17,4 +18,10 @@ export const options: Record<keyof PluginOptions, SupportOption> = {
 		default: false,
 		description: 'Enable/disable attribute shorthand if attribute name and expression are the same',
 	},
+	astroSkipFrontmatter: {
+		category: 'Astro',
+		type: 'boolean',
+		default: false,
+		description: 'Skips the formatting of the frontmatter.',
+	},
 };

src/printer/embed.ts

@@ -123,6 +123,10 @@ export const embed = ((path: AstPath, options: Options) => {
 
 		// Frontmatter
 		if (node.type === 'frontmatter') {
+			if (options.astroSkipFrontmatter) {
+				return [group(['---', node.value, '---', hardline]), hardline];
+			}
+
 			const frontmatterContent = await wrapParserTryCatch(textToDoc, node.value, {
 				...options,
 				parser: 'babel-ts',

test/fixtures/options/option-astro-allow-skip-frontmatter-true/input.astro

@@ -0,0 +1,6 @@
+---
+			import Comp from "./comp.astro"
+---
+    <Comp options={options} />
+    <Comp options={  options  } />
+    <Comp options={ options } />

test/fixtures/options/option-astro-allow-skip-frontmatter-true/options.json

@@ -0,0 +1,3 @@
+{
+  "astroAllowSkipFrontmatter": true
+}

test/fixtures/options/option-astro-allow-skip-frontmatter-true/output.astro

@@ -0,0 +1,7 @@
+---
+			import Comp from "./comp.astro"
+---
+
+<Comp options={options} />
+<Comp options={options} />
+<Comp options={options} />