@eventcatalog/core 2.7.6 → 2.7.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eventcatalog/core
 
+## 2.7.8
+
+### Patch Changes
+
+- c67052f: fix(core): fixed generate command
+
+## 2.7.7
+
+### Patch Changes
+
+- f699aed: feat(core): added utils to read and write catalog files
+
 ## 2.7.6
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/core",
   "type": "module",
-  "version": "2.7.6",
+  "version": "2.7.8",
   "publishConfig": {
     "access": "public"
   },

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

@@ -0,0 +1,96 @@
+import { readFile, writeFile, rm } from 'node:fs/promises';
+import { existsSync } from 'fs';
+import path from 'node:path';
+
+// * Very strange behaviour 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');
+  if (existsSync(filePath)) {
+    await rm(filePath);
+  }
+}
+
+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);
+
+    await writeFile(path.join(projectDirectory, 'eventcatalog.config.cjs'), configAsCommonJS);
+
+    const configAsCJS = await import(/* @vite-ignore */ path.join(projectDirectory, 'eventcatalog.config.cjs'));
+
+    //  Clean up?
+    await writeFile(path.join(projectDirectory, 'eventcatalog.config.js'), rawFile);
+
+    await cleanup(projectDirectory);
+
+    return configAsCJS.default;
+  } catch (error) {
+    await cleanup(projectDirectory);
+  }
+};
+
+export const writeEventCatalogConfigFile = async (projectDirectory, newConfig) => {
+  try {
+    const configFilePath = path.join(projectDirectory, 'eventcatalog.config.js');
+    let content = await readFile(configFilePath, 'utf8');
+
+    // Find the start of the config object
+    const startIndex = content.indexOf('export default {');
+    if (startIndex === -1) {
+      // Just fail silently if the config object is not found
+      return;
+    }
+
+    // Update or add each new config item
+    Object.entries(newConfig).forEach(([key, value]) => {
+      const valueString = JSON.stringify(value, null, 2).replace(/"/g, "'").replace(/\n/g, '\n  ');
+
+      // Check if the key already exists
+      const keyRegex = new RegExp(`(${key}\\s*:)([^,}]+)`, 'g');
+      if (content.match(keyRegex)) {
+        // Update existing key
+        content = content.replace(keyRegex, `$1 ${valueString}`);
+      } else {
+        // Add new key-value pair
+        const insertPosition = content.indexOf('{', startIndex) + 1;
+        content = content.slice(0, insertPosition) + `\n  ${key}: ${valueString},` + content.slice(insertPosition);
+      }
+    });
+
+    // Write the updated content back to the file
+    await writeFile(configFilePath, content);
+
+    await cleanup(projectDirectory);
+  } catch (error) {
+    await cleanup(projectDirectory);
+  }
+};

package/scripts/generate.js

@@ -1,35 +1,6 @@
-import { readFile, writeFile, rm } from 'node:fs/promises';
 import path from 'node:path';
+import { getEventCatalogConfigFile, cleanup } from './eventcatalog-config-file-utils.js';
 
-/**
- * Very strange behaviour 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;
-}
-
-// TODO: Do we actually need this? Can we clean this up
 function getDefaultExport(importedModule) {
   if (importedModule === null || typeof importedModule !== 'object') {
     throw new Error('Invalid module');
@@ -46,21 +17,11 @@ function getDefaultExport(importedModule) {
   return importedModule;
 }
 
-async function cleanup() {
-  await rm(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.cjs'));
-}
-
 const generate = async () => {
   try {
-    // Fix for the file
-    const rawFile = await readFile(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.js'), 'utf8');
-
-    // Have to conver the ESM to CJS...
-    const configAsCommonJS = convertESMtoCJS(rawFile);
-    await writeFile(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.cjs'), configAsCommonJS);
+    const PROJECT_DIRECTORY = process.env.PROJECT_DIR;
 
-    const configAsCJS = await import(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.cjs'));
-    const config = configAsCJS.default;
+    const config = await getEventCatalogConfigFile(PROJECT_DIRECTORY);
 
     const { generators = [] } = config;
 
@@ -69,19 +30,16 @@ const generate = async () => {
       return;
     }
 
-    // Tidy up
-    await writeFile(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.js'), rawFile);
-
     for (const generator of generators) {
       let plugin = generator[0];
       const pluginConfig = generator[1];
 
       if (plugin.startsWith('./')) {
-        plugin = path.join(process.env.PROJECT_DIR, plugin);
+        plugin = path.join(PROJECT_DIRECTORY, plugin);
       }
 
       if (plugin.includes('<rootDir>')) {
-        plugin = plugin.replace('<rootDir>', process.env.PROJECT_DIR);
+        plugin = plugin.replace('<rootDir>', PROJECT_DIRECTORY);
       }
 
       try {