Nest 使用 compodoc 生成文档

启动 compodoc 文档

compodoc 是一个为 TypeScript 项目生成文档的工具,它支持 Angular、Nest。

compodoc 会分析你的代码,并生成一个包含所有类、接口、服务、控制器和模块以及它们依赖关系的文档。

创建 nest 项目:

bash 复制代码
nest new compodoc-test -p npm

安装 compodoc:

bash 复制代码
npm install @compodoc/compodoc -D

package.json 文件的 scripts 部分添加一个新的脚本来运行 compodoc:

json 复制代码
"scripts": {
  "compodoc": "compodoc -p tsconfig.json -s -o",
}
  • -p 是指定 tsconfig 文件
  • -s 是启动静态服务器
  • -o 是打开浏览器

更多选项在 compodoc 文档里可以看到:

生成预览文档:

bash 复制代码
npm run compodoc

自动打开浏览器,并定位到了 README 菜单:

这个 README 菜单其实对应了项目里面的 README:

改一下 READMD.md,然后重新执行命令生成:

overview

文档的 overview 部分分贝是依赖图,和项目有几个模块、controller,可注入的 provider

我们在项目下添加几个模块:

typescript 复制代码
nest g resource test1

nest g resource test2

在 Test1Module 导出 Test1Service:

然后 BbbModule 引入 AaaModule:

在 BbbService 里注入 AaaService:

运行项目:

typescript 复制代码
npm run start:dev

这种依赖关系,compodoc 可视化之后是什么样的呢?

重新跑一下 compodoc:

typescript 复制代码
npm run compodoc

点击左侧的 Modules,可以看到每个模块的可视化分析:

还可以定位到具体代码的实现:

当新人接手这个项目的时候,可以通过这份文档快速了解项目的结构。

compodoc 配置文件

命令行选项也挺多的,我们可以写在 compodoc 配置文件中。

项目下添加一个 .compodoc.json 的文件:

json 复制代码
{
    "port": 8888,
    "theme": "postmark"
}

改下 scripts 里 compodoc 命令:

json 复制代码
"scripts": {
   "compodoc": "compodoc -s -o -c .compodoc.json",
 }

-c 参数告诉 compodoc 使用指定的配置文件。

运行:

bash 复制代码
npm run compodoc

同样能使配置生效。

相关推荐
Estar.Lee3 小时前
查手机号归属地免费API接口教程
android·网络·后端·网络协议·tcp/ip·oneapi
y先森3 小时前
CSS3中的伸缩盒模型(弹性盒子、弹性布局)之伸缩容器、伸缩项目、主轴方向、主轴换行方式、复合属性flex-flow
前端·css·css3
前端Hardy3 小时前
纯HTML&CSS实现3D旋转地球
前端·javascript·css·3d·html
susu10830189113 小时前
vue3中父div设置display flex,2个子div重叠
前端·javascript·vue.js
IT女孩儿4 小时前
CSS查缺补漏(补充上一条)
前端·css
2401_857610034 小时前
SpringBoot社团管理:安全与维护
spring boot·后端·安全
凌冰_5 小时前
IDEA2023 SpringBoot整合MyBatis(三)
spring boot·后端·mybatis
码农飞飞5 小时前
深入理解Rust的模式匹配
开发语言·后端·rust·模式匹配·解构·结构体和枚举
一个小坑货5 小时前
Rust 的简介
开发语言·后端·rust
吃杠碰小鸡5 小时前
commitlint校验git提交信息
前端