@eventcatalog/core 2.0.29 → 2.0.30

package/.all-contributorsrc

@@ -374,6 +374,24 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "jacktomlinson",
+      "name": "Jack Tomlinson",
+      "avatar_url": "https://avatars.githubusercontent.com/u/15871032?v=4",
+      "profile": "https://www.jacktomlinson.co.uk/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "carlosallexandre",
+      "name": "Carlos Rodrigues",
+      "avatar_url": "https://avatars.githubusercontent.com/u/20143946?v=4",
+      "profile": "https://github.com/carlosallexandre",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @eventcatalog/core
 
+## 2.0.30
+
+### Patch Changes
+
+- 32f93a9: fix(core): running eventcatalog on windows (cross-compatibility between operational systems)
+- 956dd32: fix(core): updated service list to render with with name rather than id
+- 6580ff2: fix(core): fixed missing base in redirect target
+
 ## 2.0.29
 
 ### Patch Changes

package/README.md

@@ -11,7 +11,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-39-orange.svg?style=flat-square)](#contributors-)
+[![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] -->
@@ -193,6 +193,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="http://www.ennovative-solutions.be"><img src="https://avatars.githubusercontent.com/u/2007116?v=4?s=100" width="100px;" alt="Baerten Dennis"/><br /><sub><b>Baerten Dennis</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=debae" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ryancormack"><img src="https://avatars.githubusercontent.com/u/1962883?v=4?s=100" width="100px;" alt="Ryan Cormack"/><br /><sub><b>Ryan Cormack</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=ryancormack" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://natee.biz"><img src="https://avatars.githubusercontent.com/u/4300215?v=4?s=100" width="100px;" alt="Nathan Birrell"/><br /><sub><b>Nathan Birrell</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=nathanbirrell" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.jacktomlinson.co.uk/"><img src="https://avatars.githubusercontent.com/u/15871032?v=4?s=100" width="100px;" alt="Jack Tomlinson"/><br /><sub><b>Jack Tomlinson</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=jacktomlinson" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/carlosallexandre"><img src="https://avatars.githubusercontent.com/u/20143946?v=4?s=100" width="100px;" alt="Carlos Rodrigues"/><br /><sub><b>Carlos Rodrigues</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=carlosallexandre" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

package/astro.config.mjs

@@ -11,10 +11,11 @@ import config from './eventcatalog.config';
 import expressiveCode from 'astro-expressive-code';
 
 const coreDirectory = process.env.CATALOG_DIR || process.cwd();
+const base = config.base || '/';
 
 // https://astro.build/config
 export default defineConfig({
-  base: config.base || '/',
+  base,
   server: { port: config.port || 3000 },
 
   outDir: join(coreDirectory, 'dist'),
@@ -43,7 +44,7 @@ export default defineConfig({
     pagefind(),
   ],
   redirects: {
-    "/": config.landingPage || '/docs',
+    "/": join(base, config.landingPage || '/docs'),
   },
   vite: {
     build: {

package/bin/dist/eventcatalog.cjs

@@ -3118,7 +3118,7 @@ program2.command("dev").description("Run development server of EventCatalog").op
   copyFile((0, import_node_path.join)(dir, "eventcatalog.config.js"), (0, import_node_path.join)(core, "eventcatalog.config.js"));
   copyFile((0, import_node_path.join)(dir, "eventcatalog.styles.css"), (0, import_node_path.join)(core, "eventcatalog.styles.css"));
   console.log("EventCatalog is starting at http://localhost:3000/docs");
-  (0, import_node_child_process.execSync)(`PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run dev`, {
+  (0, import_node_child_process.execSync)(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run dev`, {
     cwd: core,
     // @ts-ignore
     stdio: "inherit"
@@ -3130,7 +3130,7 @@ program2.command("build").description("Run build of EventCatalog").action((optio
   copyFolder((0, import_node_path.join)(dir, "public"), (0, import_node_path.join)(core, "public"));
   copyFile((0, import_node_path.join)(dir, "eventcatalog.config.js"), (0, import_node_path.join)(core, "eventcatalog.config.js"));
   copyFile((0, import_node_path.join)(dir, "eventcatalog.styles.css"), (0, import_node_path.join)(core, "eventcatalog.styles.css"));
-  (0, import_node_child_process.execSync)(`PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run build`, {
+  (0, import_node_child_process.execSync)(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run build`, {
     cwd: core,
     stdio: "inherit"
   });
@@ -3141,7 +3141,7 @@ var previewCatalog = () => {
   copyFolder((0, import_node_path.join)(dir, "public"), (0, import_node_path.join)(core, "public"));
   copyFile((0, import_node_path.join)(dir, "eventcatalog.config.js"), (0, import_node_path.join)(core, "eventcatalog.config.js"));
   copyFile((0, import_node_path.join)(dir, "eventcatalog.styles.css"), (0, import_node_path.join)(core, "eventcatalog.styles.css"));
-  (0, import_node_child_process.execSync)(`PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run preview -- --root ${dir} --port 3000`, {
+  (0, import_node_child_process.execSync)(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run preview -- --root ${dir} --port 3000`, {
     cwd: core,
     stdio: "inherit"
   });
@@ -3160,7 +3160,7 @@ program2.command("generate [siteDir]").description("Start the generator scripts.
   copyFolder((0, import_node_path.join)(dir, "public"), (0, import_node_path.join)(core, "public"));
   copyFile((0, import_node_path.join)(dir, "eventcatalog.config.js"), (0, import_node_path.join)(core, "eventcatalog.config.js"));
   copyFile((0, import_node_path.join)(dir, "eventcatalog.styles.css"), (0, import_node_path.join)(core, "eventcatalog.styles.css"));
-  (0, import_node_child_process.execSync)(`PROJECT_DIR='${dir}' npm run generate`, {
+  (0, import_node_child_process.execSync)(`cross-env PROJECT_DIR='${dir}' npm run generate`, {
     cwd: core,
     stdio: "inherit"
   });

package/bin/dist/eventcatalog.js

@@ -3085,7 +3085,7 @@ program2.command("dev").description("Run development server of EventCatalog").op
   copyFile(join(dir, "eventcatalog.config.js"), join(core, "eventcatalog.config.js"));
   copyFile(join(dir, "eventcatalog.styles.css"), join(core, "eventcatalog.styles.css"));
   console.log("EventCatalog is starting at http://localhost:3000/docs");
-  execSync(`PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run dev`, {
+  execSync(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run dev`, {
     cwd: core,
     // @ts-ignore
     stdio: "inherit"
@@ -3097,7 +3097,7 @@ program2.command("build").description("Run build of EventCatalog").action((optio
   copyFolder(join(dir, "public"), join(core, "public"));
   copyFile(join(dir, "eventcatalog.config.js"), join(core, "eventcatalog.config.js"));
   copyFile(join(dir, "eventcatalog.styles.css"), join(core, "eventcatalog.styles.css"));
-  execSync(`PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run build`, {
+  execSync(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run build`, {
     cwd: core,
     stdio: "inherit"
   });
@@ -3108,7 +3108,7 @@ var previewCatalog = () => {
   copyFolder(join(dir, "public"), join(core, "public"));
   copyFile(join(dir, "eventcatalog.config.js"), join(core, "eventcatalog.config.js"));
   copyFile(join(dir, "eventcatalog.styles.css"), join(core, "eventcatalog.styles.css"));
-  execSync(`PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run preview -- --root ${dir} --port 3000`, {
+  execSync(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run preview -- --root ${dir} --port 3000`, {
     cwd: core,
     stdio: "inherit"
   });
@@ -3127,7 +3127,7 @@ program2.command("generate [siteDir]").description("Start the generator scripts.
   copyFolder(join(dir, "public"), join(core, "public"));
   copyFile(join(dir, "eventcatalog.config.js"), join(core, "eventcatalog.config.js"));
   copyFile(join(dir, "eventcatalog.styles.css"), join(core, "eventcatalog.styles.css"));
-  execSync(`PROJECT_DIR='${dir}' npm run generate`, {
+  execSync(`cross-env PROJECT_DIR='${dir}' npm run generate`, {
     cwd: core,
     stdio: "inherit"
   });

package/package.json

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

package/scripts/build-ci.js

@@ -16,7 +16,7 @@ fs.copyFileSync(join(projectDIR, 'eventcatalog.config.js'), join(catalogDir, 'ev
 
 fs.copyFileSync(join(projectDIR, 'eventcatalog.styles.css'), join(catalogDir, 'eventcatalog.styles.css'));
 
-execSync(`NODE_ENV=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run scripts:hydrate-content`, {
+execSync(`cross-env NODE_ENV=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run scripts:hydrate-content`, {
   cwd: catalogDir,
   stdio: 'inherit',
 });

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

@@ -2,13 +2,14 @@ import { glob } from 'glob';
 import * as path from 'node:path';
 import fs from 'fs';
 import { fileURLToPath } from 'url';
+import os from 'node:os';
 
 const __filename = fileURLToPath(import.meta.url);
 const scriptsDir = path.dirname(__filename);
 
 const getTargetPath = (source, target, type, file) => {
   const relativePath = path.relative(source, file);
-  const cleanedRelativePath = relativePath.split(`${type}/`);
+  const cleanedRelativePath = relativePath.split(type);
   const targetForEvents = path.join(type, cleanedRelativePath[1]);
   return path.join(target, targetForEvents);
 };
@@ -25,12 +26,14 @@ const copyFiles = async ({ source, target, catalogFilesDir, pathToMarkdownFiles,
   // Find all the event files
   const markdownFiles = await glob(pathToMarkdownFiles, {
     nodir: true,
+    windowsPathsNoEscape: os.platform() == 'win32',
   });
   const files = await glob(pathToAllFiles, {
     ignore: {
       ignored: (p) => /\.md$/.test(p.name),
     },
     nodir: true,
+    windowsPathsNoEscape: os.platform() == 'win32',
   });
 
   const publicDir = path.join(target, '../../public/generated');
@@ -52,7 +55,7 @@ const copyFiles = async ({ source, target, catalogFilesDir, pathToMarkdownFiles,
     }
 
     const relativePath = path.relative(source, file);
-    const cleanedRelativePath = relativePath.split(`${type}/`);
+    const cleanedRelativePath = relativePath.split(type);
     if (!cleanedRelativePath[1]) continue;
     const targetForEvents = path.join(type, cleanedRelativePath[1]);
 

package/scripts/start-catalog-locally.js

@@ -14,7 +14,7 @@ fs.copyFileSync(join(projectDIR, 'eventcatalog.config.js'), join(catalogDir, 'ev
 fs.copyFileSync(join(projectDIR, 'eventcatalog.styles.css'), join(catalogDir, 'eventcatalog.styles.css'));
 
 execSync(
-  `NODE_ENV=development PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run scripts:hydrate-content && PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run dev:local`,
+  `cross-env NODE_ENV=development PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run scripts:hydrate-content && cross-env PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run dev:local`,
   {
     cwd: catalogDir,
     stdio: 'inherit',

package/src/components/SideBars/DomainSideBar.astro

@@ -17,7 +17,7 @@ const ownersRaw = domain.data?.owners || [];
 const owners = await Promise.all(ownersRaw.map((o) => getEntry(o)));
 
 const serviceList = services.map((p) => ({
-  label: p.data.id,
+  label: p.data.name,
   badge: p.collection,
   tag: `v${p.data.version}`,
   href: buildUrl(`/docs/${p.collection}/${p.data.id}/${p.data.version}`),