@eventcatalog/core 2.11.3 → 2.11.5

package/.all-contributorsrc

@@ -419,6 +419,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "skyrpex",
+      "name": "Cristian Pallarés",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1077520?v=4",
+      "profile": "https://pallares.io",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

package/.github/workflows/lint.yml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: pnpm/action-setup@v4
         with:
-          node-version: '20.x'
+          version: 9
       - name: Installation
-        run: npm ci
+        run: pnpm i
       - name: Prettier Code
-        run: npm run format:diff
+        run: pnpm run format:diff

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @eventcatalog/core
 
+## 2.11.5
+
+### Patch Changes
+
+- 61e5cf1: fix(core): fixed outdir to output to users directory now
+- 6e88fcf: chore(core): moved some GitHub CI/CD to pnpm
+- b29d4f9: chore(core): removed code that copies over files twice to users catalog.
+- a283534: fix(docs): remove blank space from the version tag
+
+## 2.11.4
+
+### Patch Changes
+
+- 7749acd: feat(core): added support for outDir
+
 ## 2.11.3
 
 ### Patch Changes

package/README.md

@@ -29,7 +29,7 @@
 <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>
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-44-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-45-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)
@@ -237,6 +237,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/hpatoio"><img src="https://avatars.githubusercontent.com/u/249948?v=4?s=100" width="100px;" alt="Simone Fumagalli"/><br /><sub><b>Simone Fumagalli</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=hpatoio" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/d-o-h"><img src="https://avatars.githubusercontent.com/u/23699653?v=4?s=100" width="100px;" alt="d-o-h"/><br /><sub><b>d-o-h</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=d-o-h" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://pallares.io"><img src="https://avatars.githubusercontent.com/u/1077520?v=4?s=100" width="100px;" alt="Cristian Pallarés"/><br /><sub><b>Cristian Pallarés</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=skyrpex" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

package/astro.config.mjs

@@ -10,7 +10,7 @@ import { join } from 'node:path';
 import config from './eventcatalog.config';
 import expressiveCode from 'astro-expressive-code';
 
-const coreDirectory = process.env.CATALOG_DIR || process.cwd();
+const projectDirectory = process.env.PROJECT_DIR || process.cwd();
 const base = config.base || '/';
 
 // https://astro.build/config
