From bb640bf918cd05c81efbd76be1f59ea566926be0 Mon Sep 17 00:00:00 2001 From: Maksim Nedoshev Date: Wed, 19 Apr 2023 17:05:18 +0300 Subject: [PATCH 1/5] docs: move api table out from runtime. Use vue-component-meta --- .../blocks/api/component-parser/meta.ts | 16 +++ .../modules/page-config/blocks/api/index.ts | 3 + .../modules/page-config/blocks/api/index.vue | 35 +++-- .../page-config/blocks/api/transform.ts | 40 +++++- .../modules/page-config/blocks/api/types.ts | 1 + packages/docs/package.json | 1 + yarn.lock | 126 +++++++++++++++++- 7 files changed, 202 insertions(+), 20 deletions(-) create mode 100644 packages/docs/modules/page-config/blocks/api/component-parser/meta.ts diff --git a/packages/docs/modules/page-config/blocks/api/component-parser/meta.ts b/packages/docs/modules/page-config/blocks/api/component-parser/meta.ts new file mode 100644 index 0000000000..dfb62cffc9 --- /dev/null +++ b/packages/docs/modules/page-config/blocks/api/component-parser/meta.ts @@ -0,0 +1,16 @@ +import { resolveAlias } from '@nuxt/kit' + +import path from 'path' + +import type { MetaCheckerOptions } from 'vue-component-meta' +import { createComponentMetaChecker } from 'vue-component-meta' + +const checkerOptions: MetaCheckerOptions = { + forceUseTs: true, + printer: { newLine: 1 }, +} + +export const checker = createComponentMetaChecker( + path.join(resolveAlias('@'), '..', './ui', 'tsconfig.json'), + checkerOptions, +) diff --git a/packages/docs/modules/page-config/blocks/api/index.ts b/packages/docs/modules/page-config/blocks/api/index.ts index 136c6d9265..d53091f119 100644 --- a/packages/docs/modules/page-config/blocks/api/index.ts +++ b/packages/docs/modules/page-config/blocks/api/index.ts @@ -2,11 +2,13 @@ import { DefineComponent } from 'vue'; import { definePageConfigBlock } from '../../types' import Component from './index.vue' import { VisualOptions, type ManualApiOptions } from './types'; +import type { ComponentMeta } from 'vue-component-meta' const setup = ( componentName: string, component: DefineComponent, cssVariables: string, + meta: ComponentMeta, manual?: ManualApiOptions, visualOptions?: VisualOptions, ) => { @@ -15,6 +17,7 @@ const setup = ( componentName, component, cssVariables, + meta, manual, visualOptions, } diff --git a/packages/docs/modules/page-config/blocks/api/index.vue b/packages/docs/modules/page-config/blocks/api/index.vue index 249bdc8d4c..f5b92f5611 100644 --- a/packages/docs/modules/page-config/blocks/api/index.vue +++ b/packages/docs/modules/page-config/blocks/api/index.vue @@ -1,6 +1,5 @@