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

同样能使配置生效。

相关推荐
gnip5 小时前
企业级配置式表单组件封装
前端·javascript·vue.js
一只叫煤球的猫6 小时前
写代码很6,面试秒变菜鸟?不卖课,面试官视角走心探讨
前端·后端·面试
bobz9656 小时前
tcp/ip 中的多路复用
后端
bobz9657 小时前
tls ingress 简单记录
后端
excel7 小时前
Three.js 材质(Material)详解 —— 区别、原理、场景与示例
前端
掘金安东尼7 小时前
抛弃自定义模态框:原生Dialog的实力
前端·javascript·github
你的人类朋友8 小时前
什么是OpenSSL
后端·安全·程序员
bobz9658 小时前
mcp 直接操作浏览器
后端
前端小张同学10 小时前
服务器部署 gitlab 占用空间太大怎么办,优化思路。
后端
databook11 小时前
Manim实现闪光轨迹特效
后端·python·动效