typejuiceTypeScript 文檔生成器
typejuice 是 TypeScript 聲明文件的文檔生成器，靈感來自 godoc。
TypeScript 聲明文件已經(jīng)成為庫中常見的附件，即使是那些用標(biāo)準(zhǔn) JavaScript 編寫的庫，也是增強所暴露的API的自動完成行為的一種手段。
文檔和這些聲明文件之間有很多重疊之處。這個項目試圖通過從.d.ts文件中提供類似于 godoc 的注釋提取來彌補這一差距，同時也推斷出類型和簽名，所以你不必在兩個不同的地方維護(hù)相同的信息。
typejuice 包含兩個包：
- typejuice：JavaScript 的 API 庫
- vit-plugin-typejuice：它的 Vite 插件
基礎(chǔ)使用
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'], }) ], }
評論
圖片
表情
<b id="afajh"><abbr id="afajh"></abbr></b>