refactor/move-scripts-to-src (#985)

* chore: move scripts to src directory It moves the modules needed by the cli from scripts to src. It lets only scripts needed by ci and dev under scripts dir. * refactor: move `bin/eventcatalog.ts`to `src/` It moves the `bin` to `scr/` dir to centralize all source files. * chore: update tsup config * refactor: update paths and references for new structure * chore: remove `copyCore` from preview cli command The preview cli command needs the `dist/` dir from the build command, so the `copyCore` is useless. * Create neat-crabs-join.md --------- Co-authored-by: David Boyne <boyneyy123@gmail.com>
event-catalog · Dec 3, 2024 · 8e95677 · 8e95677
1 parent c1026b1
commit 8e95677
Show file tree

Hide file tree

Showing 67 changed files with 32 additions and 34 deletions.
diff --git a/.changeset/neat-crabs-join.md b/.changeset/neat-crabs-join.md
@@ -0,0 +1,5 @@
+---
+"@eventcatalog/core": minor
+---
+
+chore(core): refactor to code base moving files to new src directory
diff --git a/bin/eventcatalog.js b/bin/eventcatalog.js
@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/eventcatalog.js';
diff --git a/package.json b/package.json
@@ -11,12 +11,13 @@
     "access": "public"
   },
   "bin": {
-    "eventcatalog": "bin/dist/eventcatalog.cjs"
+    "eventcatalog": "bin/eventcatalog.js"
   },
   "files": [
     "eventcatalog/",
     "!eventcatalog/**/__tests__/",
-    "bin/dist/",
+    "bin/",
+    "dist/",
     "default-files-for-collections/"
   ],
   "scripts": {

diff --git a/...atalog-to-astro-content-directory.spec.ts → ...atalog-to-astro-content-directory.spec.ts b/...atalog-to-astro-content-directory.spec.ts → ...atalog-to-astro-content-directory.spec.ts
diff --git a/...__/eventcatalog-config-file-utils.spec.ts → ...__/eventcatalog-config-file-utils.spec.ts b/...__/eventcatalog-config-file-utils.spec.ts → ...__/eventcatalog-config-file-utils.spec.ts
@@ -10,7 +10,7 @@ import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile,
   writeEventCatalogConfigFile,
-} from 'scripts/eventcatalog-config-file-utils';
+} from '../eventcatalog-config-file-utils';
 import { tmpdir } from 'os';
 
 describe('catalog-to-astro-content-directory', () => {

diff --git a/...le-catalog/commands/AddInventory/index.md → ...le-catalog/commands/AddInventory/index.md b/...le-catalog/commands/AddInventory/index.md → ...le-catalog/commands/AddInventory/index.md
diff --git a/...catalog/commands/AddInventory/schema.json → ...catalog/commands/AddInventory/schema.json b/...catalog/commands/AddInventory/schema.json → ...catalog/commands/AddInventory/schema.json
diff --git a/...nds/AddInventory/versioned/0.0.1/index.md → ...nds/AddInventory/versioned/0.0.1/index.md b/...nds/AddInventory/versioned/0.0.1/index.md → ...nds/AddInventory/versioned/0.0.1/index.md
diff --git a/.../AddInventory/versioned/0.0.1/schema.json → .../AddInventory/versioned/0.0.1/schema.json b/.../AddInventory/versioned/0.0.1/schema.json → .../AddInventory/versioned/0.0.1/schema.json
diff --git a/...mple-catalog/domains/Payment/asyncapi.yml → ...mple-catalog/domains/Payment/asyncapi.yml b/...mple-catalog/domains/Payment/asyncapi.yml → ...mple-catalog/domains/Payment/asyncapi.yml
diff --git a/...t/events/PaymentDomainTestEvent1/index.md → ...t/events/PaymentDomainTestEvent1/index.md b/...t/events/PaymentDomainTestEvent1/index.md → ...t/events/PaymentDomainTestEvent1/index.md
diff --git a/...vents/PaymentDomainTestEvent1/schema.json → ...vents/PaymentDomainTestEvent1/schema.json b/...vents/PaymentDomainTestEvent1/schema.json → ...vents/PaymentDomainTestEvent1/schema.json
diff --git a/...DomainTestEvent1/versioned/0.0.1/index.md → ...DomainTestEvent1/versioned/0.0.1/index.md b/...DomainTestEvent1/versioned/0.0.1/index.md → ...DomainTestEvent1/versioned/0.0.1/index.md
diff --git a/...ayment/flows/ProcessingOfAnOrder/index.md → ...ayment/flows/ProcessingOfAnOrder/index.md b/...ayment/flows/ProcessingOfAnOrder/index.md → ...ayment/flows/ProcessingOfAnOrder/index.md
diff --git a/...cessingOfAnOrder/versioned/0.0.1/index.md → ...cessingOfAnOrder/versioned/0.0.1/index.md b/...cessingOfAnOrder/versioned/0.0.1/index.md → ...cessingOfAnOrder/versioned/0.0.1/index.md
diff --git a/.../example-catalog/domains/Payment/index.md → .../example-catalog/domains/Payment/index.md b/.../example-catalog/domains/Payment/index.md → .../example-catalog/domains/Payment/index.md
diff --git a/...vices/ExternalPaymentService/asyncapi.yml → ...vices/ExternalPaymentService/asyncapi.yml b/...vices/ExternalPaymentService/asyncapi.yml → ...vices/ExternalPaymentService/asyncapi.yml
diff --git a/.../services/ExternalPaymentService/index.md → .../services/ExternalPaymentService/index.md b/.../services/ExternalPaymentService/index.md → .../services/ExternalPaymentService/index.md
diff --git a/...alPaymentService/versioned/0.0.1/index.md → ...alPaymentService/versioned/0.0.1/index.md b/...alPaymentService/versioned/0.0.1/index.md → ...alPaymentService/versioned/0.0.1/index.md
diff --git a/.../domains/Payment/versioned/0.0.1/index.md → .../domains/Payment/versioned/0.0.1/index.md b/.../domains/Payment/versioned/0.0.1/index.md → .../domains/Payment/versioned/0.0.1/index.md
diff --git a/...e-catalog/eventcatalog.config.defaults.js → ...e-catalog/eventcatalog.config.defaults.js b/...e-catalog/eventcatalog.config.defaults.js → ...e-catalog/eventcatalog.config.defaults.js
diff --git a/...__/example-catalog/eventcatalog.config.js → ...__/example-catalog/eventcatalog.config.js b/...__/example-catalog/eventcatalog.config.js → ...__/example-catalog/eventcatalog.config.js
diff --git a/.../Inventory/InventoryAdjusted/changelog.md → .../Inventory/InventoryAdjusted/changelog.md b/.../Inventory/InventoryAdjusted/changelog.md → .../Inventory/InventoryAdjusted/changelog.md
diff --git a/...ents/Inventory/InventoryAdjusted/index.md → ...ents/Inventory/InventoryAdjusted/index.md b/...ents/Inventory/InventoryAdjusted/index.md → ...ents/Inventory/InventoryAdjusted/index.md
diff --git a/...s/Inventory/InventoryAdjusted/schema.avro → ...s/Inventory/InventoryAdjusted/schema.avro b/...s/Inventory/InventoryAdjusted/schema.avro → ...s/Inventory/InventoryAdjusted/schema.avro
diff --git a/...s/Inventory/InventoryAdjusted/schema.json → ...s/Inventory/InventoryAdjusted/schema.json b/...s/Inventory/InventoryAdjusted/schema.json → ...s/Inventory/InventoryAdjusted/schema.json
diff --git a/...toryAdjusted/versioned/0.0.1/changelog.md → ...toryAdjusted/versioned/0.0.1/changelog.md b/...toryAdjusted/versioned/0.0.1/changelog.md → ...toryAdjusted/versioned/0.0.1/changelog.md
diff --git a/...nventoryAdjusted/versioned/0.0.1/index.md → ...nventoryAdjusted/versioned/0.0.1/index.md b/...nventoryAdjusted/versioned/0.0.1/index.md → ...nventoryAdjusted/versioned/0.0.1/index.md
diff --git a/...ntoryAdjusted/versioned/0.0.1/schema.avro → ...ntoryAdjusted/versioned/0.0.1/schema.avro b/...ntoryAdjusted/versioned/0.0.1/schema.avro → ...ntoryAdjusted/versioned/0.0.1/schema.avro
diff --git a/...toryAdjusted/versioned/1.0.0/changelog.md → ...toryAdjusted/versioned/1.0.0/changelog.md b/...toryAdjusted/versioned/1.0.0/changelog.md → ...toryAdjusted/versioned/1.0.0/changelog.md
diff --git a/...nventoryAdjusted/versioned/1.0.0/index.md → ...nventoryAdjusted/versioned/1.0.0/index.md b/...nventoryAdjusted/versioned/1.0.0/index.md → ...nventoryAdjusted/versioned/1.0.0/index.md
diff --git a/...ntoryAdjusted/versioned/1.0.0/schema.avro → ...ntoryAdjusted/versioned/1.0.0/schema.avro b/...ntoryAdjusted/versioned/1.0.0/schema.avro → ...ntoryAdjusted/versioned/1.0.0/schema.avro
diff --git a/...alog/events/Inventory/OutOfStock/index.md → ...alog/events/Inventory/OutOfStock/index.md b/...alog/events/Inventory/OutOfStock/index.md → ...alog/events/Inventory/OutOfStock/index.md
diff --git a/...ntory/OutOfStock/versioned/0.0.1/index.md → ...ntory/OutOfStock/versioned/0.0.1/index.md b/...ntory/OutOfStock/versioned/0.0.1/index.md → ...ntory/OutOfStock/versioned/0.0.1/index.md
diff --git a/...atalog/events/Order/OrderAmended/index.md → ...atalog/events/Order/OrderAmended/index.md b/...atalog/events/Order/OrderAmended/index.md → ...atalog/events/Order/OrderAmended/index.md
diff --git a/...log/events/Order/OrderAmended/schema.avro → ...log/events/Order/OrderAmended/schema.avro b/...log/events/Order/OrderAmended/schema.avro → ...log/events/Order/OrderAmended/schema.avro
diff --git a/...log/events/Order/OrderAmended/schema.json → ...log/events/Order/OrderAmended/schema.json b/...log/events/Order/OrderAmended/schema.json → ...log/events/Order/OrderAmended/schema.json
diff --git a/...alog/events/Order/OrderCancelled/index.md → ...alog/events/Order/OrderCancelled/index.md b/...alog/events/Order/OrderCancelled/index.md → ...alog/events/Order/OrderCancelled/index.md
diff --git a/...g/events/Order/OrderCancelled/schema.json → ...g/events/Order/OrderCancelled/schema.json b/...g/events/Order/OrderCancelled/schema.json → ...g/events/Order/OrderCancelled/schema.json
diff --git a/...alog/events/Order/OrderConfirmed/index.md → ...alog/events/Order/OrderConfirmed/index.md b/...alog/events/Order/OrderConfirmed/index.md → ...alog/events/Order/OrderConfirmed/index.md
diff --git a/...g/events/Order/OrderConfirmed/schema.json → ...g/events/Order/OrderConfirmed/schema.json b/...g/events/Order/OrderConfirmed/schema.json → ...g/events/Order/OrderConfirmed/schema.json
diff --git a/...g/flows/Payment/PaymentProcessed/index.md → ...g/flows/Payment/PaymentProcessed/index.md b/...g/flows/Payment/PaymentProcessed/index.md → ...g/flows/Payment/PaymentProcessed/index.md
diff --git a/...PaymentProcessed/versioned/0.0.1/index.md → ...PaymentProcessed/versioned/0.0.1/index.md b/...PaymentProcessed/versioned/0.0.1/index.md → ...PaymentProcessed/versioned/0.0.1/index.md
diff --git a/...Subscriptions/CancelSubscription/index.md → ...Subscriptions/CancelSubscription/index.md b/...Subscriptions/CancelSubscription/index.md → ...Subscriptions/CancelSubscription/index.md
diff --git a/...ts/__tests__/example-catalog/package.json → src/__tests__/example-catalog/package.json b/...ts/__tests__/example-catalog/package.json → src/__tests__/example-catalog/package.json
diff --git a/...alog/services/PaymentService/asyncapi.yml → ...alog/services/PaymentService/asyncapi.yml b/...alog/services/PaymentService/asyncapi.yml → ...alog/services/PaymentService/asyncapi.yml
diff --git a/...ntService/events/PaymentAccepted/index.md → ...ntService/events/PaymentAccepted/index.md b/...ntService/events/PaymentAccepted/index.md → ...ntService/events/PaymentAccepted/index.md
diff --git a/...ervice/events/PaymentAccepted/schema.json → ...ervice/events/PaymentAccepted/schema.json b/...ervice/events/PaymentAccepted/schema.json → ...ervice/events/PaymentAccepted/schema.json
diff --git a/.../PaymentAccepted/versioned/0.0.1/index.md → .../PaymentAccepted/versioned/0.0.1/index.md b/.../PaymentAccepted/versioned/0.0.1/index.md → .../PaymentAccepted/versioned/0.0.1/index.md
diff --git a/...entService/flows/PaymentAccepted/index.md → ...entService/flows/PaymentAccepted/index.md b/...entService/flows/PaymentAccepted/index.md → ...entService/flows/PaymentAccepted/index.md
diff --git a/.../PaymentAccepted/versioned/0.0.1/index.md → .../PaymentAccepted/versioned/0.0.1/index.md b/.../PaymentAccepted/versioned/0.0.1/index.md → .../PaymentAccepted/versioned/0.0.1/index.md
diff --git a/...-catalog/services/PaymentService/index.md → ...-catalog/services/PaymentService/index.md b/...-catalog/services/PaymentService/index.md → ...-catalog/services/PaymentService/index.md
diff --git a/...s/PaymentService/versioned/0.0.1/index.md → ...s/PaymentService/versioned/0.0.1/index.md b/...s/PaymentService/versioned/0.0.1/index.md → ...s/PaymentService/versioned/0.0.1/index.md
diff --git a/...sts__/example-catalog/teams/full-stack.md → ...sts__/example-catalog/teams/full-stack.md b/...sts__/example-catalog/teams/full-stack.md → ...sts__/example-catalog/teams/full-stack.md
diff --git a/...__tests__/example-catalog/users/dboyne.md → ...__tests__/example-catalog/users/dboyne.md b/...__tests__/example-catalog/users/dboyne.md → ...__tests__/example-catalog/users/dboyne.md
diff --git a/scripts/analytics/analytics.js → src/analytics/analytics.js b/scripts/analytics/analytics.js → src/analytics/analytics.js
diff --git a/scripts/analytics/log-build.js → src/analytics/log-build.js b/scripts/analytics/log-build.js → src/analytics/log-build.js
diff --git a/...pts/catalog-to-astro-content-directory.js → src/catalog-to-astro-content-directory.js b/...pts/catalog-to-astro-content-directory.js → src/catalog-to-astro-content-directory.js
@@ -7,18 +7,7 @@ import { verifyRequiredFieldsAreInCatalogConfigFile, addPropertyToFrontMatter }
 import { mapCatalogToAstro } from './map-catalog-to-astro.js';
 
 const __filename = fileURLToPath(import.meta.url);
-const rootPkg = path.resolve(
-  path.dirname(__filename),
-  /**
-   * TODO: fix me =0
-   *
-   * The following is a workaround until organize the structure to have the correct path
-   * for any value of NODE_ENV
-   *
-   * @author carlosallexandre
-   */
-  process.env.NODE_ENV === 'test' ? '../' : '../../'
-);
+const rootPkg = path.resolve(path.dirname(__filename), '../');
 
 const copyFiles = async (source, target) => {
   const files = await glob(path.join(source, '**'), {

diff --git a/scripts/constants.ts → src/constants.ts b/scripts/constants.ts → src/constants.ts
diff --git a/scripts/eventcatalog-config-file-utils.js → src/eventcatalog-config-file-utils.js b/scripts/eventcatalog-config-file-utils.js → src/eventcatalog-config-file-utils.js
diff --git a/bin/eventcatalog.config.ts → src/eventcatalog.config.ts b/bin/eventcatalog.config.ts → src/eventcatalog.config.ts
diff --git a/bin/eventcatalog.ts → src/eventcatalog.ts b/bin/eventcatalog.ts → src/eventcatalog.ts
@@ -1,16 +1,15 @@
-#!/usr/bin/env node
 import { Command } from 'commander';
-import { exec, execSync } from 'node:child_process';
+import { execSync } from 'node:child_process';
 import { join } from 'node:path';
 import fs from 'fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import concurrently from 'concurrently';
-import { generate } from 'scripts/generate';
-import logBuild from 'scripts/analytics/log-build';
-import { VERSION } from 'scripts/constants';
-import { watch } from 'scripts/watcher';
-import { catalogToAstro } from 'scripts/catalog-to-astro-content-directory';
+import { generate } from './generate';
+import logBuild from './analytics/log-build';
+import { VERSION } from './constants';
+import { watch } from './watcher';
+import { catalogToAstro } from './catalog-to-astro-content-directory';
 
 const currentDir = path.dirname(fileURLToPath(import.meta.url));
 
@@ -23,16 +22,10 @@ const dir = path.resolve(process.env.PROJECT_DIR || process.cwd());
 const core = path.resolve(process.env.CATALOG_DIR || join(dir, '.eventcatalog-core'));
 
 // The project itself
-const eventCatalogDir = path.resolve(join(currentDir, '../../eventcatalog/'));
+const eventCatalogDir = path.resolve(join(currentDir, '../eventcatalog/'));
 
 program.name('eventcatalog').description('Documentation tool for event-driven architectures');
 
-const copyFolder = (from: string, to: string) => {
-  if (fs.existsSync(from)) {
-    fs.cpSync(from, to, { recursive: true });
-  }
-};
-
 const ensureDir = (dir: string) => {
   if (!fs.existsSync(dir)) {
     fs.mkdirSync(dir);
@@ -130,8 +123,9 @@ program
   });
 
 const previewCatalog = () => {
-  copyCore();
-
+  /**
+   * TODO: get the port and outDir from the eventcatalog.config.js.
+   */
   execSync(`cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' npx astro preview --root ${dir} --port 3000`, {
     cwd: core,
     stdio: 'inherit',
@@ -161,4 +155,10 @@ program
     await generate(dir);
   });
 
-program.parseAsync();
+program
+  .parseAsync()
+  .then(() => process.exit(0))
+  .catch((err) => {
+    console.error(err);
+    process.exit(1);
+  });
diff --git a/scripts/generate.js → src/generate.js b/scripts/generate.js → src/generate.js
diff --git a/scripts/map-catalog-to-astro.js → src/map-catalog-to-astro.js b/scripts/map-catalog-to-astro.js → src/map-catalog-to-astro.js
diff --git a/scripts/watcher.js → src/watcher.js b/scripts/watcher.js → src/watcher.js
diff --git a/tsconfig.json b/tsconfig.json
@@ -3,6 +3,7 @@
   "compilerOptions": {
     "strict": true,
     "baseUrl": ".",
+    "outDir": "dist/",
     "types": ["vitest/globals"]
   }
 }
diff --git a/tsup.config.js b/tsup.config.js
@@ -1,9 +1,9 @@
 import { defineConfig } from 'tsup';
 
 export default defineConfig({
-  entry: ['bin/eventcatalog.ts', 'bin/eventcatalog.config.ts'],
+  entry: ['src/**', '!src/**/__tests__/**'],
   dts: true,
-  outDir: 'bin/dist',
+  outDir: 'dist/',
   format: ['esm', 'cjs'],
   shims: true,
   clean: true,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#!/usr/bin/env node
		import '../dist/eventcatalog.js';