@eventcatalog/core 2.2.7 → 2.3.0

package/.github/workflows/verify-build.yml

@@ -22,5 +22,7 @@ jobs:
           node-version: '20.x'
       - name: Installation
         run: npm i
+      - name: Test
+        run: npm run test:ci
       - name: Build
         run: npm run verify-build:catalog

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @eventcatalog/core
 
+## 2.3.0
+
+### Minor Changes
+
+- d662cb1: feat(core): added custom component support for eventcatalog
+
 ## 2.2.7
 
 ### Patch Changes

package/README.md

@@ -2,6 +2,12 @@
 
 <h1>📖 EventCatalog</h1>
 
+[![MIT License][license-badge]][license]
+[![PRs Welcome][prs-badge]][prs]
+<img src="https://img.shields.io/github/actions/workflow/status/event-catalog/eventcatalog/verify-build.yml"/>
+[![Star on GitHub][github-star-badge]][github-star]
+
+
 
 <!-- [![Star on GitHub][github-star-badge]][github-star] -->
 <!-- <h3>Bring discoverability to your -->
@@ -10,9 +16,7 @@
 
 <!-- [![MIT License][license-badge]][license] -->
 <!-- [![PRs Welcome][prs-badge]][prs] -->
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-41-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
 
 <!-- [![Watch on GitHub][github-watch-badge]][github-watch] -->
 <!-- [![Star on GitHub][github-star-badge]][github-star] -->
@@ -23,9 +27,9 @@
 
 <h4>Features: Documentation generator for Event Driven Architectures, Markdown driven, Document Domains/Services/Messages/Schemas and more, Content versioning, Assign Owners, Schemas, OpenAPI, MDX Components and more...</h4>
 
-[![MIT License][license-badge]][license]
-[![PRs Welcome][prs-badge]][prs]
-[![All Contributors](https://img.shields.io/badge/all_contributors-37-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-41-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [Read the Docs](https://eventcatalog.dev/) | [Edit the Docs](https://github.com/event-catalog/docs) | [View Demo](https://demo.eventcatalog.dev/docs)
 
@@ -216,4 +220,4 @@ You can find more [details on our website](https://eventcatalog.dev/support).
 
 # License
 
-MIT.
+MIT.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/core",
   "type": "module",
-  "version": "2.2.7",
+  "version": "2.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -13,7 +13,8 @@
     "dev:local": "concurrently \"node scripts/watcher.js\" \"astro dev\"",
     "build:bin": "tsup",
     "prepublishOnly": "npm run build:bin",
-    "test": "jest --config=$(pwd)/../../jest.config.js",
+    "test": "vitest --config vitest.config.ts",
+    "test:ci": "node scripts/ci/test.js",
     "start": "astro dev",
     "build": "npm run scripts:hydrate-content && astro check --minimumSeverity error && astro build",
     "build:cd": "node scripts/build-ci.js",
@@ -63,16 +64,16 @@
   },
   "devDependencies": {
     "@parcel/watcher": "^2.4.1",
-    "@types/jest": "^29.5.12",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "commander": "^12.1.0",
     "concurrently": "^8.2.2",
     "cross-env": "^7.0.3",
-    "jest": "^29.7.0",
     "prettier": "^3.3.3",
     "prettier-plugin-astro": "^0.14.1",
     "rimraf": "^5.0.7",
-    "tsup": "^8.1.0"
+    "tsup": "^8.1.0",
+    "vite-tsconfig-paths": "^4.3.2",
+    "vitest": "^2.0.5"
   }
 }

package/scripts/catalog-to-astro-content-directory.js

@@ -97,6 +97,23 @@ const copyFiles = async ({ source, target, catalogFilesDir, pathToMarkdownFiles,
   }
 };
 
+const copyComponents = async ({ source, target }) => {
+  const componentsDir = path.join(source, 'components');
+  const componentsTarget = path.join(target, '../custom-defined-components');
+
+  // Clear the component directory before we copy files over
+  if (fs.existsSync(componentsTarget)) {
+    await fs.rmSync(componentsTarget, { recursive: true });
+  }
+
+  if (!fs.existsSync(componentsDir) || !fs.statSync(componentsDir).isDirectory()) {
+    return;
+  }
+
+  // Copy files
+  await fs.cpSync(componentsDir, componentsTarget, { recursive: true });
+};
+
 export const catalogToAstro = async (source, astroContentDir, catalogFilesDir) => {
   // Config file
   const astroConfigFile = fs.readFileSync(path.join(astroContentDir, 'config.ts'));
@@ -211,6 +228,9 @@ export const catalogToAstro = async (source, astroContentDir, catalogFilesDir) =
     pathToAllFiles: [],
     type: 'pages',
   });
