fix(storyblok): add component / blok classification

kickstartDS · Jan 29, 2024 · 8bf8f96 · 8bf8f96
1 parent f59ab35
commit 8bf8f96
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 4 deletions.
diff --git a/src/commands/cms/storyblok.ts b/src/commands/cms/storyblok.ts
@@ -31,6 +31,22 @@ const storyblok = new Command('storyblok')
     chalkTemplate`components to classify as global components`,
     ['header', 'footer', 'seo']
   )
+  .option(
+    '--components <componentNames...>',
+    chalkTemplate`components to classify as bloks`,
+    [
+      'cta',
+      'faq',
+      'features',
+      'gallery',
+      'image-text',
+      'logos',
+      'stats',
+      'teaser-card',
+      'testimonials',
+      'text',
+    ]
+  )
   .option(
     '--rc-only',
     chalkTemplate`only read configuration from {bold .schema-storyblokrc.json}, skip prompts`,
@@ -50,6 +66,7 @@ const storyblok = new Command('storyblok')
       options.updateConfig,
       options.templates,
       options.globals,
+      options.components,
       options.rcOnly,
       options.revert,
       options.cleanup,

diff --git a/src/tasks/cms/storyblok-task.ts b/src/tasks/cms/storyblok-task.ts
@@ -39,6 +39,18 @@ const run = async (
   updateConfig: boolean = true,
   templates: string[] = ['page', 'blog-post', 'blog-overview', 'settings'],
   globals: string[] = ['header', 'footer', 'seo'],
+  components: string[] = [
+    'cta',
+    'faq',
+    'features',
+    'gallery',
+    'image-text',
+    'logos',
+    'stats',
+    'teaser-card',
+    'testimonials',
+    'text',
+  ],
   rcOnly: boolean,
   isRevert: boolean,
   shouldCleanup: boolean,
@@ -62,7 +74,8 @@ const run = async (
     const elements = await schemaToStoryblok(
       customSchemaGlob,
       templates,
-      globals
+      globals,
+      components
     );
 
     shell.mkdir('-p', `${shell.pwd()}/${configurationPath}/`);

diff --git a/src/util/schema.ts b/src/util/schema.ts
@@ -189,7 +189,8 @@ ${convertedTs[schemaId]}
   const toStoryblok = async (
     schemaGlob: string,
     templates: string[],
-    globals: string[]
+    globals: string[],
+    components: string[]
   ) => {
     const ajv = getSchemaRegistry();
     const schemaIds = await processSchemaGlob(schemaGlob, ajv);
@@ -206,8 +207,10 @@ ${convertedTs[schemaId]}
           return IClassifierResult.Template;
         } else if (globals && globals.includes(name)) {
           return IClassifierResult.Global;
-        } else {
+        } else if (components && components.includes(name)) {
           return IClassifierResult.Component;
+        } else {
+          return IClassifierResult.Object;
         }
       },
     });

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -226,7 +226,8 @@ interface SchemaUtil {
     toStoryblok: (
       schemaGlob: string,
       templates: string[],
-      globals: string[]
+      globals: string[],
+      components: string[]
     ) => Promise<CMSResult<IStoryblokBlock>>;
     toStoryblokConfig: (elements: CMSResult<IStoryblokBlock>) => string;
     toUniform: (