File size: 1,882 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
import { existsSync, readFileSync } from "node:fs"
import { join } from "node:path"
import { kebabCase } from "scule"
export interface Properties {
type: string
isRequired: boolean
defaultValue?: string | undefined
description?: string | undefined
}
const sortEntries = (props: Record<string, any>): [string, Properties][] => {
return Object.entries(props).sort(([, a], [, b]) => {
if (a.isRequired && !b.isRequired) return -1
if (!a.isRequired && b.isRequired) return 1
if (a.defaultValue && !b.defaultValue) return -1
if (!a.defaultValue && b.defaultValue) return 1
return 0
})
}
function getType(componentName?: string): Record<string, any> {
const path = join(
process.cwd(),
"public",
"r",
"types",
`${componentName}.json`,
)
if (!existsSync(path)) return {}
return JSON.parse(readFileSync(path, "utf-8"))
}
export function getComponentTypes(component: string) {
return getType(kebabCase(component))
}
export function getComponentProps(options: {
component: string
part?: string
omit?: string[]
}) {
const { component, part, omit } = options
const componentTypes = getComponentTypes(component)
const componentType = part ? componentTypes[part] : componentTypes
if (!componentType?.props) return null
return sortEntries(componentType.props).filter(
([name]) => !omit?.includes(name),
)
}
export function propsToMdTable(props: {
component: string
part?: string
omit?: string[]
}) {
const properties = getComponentProps(props)
if (!properties?.length) return null
return `| Prop | Default | Type | Description |
| --- | --- | --- | --- |
${properties
.map(
([name, property]) =>
`| ${name} | ${property.defaultValue} | \`${property.type.replaceAll('"', "'").replaceAll("|", "\\|").replaceAll("\n", "\\n")}\` | ${property.description} |`,
)
.join("\n")}
`
}
|