+
+  // Copy the components if they are defined
+  await copyComponents({ source, target: astroContentDir, catalogFilesDir });
 };
 
 if (process.env.NODE_ENV !== 'test') {

package/scripts/ci/test.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+/**
+ * Script for GitHub Actions
+ * Sets up the project with required files
+ */
+
+import { join } from 'node:path';
+import fs from 'fs';
+import { execSync } from 'node:child_process';
+
+const args = process.argv.slice(2);
+const catalog = args[0] || 'default';
+
+const catalogDir = join(process.cwd());
+const projectDIR = join(process.cwd(), `/examples/${catalog}`);
+
+fs.copyFileSync(join(projectDIR, 'eventcatalog.config.js'), join(catalogDir, 'eventcatalog.config.js'));
+fs.copyFileSync(join(projectDIR, 'eventcatalog.styles.css'), join(catalogDir, 'eventcatalog.styles.css'));
+
+execSync(`cross-env NODE_ENV=test PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run test`, {
+  cwd: catalogDir,
+  stdio: 'inherit',
+});

package/scripts/watcher.js

@@ -2,6 +2,7 @@
 import watcher from '@parcel/watcher';
 import path from 'path';
 import fs from 'fs';
+import os from 'os';
 
 // Where the users project is located
 const projectDirectory = process.env.PROJECT_DIR || process.cwd();
@@ -10,7 +11,7 @@ const catalogDirectory = process.env.CATALOG_DIR;
 
 const contentPath = path.join(catalogDirectory, 'src', 'content');
 
-const watchList = ['domains', 'commands', 'events', 'services', 'teams', 'users', 'pages'];
+const watchList = ['domains', 'commands', 'events', 'services', 'teams', 'users', 'pages', 'components'];
 // const absoluteWatchList = watchList.map((item) => path.join(projectDirectory, item));
 
 // confirm folders exist before watching them
@@ -35,20 +36,27 @@ for (let item of [...verifiedWatchList]) {
       // Check if changlogs, they need to go into their own content folder
       if (file.includes('changelog.md')) {
         newPath = newPath.replace('src/content', 'src/content/changelogs');
-
         if (os.platform() == 'win32') {
           newPath = newPath.replace('src\\content', 'src\\content\\changelogs');
         }
       }
 
+      // Check if its a component, need to move to the correct location
+      if (newPath.includes('components')) {
+        newPath = newPath.replace('src/content/components', 'src/custom-defined-components');
+        if (os.platform() == 'win32') {
+          newPath = newPath.replace('src\\content\\components', 'src\\custom-defined-components');
+        }
+      }
+
       // If config files have changes
       if (eventPath.includes('eventcatalog.config.js') || eventPath.includes('eventcatalog.styles.css')) {
         fs.cpSync(eventPath, path.join(catalogDirectory, file));
         return;
       }
 
-      // If markdown files copy file over to the required location
-      if (eventPath.endsWith('.md') && type === 'update') {
+      // If markdown files or astro files copy file over to the required location
+      if ((eventPath.endsWith('.md') || eventPath.endsWith('.astro')) && type === 'update') {
         fs.cpSync(eventPath, newPath);
       }
 

package/tsconfig.json

@@ -7,11 +7,13 @@
       "@config": ["./eventcatalog.config.js"],
       "@eventcatalog": ["src/utils/config/catalog.ts"],
       "@components/*": ["src/components/*"],
+      "@catalog/components/*": ["src/custom-defined-components/*"],
       "@types": ["src/types/index.ts"],
       "@utils/*": ["src/utils/*"],
       "@layouts/*": ["src/layouts/*"]
     },
     "jsx": "react-jsx",
-    "jsxImportSource": "react"
+    "jsxImportSource": "react",
+    "types": ["vitest/globals"]
   }
 }

package/vitest.config.ts

@@ -0,0 +1,10 @@
+/// <reference types="vitest" />
+import { getViteConfig } from 'astro/config';
+import tsConfigPaths from 'vite-tsconfig-paths';
+
+export default getViteConfig({
+  plugins: [tsConfigPaths()],
+  test: {
+    globals: true,
+  },
+});