什么是 Angular 项目中的 tsconfig.api-extractor.json 文件

简介: 什么是 Angular 项目中的 tsconfig.api-extractor.json 文件

在 Angular 项目中,“tsconfig.api-extractor.json” 是一个用于配置 API Extractor 工具的配置文件。API Extractor 是一个用于生成和管理 TypeScript 库的 API 文档的工具。它能够从 TypeScript 代码中提取公共 API 并生成清晰的文档,以便开发者能够更好地了解库的使用方式、函数、类、接口等。


“tsconfig.api-extractor.json” 文件是用于指导 API Extractor 的工作流程和行为的配置文件。它定义了用于生成 API 文档的源代码位置、输出目录、文件筛选规则、包含和排除的文件列表,以及其他相关的选项。


该配置文件通常位于项目的根目录下,并且以"tsconfig.api-extractor.json"的名称保存。在 Angular 项目中,它通常是与其他 TypeScript 配置文件(例如 “tsconfig.json”)并存的。


下面是一个示例的 “tsconfig.api-extractor.json” 配置文件内容:

{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
  "mainEntryPointFilePath": "<path_to_entry_point_file>",
  "dtsRollup": {
    "enabled": true,
    "publicTrimmedFilePath": "<path_to_public_trimmed_file>",
    "betaTrimmedFilePath": "<path_to_beta_trimmed_file>",
    "alphaTrimmedFilePath": "<path_to_alpha_trimmed_file>"
  },
  "apiReport": {
    "enabled": true,
    "reportFileName": "<api_report_filename>"
  },
  "docModel": {
    "enabled": true
  },
  "docModelJson": {
    "enabled": true,
    "outputFolder": "<output_folder_path>"
  },
  "compiler": {
    "configType": "tsconfig",
    "rootFolder": ".",
    "overrideTsconfig": {
      "extends": "./tsconfig.json",
      "compilerOptions": {
        "outDir": "./dist"
      }
    }
  }
}

在上述配置文件中,可以看到以下重要的配置选项:


“mainEntryPointFilePath”:指定库的入口文件路径,API Extractor 将从该文件开始提取 API。

“dtsRollup”:配置生成的 API 文件的路径和选项。

“apiReport”:配置是否生成 API 报告以及报告文件的名称。

“docModel” 和 “docModelJson”:配置是否启用生成 API 文档模型和相应的输出文件夹路径。

“compiler”:与 TypeScript 编译器相关的配置,指定了编译器选项和路径。

通过配置 “tsconfig.api-extractor.json” 文件,开发者可以根据项目需求自定义 API Extractor 工具的行为,并生成清晰的 API 文档以供开发者使用和参考。


需要注意的是,“tsconfig.api-extractor.json” 是 Angular 项目中特定于 API Extractor 的配置文件,用于生成 API 文档。与此同时,还存在其他 TypeScript 配置文件(例如 “tsconfig.json”)用于控制 TypeScript 编译器的行为。

相关文章
|
2天前
|
Web App开发 前端开发 JavaScript
关于 Angular template 文件在 Chrome 开发者工具调试器里的断点问题
关于 Angular template 文件在 Chrome 开发者工具调试器里的断点问题
23 7
|
2天前
|
JavaScript UED 开发者
什么是 Angular 项目的 code split?
什么是 Angular 项目的 code split?
10 0
|
2天前
|
C++
【angular】启动项目和路由配置
【angular】启动项目和路由配置
22 1
|
2天前
|
JavaScript
解决vue项目build之后部署到服务器访问的时候出现报错:Uncaught SyntaxError: Unexpected token ‘<‘ chunk-vendors:XXXXXX
解决vue项目build之后部署到服务器访问的时候出现报错:Uncaught SyntaxError: Unexpected token ‘<‘ chunk-vendors:XXXXXX
解决vue项目build之后部署到服务器访问的时候出现报错:Uncaught SyntaxError: Unexpected token ‘<‘ chunk-vendors:XXXXXX
|
2天前
设置Open in Terminal快捷键Alt+Shift+Z,方便angular项目的各种命令输入(多任务状态下)
设置Open in Terminal快捷键Alt+Shift+Z,方便angular项目的各种命令输入(多任务状态下)
|
2天前
|
JavaScript 前端开发 开发工具
Angular 项目中一个 index.d.ts 文件的具体例子介绍
Angular 项目中一个 index.d.ts 文件的具体例子介绍
17 0
|
2天前
|
JavaScript 前端开发 开发者
Angular 项目里 tsconfig.schematics.json 文件的作用
Angular 项目里 tsconfig.schematics.json 文件的作用
10 0
|
2天前
|
存储 搜索推荐 API
通过项目中的实际例子,介绍 LocalStorage 在 Angular 开发中的使用场景
通过项目中的实际例子,介绍 LocalStorage 在 Angular 开发中的使用场景
44 0
|
2天前
|
JSON 数据格式
别扯那没用的~全网最简洁方法~让Angular可以直接引入import本地的json文件
别扯那没用的~全网最简洁方法~让Angular可以直接引入import本地的json文件
|
2天前
|
应用服务中间件 nginx
Angular打包构建项目服务器运行runtime.js、polyfills.js、vendor.js报错net::ERR_ABORTED 404 (Not Found),build修改为相对路径./
Angular打包构建项目服务器运行runtime.js、polyfills.js、vendor.js报错net::ERR_ABORTED 404 (Not Found),build修改为相对路径./