From e8415decc1fb982e281709305544205d50f32b65 Mon Sep 17 00:00:00 2001 From: Lars Rickert Date: Mon, 8 Apr 2024 19:42:29 +0200 Subject: [PATCH] update docs --- code/frameworks/vue3-vite/src/types.ts | 8 +++----- docs/get-started/vue3-vite.md | 13 ++++--------- 2 files changed, 7 insertions(+), 14 deletions(-) diff --git a/code/frameworks/vue3-vite/src/types.ts b/code/frameworks/vue3-vite/src/types.ts index b90bd9f59a1..ce87a7ffb25 100644 --- a/code/frameworks/vue3-vite/src/types.ts +++ b/code/frameworks/vue3-vite/src/types.ts @@ -26,13 +26,11 @@ export type FrameworkOptions = { | { plugin: 'vue-component-meta'; /** - * Tsconfig filename to use. Should be set if your main `tsconfig.json` only includes references to other tsconfig files - * like `tsconfig.app.json` which `vue-component-meta` does currently not support. + * Tsconfig filename to use. Should be set if your main `tsconfig.json` includes references to other tsconfig files + * like `tsconfig.app.json`. * Otherwise docgen might not be generated correctly (e.g. import aliases are not resolved). * - * Make sure that the specified tsconfig file does not contain `references`. - * - * For further information about `vue-component-meta` limitations, see our [docs](https://storybook.js.org/docs/get-started/vue3-vite#limitations). + * For further information, see our [docs](https://storybook.js.org/docs/get-started/vue3-vite#limitations). * * @default "tsconfig.json" */ diff --git a/docs/get-started/vue3-vite.md b/docs/get-started/vue3-vite.md index 306a4010a16..dd0c9dd7fef 100644 --- a/docs/get-started/vue3-vite.md +++ b/docs/get-started/vue3-vite.md @@ -277,15 +277,8 @@ The definition above will generate the following controls: ### Limitations -`vue-component-meta` does currently not support `tsconfig.json` files that use `references` to other tsconfig files (see [this issue](https://github.com/vuejs/language-tools/issues/3896) for more information). As result, you might face missing component types/descriptions or unresolvable import aliases, for example: - -```ts -// YourComponent.ts -import type { MyProps } from '@/types'; // ❌ Cannot be resolved -import type { MyProps } from '../types'; // ✅ Can be resolved -``` - -So if your project uses a `tsconfig.json` file that only includes references to e.g. `tsconfig.app.json`, `tsconfig.node.json` etc., you should set the following framework option to the tsconfig file used for your main application code: +If your `tsconfig.json` file uses `references` to other config files like `tsconfig.app.json`, `tsconfig.node.json` etc., you should define the tsconfig file used for your main application code via the framework option shown below so `vue-component-meta` can use it properly. +Otherwise, you might face missing component types/descriptions or unresolvable import aliases like `@/some/import`. ```ts // .storybook/main.ts @@ -306,6 +299,8 @@ const config: StorybookConfig = { export default config; ``` +For further information, you can take a look at [this issue](https://github.com/vuejs/language-tools/issues/3896). + ## Troubleshooting ### Storybook doesn't work with my Vue 2 project