docs-util: add exception for workflow examples modification + show su…

…mmary instead of comment (medusajs#10963) * docs-util: add exception for workflow examples modification + show summary instead of comment * add currency and country code in example * add common IDs
Klomgor · Jan 14, 2025 · 044af3f · 044af3f
1 parent cf62a0a
commit 044af3f
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-diagram.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-diagram.ts
@@ -101,9 +101,11 @@ function getStep({
   return {
     type,
     name: document.name,
-    description: associatedReflection?.comment
-      ? Handlebars.helpers.comments(associatedReflection.comment, true)
-      : "",
+    description: associatedReflection?.comment?.summary
+      ? Handlebars.helpers.comment(associatedReflection.comment.summary)
+      : associatedReflection?.comment
+        ? Handlebars.helpers.comments(associatedReflection.comment, true)
+        : "",
     link:
       type === "hook" || !associatedReflection?.url
         ? `#${document.name}`

diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-examples.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/workflow-examples.ts
@@ -24,7 +24,10 @@ export default function () {
       } else {
         exampleTags.forEach((exampleTag) => {
           exampleTag.content.forEach((part) => {
-            if (part.kind !== "code") {
+            if (
+              part.kind !== "code" ||
+              part.text.startsWith("```ts workflow={false}")
+            ) {
               exampleStr.push(part.text)
               return
             }

diff --git a/www/utils/packages/utils/src/examples-utils.ts b/www/utils/packages/utils/src/examples-utils.ts
@@ -266,10 +266,15 @@ export function getFakeStrValue({
           `id_${faker.string.alphanumeric({
             length: { min: 10, max: 20 },
           })}`,
+        region_id: "reg_123",
+        product_id: "prod_123",
+        cart_id: "cart_123",
+        order_id: "order_123",
         name: () => faker.person.firstName(),
         email: () => faker.internet.email(),
         password: () => faker.internet.password({ length: 8 }),
-        currency: () => faker.finance.currencyCode(),
+        currency_code: () => faker.finance.currencyCode().toLowerCase(),
+        country_code: () => faker.location.countryCode().toLowerCase(),
         title: () => faker.lorem.word(),
         description: () => faker.lorem.sentence(),
         url: () => faker.internet.url(),