@eventcatalog/create-eventcatalog 3.1.3 → 4.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "3.1.3",
+  "version": "4.1.0",
   "bin": {
     "create-catalog": "./dist/index.js"
   },
@@ -34,6 +34,7 @@
     "cross-spawn": "6.0.5",
     "fast-glob": "^3.3.2",
     "got": "^14.0.0",
+    "ora": "^5.4.1",
     "prompts": "2.1.0",
     "rimraf": "^5.0.7",
     "tar": "^4.4.19",
@@ -44,7 +45,6 @@
   },
   "dependencies": {
     "@changesets/cli": "^2.27.6",
-    "axios": "^1.7.7",
     "uuid": "^10.0.0"
   },
   "scripts": {

package/templates/analytics.ts

@@ -1,4 +1,3 @@
-import axios from 'axios';
 import os from 'os';
 import pkg from '../package.json';
 
@@ -11,9 +10,6 @@ interface EventMetadata {
 async function raiseEvent(eventData: EventMetadata): Promise<void> {
   const url = "https://queue.simpleanalyticscdn.com/events";
   const userAgent = `@eventcatalog/create-eventcatalog/${pkg.version} (${os.platform()}; ${os.arch()}; Node/${process.version})`;
-  const headers = {
-    "Content-Type": "application/json",
-  };
 
   const payload = {
     type: "event",
@@ -28,7 +24,11 @@ async function raiseEvent(eventData: EventMetadata): Promise<void> {
   };
 
   try {
-    await axios.post(url, payload, { headers });
+    await fetch(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(payload),
+    });
   } catch (error) {
     // swallow the error
   }

package/templates/asyncapi/eventcatalog.config.js

@@ -18,6 +18,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
@@ -58,13 +65,6 @@ export default {
       },
     ],
   ],
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // Enable RSS feed for your eventcatalog
   rss: {
     enabled: true,

package/templates/confluent/eventcatalog.config.js

@@ -13,6 +13,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
@@ -25,13 +32,6 @@ export default {
     // number of items to include in the feed per resource (event, service, etc)
     limit: 20
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>',
   // This lets you copy markdown contents from EventCatalog to your clipboard

package/templates/default/eventcatalog.config.js

@@ -13,25 +13,20 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:top-level-domains',
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
     text: 'EventCatalog'
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
   llmsTxt: {

package/templates/empty/eventcatalog.config.js

@@ -13,30 +13,24 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
     text: 'EventCatalog'
   },
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
   llmsTxt: {
     enabled: true,
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 }

package/templates/eventbridge/eventcatalog.config.js

@@ -13,6 +13,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
@@ -25,13 +32,6 @@ export default {
     // number of items to include in the feed per resource (event, service, etc)
     limit: 20
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
   llmsTxt: {

package/templates/graphql/eventcatalog.config.js

@@ -18,6 +18,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: "/",
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: "EventCatalog Logo",
@@ -49,12 +56,6 @@ export default {
       },
     ],
   ],
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 };

package/templates/index.ts

@@ -4,7 +4,6 @@ import { install } from "../helpers/install";
 import os from "os";
 import fs from "fs";
 import path from "path";
-import chalk from "chalk";
 import { v4 } from 'uuid'
 
 import { GetTemplateFileArgs, InstallTemplateArgs } from "./types";
@@ -34,8 +33,6 @@ export const installTemplate = async ({
   eslint,
   organizationName
 }: InstallTemplateArgs) => {
-  console.log(chalk.bold(`Using ${packageManager}.`));
-
   /**
    * Create a package.json for the new project
    */
@@ -106,30 +103,16 @@ export const installTemplate = async ({
    * Install package.json dependencies if they exist.
    */
   if (dependencies.length) {
-    console.log();
-    console.log("Installing dependencies:");
-    for (const dependency of dependencies) {
-      console.log(`- ${chalk.cyan(dependency)}`);
-    }
-    console.log();
-
     await install(root, dependencies, installFlags);
   }
 
   if (devDependencies.length) {
-    console.log();
-    console.log("Installing devDependencies:");
-    for (const devDependency of devDependencies) {
-      // console.log(`- ${chalk.cyan(devDependency)}`);
-    }
-
     const devInstallFlags = { devDependencies: true, ...installFlags };
     await install(root, devDependencies, devInstallFlags);
   }
   /**
    * Copy the template files to the target directory.
    */
-  console.log("\nInitializing project with template:", template, "\n");
   const templatePath = path.join(__dirname, "../templates", template);
   // console.log("templatePath", templatePath, __dirname, template);
   await copy("**", root, {

package/templates/openapi/eventcatalog.config.js

@@ -18,6 +18,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: "/",
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: "EventCatalog Logo",
@@ -63,19 +70,6 @@ export default {
       },
     ],
   ],
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 };