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」は、API ドキュメントの生成に使用される Angular プロジェクト内の API Extractor 固有の構成ファイルであることに注意してください。同時に、TypeScript コンパイラの動作を制御する他の TypeScript 構成ファイル (「tsconfig.json」など) もあります。

Angular プロジェクトの tsconfig.api-extractor.json ファイルとは何ですか

おすすめ