デバッグ
API Extractor にコントリビューションする場合、最終的にはデバッガで実行する必要があります。 **apps/api-extractor** フォルダで VS Code を開くと、**build-tests** フォルダ内のさまざまなテストプロジェクトで API Extractor を実行するための事前作成されたデバッガ構成を含む launch.json ファイル が含まれています。
たとえば、デバッガで **build-tests/api-extractor-test-01** を分析するには、次の手順を実行します。
プロジェクトがコンパイルされていることを確認してください(API Extractor は .ts ファイルではなく .d.ts ファイルを処理するため)。
$ cd ./build-tests/api-extractor-test-01
$ rushx build(
npm run build
でも機能します)**apps/api-extractor** フォルダで VS Code を開きます。
左側のツールバーで「デバッグ」アイコンをクリックします (Ctrl+Shift+D)。
コンボボックスから
"test-01"
構成を選択します。緑色の「再生」ボタンをクリックします (F5)。
**api-extractor-scenarios** プロジェクトは、多くの異なるエントリポイントを持つため、少し扱いにくいです。各エントリポイントについて、runScenarios.ts ドライバは、**temp/configs** フォルダに完全な **api-extractor.json** スタイルの設定ファイルを作成します。したがって、デバッグする設定ファイルを指定するようにデバッガ構成を手動で編集する必要があります。このセクションは次のようになります。
api-extractor/.vscode/launch.json
. . .
{
"type": "node",
"request": "launch",
"name": "scenario",
"program": "${workspaceFolder}/lib/start.js",
"cwd": "${workspaceFolder}/../../build-tests/api-extractor-scenarios",
"args": [
"--debug",
"run",
"--local",
"--config",
"./temp/configs/api-extractor-typeof.json"
],
"sourceMaps": true
},
. . .
--config
パラメータを "./temp/configs/api-extractor-typeof.json"
から、デバッグするシナリオの特定の設定ファイルに指定するように変更します。
ちなみに、**api-extractor-scenarios** に新しいシナリオを追加する場合は、config/build-config.json に登録することを忘れないでください。