Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.vitepress/cache
node_modules
.meta
86 changes: 86 additions & 0 deletions .scripts/meta.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
import type { EventMeta, MetaCheckerOptions } from 'vue-component-meta'
import { globSync, writeFileSync, mkdirSync } from 'node:fs'
import { join } from 'node:path'
import { fileURLToPath } from 'node:url'
import { createChecker } from 'vue-component-meta'

interface MetaProp {
name: string,
type: string,
required: boolean,
description: string,
default?: string,
}

interface MetaEvent {
name: string,
type: string,
description: string,
}

function escapeDoubleQuotes(str: string) {
return str.replace(/"/g, "\\'")
}

function main() {
const __dirname = fileURLToPath(new URL('.', import.meta.url))

mkdirSync(join(__dirname, '../.meta'), { recursive: true })

const checkerOptions: MetaCheckerOptions = {
forceUseTs: true,
printer: { newLine: 1 },
}

const tsconfigChecker = createChecker(
join(__dirname, '../node_modules/slidev-addon-inalia/tsconfig.json'),
checkerOptions,
)

const components = globSync(join(__dirname, '../node_modules/slidev-addon-inalia/components/*.vue')) as string[]

components.forEach((componentPath) => {
const meta = tsconfigChecker.getComponentMeta(componentPath)

const props = meta.props
.filter((prop) => !prop.global)
.map((prop) => ({
name: escapeDoubleQuotes(prop.name),
default: prop.default ? escapeDoubleQuotes(prop.default) : undefined,
required: prop.required,
type: escapeDoubleQuotes(prop.type),
description: escapeDoubleQuotes(prop.description),
} satisfies MetaProp))

const filename = componentPath.split('/').pop()!.replace('.vue', '.md')
let content = ''

content += '<PropsTable\n'
content += ' :data="[\n'
props.forEach((prop) => {
content += ` { name: '${prop.name}', type: '${prop.type}', description: '${prop.description}', default: '${prop.default}', required: ${prop.required} },\n`
})
content += ' ]"\n'
content += '/>'

const events = meta.events.map((event) => ({
name: escapeDoubleQuotes(event.name),
type: escapeDoubleQuotes(event.type),
description: escapeDoubleQuotes(event.description),
} satisfies MetaEvent))

content += '\n\n'

content += '<EventsTable\n'
content += ' :data="[\n'
events.forEach((event) => {
content += ` { name: '${event.name}', type: '${event.type}', description: '${event.description}' },\n`
})
content += ' ]"\n'
content += '/>'

writeFileSync(join(__dirname, '../.meta', filename), content)
})
}

main()
9 changes: 9 additions & 0 deletions .vitepress/theme/components/EventsTable.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script lang="ts" setup>

</script>

<template>
<div>
events table
</div>
</template>
9 changes: 9 additions & 0 deletions .vitepress/theme/components/PropsTable.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script lang="ts" setup>

</script>

<template>
<div>
props table
</div>
</template>
12 changes: 12 additions & 0 deletions .vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import PropsTable from './components/PropsTable.vue'
import EventsTable from './components/EventsTable.vue'

export default {
extends: DefaultTheme,
enhanceApp({ app }) {
app.component('PropsTable', PropsTable)
app.component('EventsTable', EventsTable)
}
} satisfies Theme
7 changes: 6 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
{
"type": "module",
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build",
"preview": "vitepress preview"
},
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748",
"devDependencies": {
"@types/node": "^24.3.0",
"slidev-addon-inalia": "^0.2.4",
"typescript": "^5.9.2",
"vitepress": "^1.6.4"
"vitepress": "^1.6.4",
"vue": "^3.5.19",
"vue-component-meta": "^3.0.6"
}
}
Loading