在 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" 配置檔案內容：

```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 編譯器的行為。</output_folder_path></api_report_filename></path_to_alpha_trimmed_file></path_to_beta_trimmed_file></path_to_public_trimmed_file></path_to_entry_point_file>

什麼是 Angular 專案中的 tsconfig.api-extractor.json 檔案

相關文章