fix: externalize prettier/plugins/estree to prevent comment formatting crash

.github/workflows/ci.yml

@@ -77,4 +77,6 @@ jobs:
 
       - run: pnpm install --frozen-lockfile
 
+      - run: pnpm build
+
       - run: pnpm test

tests/cases/gts/comment-with-template.gts

@@ -0,0 +1,4 @@
+// A comment before template
+<template>
+  <div>hello</div>
+</template>

tests/unit-tests/__snapshots__/format.test.ts.snap

@@ -295,6 +295,14 @@ const three = <template>{{if true "true"}}</template>;
 "
 `;
 
+exports[`format > config > default > it formats ../cases/gts/comment-with-template.gts 1`] = `
+"// A comment before template
+<template>
+  <div>hello</div>
+</template>
+"
+`;
+
 exports[`format > config > default > it formats ../cases/gts/complex.gts 1`] = `
 "import { on } from "@ember/modifier";
 import { service } from "@ember/service";

tests/unit-tests/build-externals.test.ts

@@ -0,0 +1,32 @@
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+
+import { describe, expect, test } from 'vitest';
+
+describe('build externals', () => {
+  const distributionPath = path.resolve(
+    import.meta.dirname,
+    '../../dist/prettier-plugin-ember-template-tag.js',
+  );
+
+  test('prettier/plugins/estree is externalized, not bundled', () => {
+    const distribution = readFileSync(distributionPath, 'utf8');
+
+    // The dist should reference estree as an external dependency (require or import)
+    expect(distribution).toMatch(
+      /require\(["']prettier\/plugins\/estree["']\)|from\s+["']prettier\/plugins\/estree["']/,
+    );
+
+    // The dist should NOT contain estree printer internals (canAttachComment is
+    // a function from the estree printer that would be present if bundled)
+    expect(distribution).not.toMatch(/function\s+\w*canAttachComment/);
+  });
+
+  test('prettier/plugins/babel is externalized, not bundled', () => {
+    const distribution = readFileSync(distributionPath, 'utf8');
+
+    expect(distribution).toMatch(
+      /require\(["']prettier\/plugins\/babel["']\)|from\s+["']prettier\/plugins\/babel["']/,
+    );
+  });
+});

tests/unit-tests/config/__snapshots__/semi-false.test.ts.snap

@@ -295,6 +295,14 @@ const three = <template>{{if true "true"}}</template>
 "
 `;
 
+exports[`config > semi: false > it formats ../cases/gts/comment-with-template.gts 1`] = `
+"// A comment before template
+<template>
+  <div>hello</div>
+</template>
+"
+`;
+
 exports[`config > semi: false > it formats ../cases/gts/complex.gts 1`] = `
 "import { on } from "@ember/modifier"
 import { service } from "@ember/service"

tests/unit-tests/config/__snapshots__/template-export-default.test.ts.snap

@@ -295,6 +295,14 @@ const three = <template>{{if true "true"}}</template>;
 "
 `;
 
+exports[`config > templateExportDefault: true > it formats ../cases/gts/comment-with-template.gts 1`] = `
+"// A comment before template
+<template>
+  <div>hello</div>
+</template>
+"
+`;
+
 exports[`config > templateExportDefault: true > it formats ../cases/gts/complex.gts 1`] = `
 "import { on } from "@ember/modifier";
 import { service } from "@ember/service";

vite.config.mjs

@@ -6,8 +6,8 @@ export default defineConfig({
       external: [
         'content-tag',
         'prettier',
-        'prettier/plugins/estree.js',
-        'prettier/plugins/babel.js',
+        'prettier/plugins/estree',
+        'prettier/plugins/babel',
       ],
     },
     lib: {