@eventcatalog/core 0.0.5 → 0.0.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @eventcatalog/core
 
+## 0.0.6
+
+### Patch Changes
+
+- [`ad66a66`](https://github.com/boyney123/eventcatalog/commit/ad66a66b526a167cc8da43dd2371642c9f9029f2) [#49](https://github.com/boyney123/eventcatalog/pull/49) Thanks [@boyney123](https://github.com/boyney123)! - fix: now supports any extension for event examples also added missing docs
+
 ## 0.0.5
 
 ### Patch Changes

package/components/Mdx/Admonition.tsx

@@ -17,7 +17,7 @@ interface AdmonitionProps {
   className?: string;
 }
 
-export default function Admonition({ children, type, className }: AdmonitionProps) {
+export default function Admonition({ children, type, className = '' }: AdmonitionProps) {
   const { color, icon: Icon } = getConfigurationByType(type);
 
   return (

package/components/Sidebars/EventSidebar.tsx

@@ -111,7 +111,7 @@ function EventSideBar({ event, loadedVersion }: EventSideBarProps) {
                   ? 'bg-blue-400 text-white shadow-md font-bold underline'
                   : 'bg-blue-100 text-blue-800';
                 return (
-                  <li className="text-sm inline ">
+                  <li className="text-sm inline" key={version}>
                     <Link href={`/events/${eventName}/v/${version}`}>
                       <a>
                         <span

package/components/Sidebars/ServiceSidebar.tsx

@@ -137,7 +137,7 @@ function ServiceSidebar({ service }: ServiceSideBarProps) {
           <div className="space-y-3">
             <h2 className="text-sm font-medium text-gray-500">Language</h2>
             {languages.map((value) => (
-              <div className="relative flex items-center mt-2">
+              <div className="relative flex items-center mt-2" key={value}>
                 <div className="absolute flex-shrink-0 flex items-center justify-center">
                   <span
                     className="h-2 w-2 rounded-full"

package/lib/events.ts

@@ -120,7 +120,7 @@ const getEventExamplesFromDir = (pathToExamples) => {
       return {
         name: filename,
         snippet: content,
-        langugage: extentionToLanguageMap[extension],
+        langugage: extentionToLanguageMap[extension] || extension,
       };
     });
   } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eventcatalog/core",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "publishConfig": {
     "access": "public"
   },

package/pages/_app.tsx

@@ -16,7 +16,7 @@ export default ({ Component, pageProps }: AppProps) => (
         name="description"
         content="An open source project to Discover, Explore and Document your Event Driven Architectures."
       />
-      <meta property="og:url" content="https://demo.eventcatalog.dev/" />
+      <meta property="og:url" content="https://eventcatalog.dev/" />
       <meta property="og:type" content="website" />
       <meta
         property="og:title"
@@ -26,7 +26,7 @@ export default ({ Component, pageProps }: AppProps) => (
         property="og:description"
         content="An open source tool powered by markdown to document your Event Driven Architecture."
       />
-      <meta property="og:image" content="https://demo.eventcatalog.dev/opengraph.png" />
+      <meta property="og:image" content="https://eventcatalog.dev/img/opengraph.png" />
       <meta
         property="og:image:alt"
         content="EventCatalog | Discover, Explore and Document your Event Driven Architectures."

package/pages/events/[name].tsx

@@ -56,7 +56,15 @@ export const getComponents = ({ event, schema, examples }: any) => ({
     );
   },
   Admonition,
-  EventExamples: (props) => <Examples {...props} examples={examples} showLineNumbers />,
+  EventExamples: (props) => {
+    if (examples.length > 0) {
+      return <Examples {...props} examples={examples} showLineNumbers />;
+    }
+    console.log(
+      'You are using the <EventExamples /> component without any examples, please read https://eventcatalog.dev/docs/events/adding-examples for more information'
+    );
+    return null;
+  },
   Mermaid: ({ title }: { title: string }) => (
     <div className="mx-auto w-full py-10">
       {title && <h2 className="text-lg font-medium text-gray-900 underline">{title}</h2>}