@@ -18,7 +18,7 @@ export default defineConfig({
   base,
   server: { port: config.port || 3000 },
 
-  outDir: join(coreDirectory, 'dist'),
+  outDir: config.outDir ? join(projectDirectory, config.outDir) : join(projectDirectory, 'dist'),
 
   // https://docs.astro.build/en/reference/configuration-reference/#site
   site: config.homepageLink || 'https://eventcatalog.dev/',

package/bin/dist/eventcatalog.cjs

@@ -40,16 +40,6 @@ var dir = process.cwd();
 var core = (0, import_node_path.join)(dir, ".eventcatalog-core");
 var eventCatalogDir = (0, import_node_path.join)(currentDir, "../../");
 program.name("eventcatalog").description("Documentation tool for event-driven architectures");
-var copyFile = (from, to) => {
-  if (import_fs.default.existsSync(from)) {
-    import_fs.default.cpSync(from, to);
-  }
-};
-var copyFolder = (from, to) => {
-  if (import_fs.default.existsSync(from)) {
-    import_fs.default.cpSync(from, to, { recursive: true });
-  }
-};
 var ensureDir = (dir2) => {
   if (!import_fs.default.existsSync(dir2)) {
     import_fs.default.mkdirSync(dir2);
@@ -76,9 +66,6 @@ program.command("dev").description("Run development server of EventCatalog").opt
   }
   if (options.forceRecreate) clearCore();
   copyCore();
-  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"));
   console.log("EventCatalog is starting at http://localhost:3000/docs");
   (0, import_node_child_process.execSync)(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run dev`, {
     cwd: core,
@@ -89,25 +76,17 @@ program.command("dev").description("Run development server of EventCatalog").opt
 program.command("build").description("Run build of EventCatalog").action((options) => {
   console.log("Building EventCatalog...");
   copyCore();
-  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)(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run build`, {
     cwd: core,
     stdio: "inherit"
   });
-  copyFolder((0, import_node_path.join)(core, "dist"), (0, import_node_path.join)(dir, "dist"));
 });
 var previewCatalog = () => {
   copyCore();
-  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)(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run preview -- --root ${dir} --port 3000`, {
     cwd: core,
     stdio: "inherit"
   });
-  copyFolder((0, import_node_path.join)(core, "dist"), (0, import_node_path.join)(dir, "dist"));
 };
 program.command("preview").description("Serves the contents of your eventcatalog build directory").action((options) => {
   console.log("Starting preview of your build...");
@@ -119,9 +98,6 @@ program.command("start").description("Serves the contents of your eventcatalog b
 });
 program.command("generate [siteDir]").description("Start the generator scripts.").action(() => {
   copyCore();
-  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)(`cross-env PROJECT_DIR='${dir}' npm run generate`, {
     cwd: core,
     stdio: "inherit"

package/bin/dist/eventcatalog.js

@@ -13,16 +13,6 @@ var dir = process.cwd();
 var core = join(dir, ".eventcatalog-core");
 var eventCatalogDir = join(currentDir, "../../");
 program.name("eventcatalog").description("Documentation tool for event-driven architectures");
-var copyFile = (from, to) => {
-  if (fs.existsSync(from)) {
-    fs.cpSync(from, to);
-  }
-};
-var copyFolder = (from, to) => {
-  if (fs.existsSync(from)) {
-    fs.cpSync(from, to, { recursive: true });
-  }
-};
 var ensureDir = (dir2) => {
   if (!fs.existsSync(dir2)) {
     fs.mkdirSync(dir2);
@@ -49,9 +39,6 @@ program.command("dev").description("Run development server of EventCatalog").opt
   }
   if (options.forceRecreate) clearCore();
   copyCore();
-  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"));
   console.log("EventCatalog is starting at http://localhost:3000/docs");
   execSync(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run dev`, {
     cwd: core,
@@ -62,25 +49,17 @@ program.command("dev").description("Run development server of EventCatalog").opt
 program.command("build").description("Run build of EventCatalog").action((options) => {
   console.log("Building EventCatalog...");
   copyCore();
-  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(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run build`, {
     cwd: core,
     stdio: "inherit"
   });
-  copyFolder(join(core, "dist"), join(dir, "dist"));
 });
 var previewCatalog = () => {
   copyCore();
-  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(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npm run preview -- --root ${dir} --port 3000`, {
     cwd: core,
     stdio: "inherit"
   });
-  copyFolder(join(core, "dist"), join(dir, "dist"));
 };
 program.command("preview").description("Serves the contents of your eventcatalog build directory").action((options) => {
   console.log("Starting preview of your build...");
@@ -92,9 +71,6 @@ program.command("start").description("Serves the contents of your eventcatalog b
 });
 program.command("generate [siteDir]").description("Start the generator scripts.").action(() => {
   copyCore();
-  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(`cross-env PROJECT_DIR='${dir}' npm run generate`, {
     cwd: core,
     stdio: "inherit"

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.11.3",
+  "version": "2.11.5",
   "publishConfig": {
     "access": "public"
   },

package/scripts/build-ci.js

@@ -2,7 +2,6 @@
 
 // This is used for CI on vercel. Must copy files before building.
 import { join } from 'node:path';
-import fs from 'fs';
 import { execSync } from 'node:child_process';
 const __dirname = import.meta.dirname;
 
@@ -12,10 +11,6 @@ const catalog = args[0] || 'default';
 const catalogDir = join(__dirname, '../');
 const projectDIR = join(__dirname, `../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=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run build && astro check --minimumSeverity error`,
   {

package/scripts/start-catalog-locally.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 import { join } from 'node:path';
-import fs from 'fs';
 import { execSync } from 'node:child_process';
 const __dirname = import.meta.dirname;
 
@@ -10,9 +9,6 @@ const catalog = args[0] || 'default';
 const catalogDir = join(__dirname, '../');
 const projectDIR = join(__dirname, `../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=development PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run scripts:hydrate-content && cross-env PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run dev:local`,
   {

package/src/pages/docs/[type]/[id]/[version]/index.astro

@@ -173,8 +173,8 @@ const badges = [getBadge(), ...contentBadges, ...getSpecificationBadges()];
                           class="underline hover:text-primary block pt-2"
                           href={buildUrl(`/docs/${props.collection}/${props.data.id}/${props.data.latestVersion}`)}
                         >
-                          The latest version of this {props.collection.slice(0, props.collection.length - 1)} is v
-                          {props.data.latestVersion} →
+                          The latest version of this {props.collection.slice(0, props.collection.length - 1)} is
+                          <span>v{props.data.latestVersion}</span> &rarr;
                         </a>
                       </p>
                     </div>