Add script to test that prettier examples are transformed properly

Author: gitKrystan

examples/bin/test.mjs

@@ -0,0 +1,116 @@
+#!/usr/bin/env node
+import chalk from 'chalk';
+import { spawn } from 'child_process';
+import fs from 'fs/promises';
+import path from 'path';
+
+const debug = process.argv.includes('--debug');
+
+const logDebug = (message) => {
+  if (debug) {
+    console.log(`[${chalk.blue('debug')}]`, message);
+  }
+};
+
+const newLine = () => console.log();
+
+const inputDir = './input';
+const expectedOutputDir = './expected-output';
+
+const run = async () => {
+  logDebug('Reading input directory...');
+
+  try {
+    const inputFiles = await fs.readdir(inputDir);
+    const originalFiles = new Map();
+
+    logDebug('Backing up input files...');
+    for (const file of inputFiles) {
+      const filePath = path.join(inputDir, file);
+      const fileContent = await fs.readFile(filePath, 'utf-8');
+      originalFiles.set(file, fileContent);
+    }
+
+    if (debug) {
+      newLine();
+    }
+    console.log('💅 Running Prettier...');
+    const prettier = spawn(
+      'prettier',
+      [
+        '.',
+        '--write',
+        '--plugin',
+        'prettier-plugin-ember-template-tag',
+        debug ? '--log-level' : null,
+        debug ? 'debug' : null,
+      ].filter(Boolean),
+      {
+        env: {
+          ...process.env,
+          FORCE_COLOR: true,
+        },
+      },
+    );
+
+    prettier.stdout.pipe(process.stdout);
+    prettier.stderr.pipe(process.stderr);
+
+    prettier.on('close', async (code) => {
+      if (code !== 0) {
+        console.error(chalk.red(`💩 Prettier exited with code ${code}`));
+        process.exit(code);
+      }
+
+      newLine();
+      console.log('👯 Comparing files...');
+
+      let allFilesMatch = true;
+
+      for (const file of inputFiles) {
+        const inputFilePath = path.join(inputDir, file);
+        const expectedOutputFilePath = path.join(expectedOutputDir, file);
+
+        try {
+          const [inputContent, expectedOutputContent] = await Promise.all([
+            fs.readFile(inputFilePath, 'utf-8'),
+            fs.readFile(expectedOutputFilePath, 'utf-8'),
+          ]);
+
+          if (inputContent === expectedOutputContent) {
+            console.log(
+              chalk.green('Pass'),
+              `${file}: Formatted content matches expected output.`,
+            );
+            logDebug(`Resetting ${file}...`);
+            await fs.writeFile(inputFilePath, originalFiles.get(file));
+          } else {
+            console.log(
+              chalk.red('Fail'),
+              `${file}: Formatted content does not match expected output.`,
+            );
+            allFilesMatch = false;
+          }
+        } catch (err) {
+          console.error(chalk.red(`Error processing ${file}:`), err);
+          allFilesMatch = false;
+        }
+      }
+
+      newLine();
+
+      if (allFilesMatch) {
+        console.log('👋 Exiting...', chalk.green('SUCCESS'));
+        process.exit(0);
+      } else {
+        console.log('👋 Exiting...', chalk.red('FAIL'));
+        process.exit(1);
+      }
+    });
+  } catch (err) {
+    console.error(chalk.red('💩 Error:'), err);
+    process.exit(2);
+  }
+};
+
+run();

examples/expected-output/example.gjs

@@ -0,0 +1,13 @@
+import Component from '@glimmer/component';
+
+/**
+ * An example GJS file on which we can run the Prettier for GJS plugin.
+ */
+class MyComponent extends Component {
+  <template>
+    <h1>
+      Class top level template. Class top level template. Class top level
+      template. Class top level template. Class top level template.
+    </h1>
+  </template>
+}

examples/expected-output/example.gts

@@ -0,0 +1,14 @@
+import type { TemplateOnlyComponent } from '@ember/component/template-only';
+
+export interface Signature {
+  Element: HTMLElement;
+  Args: {};
+  Yields: [];
+}
+
+<template>
+  Explicit default export module top level component. Explicit default export
+  module top level component. Explicit default export module top level
+  component. Explicit default export module top level component. Explicit
+  default export module top level component.
+</template> as TemplateOnlyComponent<Signature>

examples/example.gjs examples/input/example.gjsexamples/example.gjs renamed to examples/input/example.gjs

@@ -3,11 +3,15 @@
   "private": true,
   "version": "0.0.0",
   "scripts": {
-    "example": "pnpm exec prettier . --write --plugin prettier-plugin-ember-template-tag --log-level debug",
-    "example-debug": "pnpm exec prettier . --write --plugin prettier-plugin-ember-template-tag --log-level debug"
+    "example": "pnpm exec prettier . --write --plugin prettier-plugin-ember-template-tag",
+    "example-debug": "pnpm exec prettier . --write --plugin prettier-plugin-ember-template-tag --log-level debug",
+    "test": "./bin/test.mjs"
   },
   "dependencies": {
     "prettier": "^3.0.3",
     "prettier-plugin-ember-template-tag": "workspace:^"
+  },
+  "devDependencies": {
+    "chalk": "^5.3.0"
   }
 }

examples/example.gts examples/input/example.gtsexamples/example.gts renamed to examples/input/example.gts

@@ -42,8 +42,9 @@
     "release": "release-it",
     "release:ci": "release-it --ci",
     "release:debug": "release-it --verbose --dry-run",
-    "test:all": "concurrently \"pnpm:test:run\" \"pnpm:example\" \"pnpm:example-ts\"",
+    "test:all": "concurrently \"pnpm:test:run\" \"pnpm:test:example\"",
     "test": "vitest",
+    "test:example": "pnpm preexample && cd examples && pnpm test",
     "test:ui": "vitest --ui",
     "test:run": "vitest run"
   },