rename docgen option "volar" to "vue-component-meta"

storybookjs · Feb 23, 2024 · f910dcc · f910dcc
1 parent 388e29c
commit f910dcc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/code/frameworks/vue3-vite/src/preset.ts b/code/frameworks/vue3-vite/src/preset.ts
@@ -23,7 +23,7 @@ export const viteFinal: StorybookConfig['viteFinal'] = async (config, options) =
   const docgenPlugin = frameworkOptions.docgen ?? 'vue-docgen-api';
 
   // add docgen plugin depending on framework option
-  if (docgenPlugin === 'volar') {
+  if (docgenPlugin === 'vue-component-meta') {
     plugins.push(await vueComponentMeta());
   } else {
     plugins.push(await vueDocgen());

diff --git a/code/frameworks/vue3-vite/src/types.ts b/code/frameworks/vue3-vite/src/types.ts
@@ -8,13 +8,13 @@ export type FrameworkOptions = {
   builder?: BuilderOptions;
   /**
    * Plugin to use for generation docs for component props, events, slots and exposes.
-   * Since Storybook 8, the official vue plugin "volar" can be used which supports
+   * Since Storybook 8, the official vue plugin "vue-component-meta" (Volar) can be used which supports
    * more complex types, better type docs, support for js(x)/ts(x) components and more.
    *
-   * "volar" will become the new default in the future and "vue-docgen-api" will be removed.
+   * "vue-component-meta" will become the new default in the future and "vue-docgen-api" will be removed.
    * @default "vue-docgen-api"
    */
-  docgen?: 'vue-docgen-api' | 'volar';
+  docgen?: 'vue-docgen-api' | 'vue-component-meta';
 };
 
 type StorybookConfigFramework = {