typejuice 是 TypeScript 声明文件的文档生成器，灵感来自 godoc。
TypeScript 声明文件已经成为库中常见的附件，即使是那些用标准 JavaScript 编写的库，也是增强所暴露的API的自动完成行为的一种手段。
文档和这些声明文件之间有很多重叠之处。这个项目试图通过从.d.ts文件中提供类似于 godoc 的注释提取来弥补这一差距，同时也推断出类型和签名，所以你不必在两个不同的地方维护相同的信息。
typejuice 包含两个包：
- typejuice：JavaScript 的 API 库
- vit-plugin-typejuice：它的 Vite 插件
基础使用
import TypeJuice from 'typejuice' const tj = new TypeJuice('./sample.d.ts') console.log(tj.toMarkdown())
Vite 集成
import { dirname } from 'path' import { fileURLToPath } from 'url' import TypeJuice from 'vite-plugin-typejuice' export default { plugins: [ TypeJuice({ // Defaults to process.cwd() typeRoot: resolve(dirname(fileURLToPath(import.meta.url)), 'types'), // Defaults to only 'md' extensions: ['md'], }) ], }
评论