随着前端开发的不断发展和进步，我们的项目规模也越来越大，各种工具和框架层出不穷。在开发过程中，我们常常需要编写文档来方便团队协作和项目维护。
而 Typedoc 是一款用于生成 TypeScript 项目文档的工具，它可以帮助我们自动生成 API 文档和类型定义等信息。但是，在实际开发中，可能会存在一些问题，比如生成的文档过于冗长、文档中引用的模块过多等。
为了解决这些问题，@jonrimmer/typedoc-plugin-internal-external 这个 npm 包应运而生。它可以帮助我们在生成文档时，只引用项目内部的模块，同时删除外部模块的引用。接下来，我们将介绍该插件的使用方法。
安装
要使用 @jonrimmer/typedoc-plugin-internal-external 插件，我们首先需要在项目中安装该包。可以通过以下命令进行安装：
npm install --save-dev @jonrimmer/typedoc-plugin-internal-external
配置
安装完成后，我们需要在 Typedoc 配置文件中引入该插件。在项目根目录下新建一个 typedoc.json 或者 typedoc.js 配置文件，添加以下内容：
{
"plugins": [
"@jonrimmer/typedoc-plugin-internal-external"
]
}代码中的 @jonrimmer/typedoc-plugin-internal-external 就是我们刚刚安装的 npm 包。
使用
完成以上配置后，我们就可以使用该插件生成我们所需的文档。在命令行中执行以下命令：
typedoc --out <outDir> <srcDir>
其中，<outDir> 表示生成文档的输出目录，<srcDir> 表示存放项目源代码的目录。例如：
typedoc --out ./docs ./src
如此一来，运行命令后，插件就会自动去除外部模块的引用，只保留与项目相关的模块信息，最终生成的文档将更加精简、易读。
示例代码
为了更好地理解上述配置及使用方法，我们提供以下示例代码，帮助大家更加深入地了解 @jonrimmer/typedoc-plugin-internal-external 的使用方法：
安装
在项目根目录下，通过以下命令安装 @jonrimmer/typedoc-plugin-internal-external：
npm install --save-dev @jonrimmer/typedoc-plugin-internal-external
配置
在根目录下新建 typedoc.json 文件，添加以下内容：
{
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "**/*-internal.ts"],
"excludeExternals": true,
"excludePrivate": true,
"out": "docs",
"plugins": ["@jonrimmer/typedoc-plugin-internal-external"]
}使用
运行以下命令：
typedoc --config typedoc.json
总结
通过 @jonrimmer/typedoc-plugin-internal-external 这个 npm 包，我们可以轻松地为 TypeScript 项目生成精简且易读的 API 文档和类型定义等信息，方便团队协作和项目维护。希望本文对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005601681e8991b448de30c