@eventcatalog/core 2.8.7 → 2.8.8

package/.github/workflows/test-e2e.yml

@@ -0,0 +1,29 @@
+name: Tests e2e
+on:
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm ci
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+    - name: Build catalog
+      shell: bash
+      run: |
+        cp $PROJECT_DIR/eventcatalog.config.js $CATALOG_DIR/eventcatalog.config.js
+        cp $PROJECT_DIR/eventcatalog.styles.css $CATALOG_DIR/eventcatalog.styles.css
+        npm run build
+      env:
+        PROJECT_DIR: ./examples/default/
+        CATALOG_DIR: ./
+        NODE_ENV: CI # Skip analytics
+    - name: Run tests
+      run: npm run test:e2e

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @eventcatalog/core
 
+## 2.8.8
+
+### Patch Changes
+
+- 3d3f56e: chore(core): changed the way eventcatalog file is now imported into the project
+
 ## 2.8.7
 
 ### Patch Changes

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.8.7",
+  "version": "2.8.8",
   "publishConfig": {
     "access": "public"
   },
@@ -20,6 +20,7 @@
     "prepublishOnly": "npm run build:bin",
     "test": "vitest --config vitest.config.ts",
     "test:ci": "node scripts/ci/test.js",
+    "test:e2e": "playwright test",
     "start": "astro dev",
     "build": "npm run scripts:hydrate-content && node scripts/analytics/log-build.js && astro build",
     "build:cd": "node scripts/build-ci.js",
@@ -52,6 +53,7 @@
     "@types/diff": "^5.2.2",
     "@types/lodash.merge": "4.6.9",
     "@types/node": "^20.14.2",
+    "@types/semver": "^7.5.8",
     "astro": "^4.16.5",
     "astro-expressive-code": "^0.36.1",
     "astro-pagefind": "^1.6.0",
@@ -77,11 +79,11 @@
     "tailwindcss": "^3.4.3",
     "typescript": "^5.4.5",
     "unist-util-visit": "^5.0.0",
-    "uuid": "^10.0.0",
-    "@types/semver": "^7.5.8"
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.5",
+    "@playwright/test": "^1.48.1",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "prettier": "^3.3.3",

package/scripts/eventcatalog-config-file-utils.js

@@ -1,38 +1,13 @@
 import { readFile, writeFile, rm } from 'node:fs/promises';
-import { existsSync } from 'fs';
+import { existsSync } from 'node:fs';
+import { copyFile } from 'node:fs/promises';
 import path from 'node:path';
 import { v4 as uuidV4 } from 'uuid';
 import { pathToFileURL } from 'url';
+import { tmpdir } from 'node:os';
 
-// * Very strange behavior when importing ESM files from catalogs into core.
-//  * Core (node) does not know how to handle ESM files, so we have to try and convert them.
-//  *
-//  * This needs sorting out! Sorry if you are reading this, but it unblocked me for now!
-//  * @param {*} content
-//  * @returns
-//  */
-function convertESMtoCJS(content) {
-  // Replace import statements with require
-  content = content.replace(/import\s+([a-zA-Z0-9{},\s*]+)\s+from\s+['"]([^'"]+)['"];/g, (match, imports, modulePath) => {
-    return `const ${imports.trim()} = require('${modulePath}');`;
-  });
-
-  // Replace export default with module.exports
-  content = content.replace(/export\s+default\s+/g, 'module.exports = ');
-
-  // Replace named exports with module.exports
-  content = content.replace(/export\s+{([^}]+)}/g, (match, exports) => {
-    return `module.exports = {${exports.trim()}};`;
-  });
-
-  // Remove declarations of __filename and __dirname
-  content = content.replace(/^\s*(const|let|var)\s+__(filename|dirname)\s+=\s+.*;?\s*$/gm, '');
-
-  return content;
-}
-
-export async function cleanup(projectDirectory) {
-  const filePath = path.join(projectDirectory, 'eventcatalog.config.cjs');
+export async function cleanup() {
+  const filePath = path.join(tmpdir(), 'eventcatalog.config.mjs');
   if (existsSync(filePath)) {
     await rm(filePath);
   }
@@ -40,25 +15,20 @@ export async function cleanup(projectDirectory) {
 
 export const getEventCatalogConfigFile = async (projectDirectory) => {
   try {
-    const rawFile = await readFile(path.join(projectDirectory, 'eventcatalog.config.js'), 'utf8');
-
-    // Have to conver the ESM to CJS...
-    const configAsCommonJS = convertESMtoCJS(rawFile);
+    let configFilePath = path.join(projectDirectory, 'eventcatalog.config.js');
 
-    await writeFile(path.join(projectDirectory, 'eventcatalog.config.cjs'), configAsCommonJS);
+    const packageJson = await import(/* @vite-ignore */ path.join(projectDirectory, 'package.json'));
+    if (packageJson.default?.type !== 'module') {
+      await copyFile(configFilePath, path.join(tmpdir(), 'eventcatalog.config.mjs'));
+      configFilePath = path.join(tmpdir(), 'eventcatalog.config.mjs');
+    }
 
-    const configFilePath = path.join(projectDirectory, 'eventcatalog.config.cjs');
     const configFileURL = pathToFileURL(configFilePath).href;
-    const configAsCJS = await import(/* @vite-ignore */ configFileURL);
-
-    //  Clean up?
-    await writeFile(path.join(projectDirectory, 'eventcatalog.config.js'), rawFile);
-
-    await cleanup(projectDirectory);
+    const config = await import(/* @vite-ignore */ configFileURL);
 
-    return configAsCJS.default;
-  } catch (error) {
-    await cleanup(projectDirectory);
+    return config.default;
+  } finally {
+    await cleanup();
   }
 };
 
@@ -92,10 +62,8 @@ export const writeEventCatalogConfigFile = async (projectDirectory, newConfig) =
 
     // Write the updated content back to the file
     await writeFile(configFilePath, content);
-
-    await cleanup(projectDirectory);
-  } catch (error) {
-    await cleanup(projectDirectory);
+  } finally {
+    await cleanup();
   }
 };