VS Code API

認証プロバイダーの認証セッションが追加、削除、または変更されたときに発生するイベント。

指定されたプロバイダーでユーザーがログインしているすべてのアカウントを取得します。特定のアカウントの認証セッションを取得するには、これをgetSessionと組み合わせて使用​​します。

現在、GitHub と Microsoft の認証を実装するために、組み込み拡張機能からエディターに提供される認証プロバイダーは 2 つだけです。それらのプロバイダー ID は「github」と「microsoft」です。

注: アカウントの取得は、拡張機能がそのアカウントまたはその認証セッションにアクセスできることを意味しません。getSession を呼び出すことで、アカウントへのアクセスを確認できます。

目的のスコープに一致するか、WWW-Authenticate 要求を満たす認証セッションを取得します。providerId を持つプロバイダーが登録されていない場合、またはユーザーが認証情報の拡張機能への共有に同意しない場合は拒否されます。同じスコープを持つ複数のセッションがある場合、ユーザーは使用したいアカウントを選択するためのクイックピックを表示されます。

組み込みの認証プロバイダーには以下が含まれます

• 'github' - GitHub.com 用
• 'microsoft' - 個人用および組織用の Microsoft アカウントの両方
• (あまり一般的ではない) 'github-enterprise' - 代替の GitHub ホスティング、GHE.com、GitHub Enterprise Server 用
• (あまり一般的ではない) 'microsoft-sovereign-cloud' - 代替の Microsoft クラウド用

目的のスコープまたは要求に一致する認証セッションを取得します。providerId を持つプロバイダーが登録されていない場合、またはユーザーが認証情報の拡張機能への共有に同意しない場合は拒否されます。同じスコープを持つ複数のセッションがある場合、ユーザーは使用したいアカウントを選択するためのクイックピックを表示されます。

組み込みの認証プロバイダーには以下が含まれます

• 'github' - GitHub.com 用
• 'microsoft' - 個人用および組織用の Microsoft アカウントの両方
• (あまり一般的ではない) 'github-enterprise' - 代替の GitHub ホスティング、GHE.com、GitHub Enterprise Server 用
• (あまり一般的ではない) 'microsoft-sovereign-cloud' - 代替の Microsoft クラウド用

目的のスコープまたは要求に一致する認証セッションを取得します。providerId を持つプロバイダーが登録されていない場合、またはユーザーが認証情報の拡張機能への共有に同意しない場合は拒否されます。同じスコープを持つ複数のセッションがある場合、ユーザーは使用したいアカウントを選択するためのクイックピックを表示されます。

組み込みの認証プロバイダーには以下が含まれます

• 'github' - GitHub.com 用
• 'microsoft' - 個人用および組織用の Microsoft アカウントの両方
• (あまり一般的ではない) 'github-enterprise' - 代替の GitHub ホスティング、GHE.com、GitHub Enterprise Server 用
• (あまり一般的ではない) 'microsoft-sovereign-cloud' - 代替の Microsoft クラウド用

認証プロバイダーを登録します。

ID ごとにプロバイダーは 1 つしか登録できません。ID がすでに別のプロバイダーで使用されている場合、エラーがスローされます。ID は大文字と小文字を区別します。

新しい チャット参加者 インスタンスを作成します。

指定されたコマンド識別子で示されるコマンドを実行します。

• 注1: エディタコマンドを実行する場合、すべての型が引数として渡せるわけではありません。許容されるのは、プリミティブ型 `string`、`boolean`、`number`、`undefined`、`null`、および Position、Range、Uri、Location です。
• 注2: 拡張機能によって提供されたコマンドを実行する場合、制限はありません。

利用可能なすべてのコマンドのリストを取得します。アンダースコアで始まるコマンドは内部コマンドとして扱われます。

キーボードショートカット、メニュー項目、アクション、または直接呼び出すことができるコマンドを登録します。

既存のコマンド識別子を持つコマンドを2回登録するとエラーが発生します。

キーボードショートカット、メニュー項目、アクション、または直接呼び出すことができるテキストエディターコマンドを登録します。

テキストエディターコマンドは、コマンドが呼び出されたときにアクティブなエディターがある場合にのみ実行されるため、通常の コマンド とは異なります。また、エディターコマンドのコマンドハンドラーは、アクティブなエディターと edit ビルダーにアクセスできます。エディタービルダーは、コールバックが実行されている間のみ有効であることに注意してください。

新しい コメントコントローラー インスタンスを作成します。

現在アクティブな デバッグコンソール。デバッグセッションがアクティブでない場合、デバッグコンソールに送信された出力は表示されません。

現在アクティブな デバッグセッション、または `undefined`。アクティブなデバッグセッションは、デバッグアクションフローティングウィンドウで表されるもの、またはデバッグアクションフローティングウィンドウのドロップダウンメニューに現在表示されているものです。デバッグセッションがアクティブでない場合、値は `undefined` です。

現在フォーカスされているスレッドまたはスタックフレーム、またはスレッドまたはスタックフレームにフォーカスがない場合は `undefined`。スレッドはアクティブなデバッグセッションがある場合にいつでもフォーカスできますが、スタックフレームはセッションが一時停止され、コールスタックが取得されている場合にのみフォーカスできます。

ブレークポイントのリスト。

アクティブなデバッグセッションが変更されたときに発生するイベント。注: アクティブなデバッグセッションが `undefined` に変更された場合もイベントが発生します。

debug.activeStackItem が変更されたときに発生するイベント。

ブレークポイントのセットが追加、削除、または変更されたときに発行される イベント。

デバッグセッションからカスタムDAPイベントを受信したときに発生するイベント。

新しい デバッグセッション が開始されたときに発生する イベント。

デバッグセッションが終了したときに発生するイベント。

ブレークポイントを追加します。

デバッグアダプタープロトコルを介して受信した「Source」記述子オブジェクトを、そのコンテンツをロードするために使用できる Uri に変換します。ソース記述子がパスに基づいている場合、ファイル Uri が返されます。ソース記述子が参照番号を使用する場合、対応する ContentProvider と実行中のデバッグセッションを必要とする特定のデバッグ Uri (スキーム「debug」) が構築されます。

Uri を作成するための「Source」記述子に十分な情報がない場合、エラーがスローされます。

特定のデバッグタイプに対して デバッグアダプター記述子ファクトリ を登録します。拡張機能は、拡張機能によって定義されたデバッグタイプにのみ DebugAdapterDescriptorFactory を登録できます。それ以外の場合はエラーがスローされます。デバッグタイプに複数の DebugAdapterDescriptorFactory を登録するとエラーになります。

指定されたデバッグタイプにデバッグアダプタートラッカーファクトリを登録します。

特定のデバッグタイプに対して デバッグ構成プロバイダー を登録します。オプションの triggerKind を使用して、プロバイダーの `provideDebugConfigurations` メソッドがトリガーされるタイミングを指定できます。現在、2 つのトリガーの種類が可能です。`Initial` の値 (またはトリガーの種類引数が指定されていない場合) の場合、`provideDebugConfigurations` メソッドは、新しく作成された launch.json にコピーされる初期デバッグ構成を提供するために使用されます。`Dynamic` のトリガーの種類の場合、`provideDebugConfigurations` メソッドは、ユーザーに提示されるデバッグ構成を動的に決定するために使用されます (launch.json の静的構成に加えて)。`triggerKind` 引数は `provideDebugConfigurations` メソッドにのみ適用されることに注意してください。したがって、`resolveDebugConfiguration` メソッドはまったく影響を受けません。異なるトリガーの種類に対して解決メソッドを持つ単一のプロバイダーを登録すると、同じ解決メソッドが複数回呼び出されます。同じタイプに対して複数のプロバイダーを登録できます。

ブレークポイントを削除します。

名前付き起動または名前付き複合構成を使用するか、DebugConfiguration を直接渡すことによってデバッグを開始します。名前付き構成は、指定されたフォルダーにある '.vscode/launch.json' で検索されます。デバッグが開始される前に、すべての未保存ファイルが保存され、起動構成が最新の状態に更新されます。構成で使用されるフォルダー固有の変数 (例: '${workspaceFolder}') は、指定されたフォルダーに対して解決されます。

指定されたデバッグセッションを停止するか、セッションが省略されている場合はすべてのデバッグセッションを停止します。

アプリケーションのホストされた場所。デスクトップでは「desktop」。ウェブでは、指定された埋め込み先、つまり「github.dev」、「codespaces」、または埋め込み先がその情報を提供しない場合は「web」。

'VS Code'のようなエディターのアプリケーション名。

エディターが実行されているアプリケーションのルートフォルダー。

注: アプリケーションのルートフォルダーの表現がない環境で実行している場合、値は空文字列になります。

システムクリップボード。

これがアプリケーションの新規インストールであることを示します。インストール後1日以内であれば`true`、それ以外の場合は`false`。

ユーザーがテレメトリーを有効にしているかどうかを示します。拡張機能がテレメトリーを送信すべきかどうかを判断するために監視できます。

`de-CH`、`fr`、`en-US`のような、優先されるユーザー言語を表します。

エディターの現在のログレベル。

コンピューターの一意識別子。

リモートの名前。拡張機能によって定義され、一般的な例としては、Windows Subsystem for Linux の `wsl` や、セキュアシェルを使用するリモートの `ssh-remote` があります。

注: リモート拡張機能ホストがない場合は値が `undefined` になりますが、リモート拡張機能ホストが存在する場合はすべての拡張機能ホスト (ローカルとリモート) で値が定義されます。特定の拡張機能がリモートで実行されているかどうかを知るには Extension.extensionKind を使用します。

現在のセッションの一意識別子。エディターが起動するたびに変更されます。

拡張機能ホストに検出されたデフォルトのシェル。これは、拡張機能ホストのプラットフォームの `terminal.integrated.defaultProfile` 設定によって上書きされます。シェルをサポートしない環境では値が空文字列になることに注意してください。

UIの種類プロパティは、拡張機能がどのUIからアクセスされるかを示します。例えば、拡張機能はデスクトップアプリケーションまたはウェブブラウザからアクセスできます。

エディターがオペレーティングシステムに登録するカスタム URI スキーム。

エディターのログレベルが変更されたときに発生する イベント。

デフォルトのシェルが変更されたときに発生する イベント。これは新しいシェルパスとともに発生します。

ユーザーがテレメトリーを有効または無効にしたときに発生するイベント。ユーザーがテレメトリーを有効にした場合は`true`、ユーザーがテレメトリーを無効にした場合は`false`。

uri を外部からアクセス可能な形式に解決します。

http: または https: スキーム

拡張機能が実行されている場所から、クライアントマシン上の同じリソースへの uri に、`http:` や `https:` リンクなどの外部 uri を解決します。

拡張機能がクライアントマシンで実行されている場合、これは何もしません。

拡張機能がリモートで実行されている場合、この関数はローカルマシンからリモートの `target` へのポートフォワーディングトンネルを自動的に確立し、トンネルへのローカル uri を返します。ポートフォワーディングトンネルのライフタイムはエディターによって管理され、トンネルはユーザーによって閉じることができます。

注: `openExternal` を介して渡される uri は自動的に解決されるため、それらに対して `asExternalUri` を呼び出すべきではありません。

vscode.env.uriScheme

ブラウザで開いた場合（例えば`openExternal`経由）、登録済みのUriHandlerがトリガーされるURIを作成します。

拡張機能は、結果のURIについていかなる仮定もすべきではなく、いかなる方法でも変更すべきではありません。むしろ、拡張機能は、例えば、認証フローでこのURIを使用し、認証するサーバーにコールバッククエリ引数としてURIを追加することができます。

注: サーバーが URI に追加のクエリパラメータ (例: トークンやシークレット) を追加することを決定した場合、それらは UriHandler に渡される URI に表示されます。

認証フローの例

vscode.window.registerUriHandler({
  handleUri(uri: vscode.Uri): vscode.ProviderResult<void> {
    if (uri.path === '/did-authenticate') {
      console.log(uri.toString());
    }
  }
});

const callableUri = await vscode.env.asExternalUri(
  vscode.Uri.parse(vscode.env.uriScheme + '://my.extension/did-authenticate')
);
await vscode.env.openExternal(callableUri);

注: 拡張機能は `asExternalUri` の結果をキャッシュすべきではありません。なぜなら、解決された uri はシステムまたはユーザーのアクション (例えば、リモートの場合、ユーザーが `asExternalUri` によって開かれたポート転送トンネルを閉じることなど) によって無効になる可能性があるからです。

その他のスキーマ

その他のスキームは、提供された URI がワークスペース URI であるかのように処理されます。その場合、このメソッドは、処理されるとエディターがワークスペースを開く URI を返します。

新しい テレメトリーロガー を作成します。

デフォルトのアプリケーションを使用して、リンクを外部で開きます。使用されるスキームに応じて、これは次のようになります。

• ブラウザ (`http:`、`https:`)。
• メールクライアント (`mailto:`)。
• VSCode自体 ( `vscode.env.uriScheme` からの `vscode:` )。

注: エディター内でテキストドキュメントを開くには、この関数ではなく showTextDocument が正しい方法です。

システムに現在認識されているすべての拡張機能。

`extensions.all` が変更されたときに発生する イベント。これは、拡張機能がインストール、アンインストール、有効化、または無効化されたときに発生する可能性があります。

`publisher.name` の形式で、その完全な識別子によって拡張機能を取得します。

拡張機能用に読み込まれたローカライズされた文字列のバンドル。バンドルが読み込まれていない場合は undefined です。バンドルが見つからない場合や、デフォルトの言語で実行されている場合は、通常、バンドルは読み込まれません。

拡張機能用に読み込まれたローカライズバンドルの URI。バンドルが読み込まれていない場合は undefined です。バンドルが見つからない場合や、デフォルトの言語で実行されている場合は、通常、バンドルは読み込まれません。

文字列をローカライズ対象としてマークします。env.language で指定された言語のローカライズバンドルが利用可能であり、そのバンドルにこのメッセージのローカライズ値がある場合、そのローカライズ値が返されます (テンプレート化された値については、args の値が挿入されます)。

例

l10n.t('Hello {0}!', 'World');

文字列をローカライズ対象としてマークします。env.language で指定された言語のローカライズバンドルが利用可能であり、そのバンドルにこのメッセージのローカライズ値がある場合、そのローカライズ値が返されます (テンプレート化された値については、args の値が挿入されます)。

例

l10n.t('Hello {name}', { name: 'Erich' });

文字列をローカライズ対象としてマークします。env.language で指定された言語のローカライズバンドルが利用可能であり、そのバンドルにこのメッセージのローカライズ値がある場合、そのローカライズ値が返されます (テンプレート化された値については、args の値が挿入されます)。

診断のグローバルセットが変更されたときに発生する イベント。これは新しく追加および削除された診断です。

診断コレクションを作成します。

新しい 言語ステータスアイテム を作成します。

指定されたリソースのすべての診断を取得します。

すべての診断を取得します。

既知のすべての言語の識別子を返します。

ドキュメント セレクター とドキュメント間のマッチを計算します。0 より大きい値は、セレクターがドキュメントにマッチすることを意味します。

マッチは以下のルールに従って計算されます。

1. DocumentSelector が配列の場合、含まれる各 `DocumentFilter` または言語識別子に対してマッチを計算し、最大値を取得します。
2. 文字列は非糖衣構文化されて DocumentFilter の `language` 部分になるため、`"fooLang"` は `{ language: "fooLang" }` のようになります。
3. DocumentFilter は、その部分とドキュメントを比較することによってドキュメントと照合されます。以下のルールが適用されます。
   1. `DocumentFilter` が空 (`{}`) の場合、結果は `0` です。
   2. `scheme`、`language`、`pattern`、または`notebook`が定義されているが、いずれか1つが一致しない場合、結果は`0`。
   3. `*` と一致するとスコアは `5`、等式またはグロブパターンと一致するとスコアは `10`。
   4. 結果は、各マッチの最大値です。

サンプル

// default document from disk (file-scheme)
doc.uri; //'file:///my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript' }, doc); // 10;
match({ language: 'javascript', scheme: 'file' }, doc); // 10;
match('*', doc); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5

// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript', scheme: 'git' }, doc); // 10;
match('*', doc); // 5

// notebook cell document
doc.uri; // `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;
doc.languageId; // 'python'
match({ notebookType: 'jupyter-notebook' }, doc); // 10
match({ notebookType: 'fooNotebook', language: 'python' }, doc); // 0
match({ language: 'python' }, doc); // 10
match({ notebookType: '*' }, doc); // 5

コール階層プロバイダーを登録します。

コードアクションプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

コードレンズプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

カラープロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

補完プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア によってソートされ、同じスコアのグループは順番に補完項目を要求されます。プロセスは、グループの1つ以上のプロバイダーが結果を返すと停止します。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

補完項目プロバイダーは、`triggerCharacters` のセットと関連付けられます。トリガー文字が入力されると、補完が要求されますが、入力された文字を登録したプロバイダーからのみ要求されます。そのため、トリガー文字は 単語文字 とは異なるべきであり、一般的なトリガー文字はメンバー補完をトリガーするための `.` です。

宣言プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

定義プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

新しい DocumentDropEditProvider を登録します。

複数のドロッププロバイダーを言語に登録できます。エディターにコンテンツをドロップすると、エディターの言語に登録されているすべてのプロバイダーが、DocumentDropEditProviderMetadata で指定された処理する MIME タイプに基づいて呼び出されます。

各プロバイダーは1つ以上のDocumentDropEditsを返すことができます。編集はDocumentDropEdit.yieldToプロパティを使用してソートされます。デフォルトでは最初の編集が適用されます。追加の編集がある場合、それらはドロップウィジェットで選択可能なドロップオプションとしてユーザーに表示されます。

ドキュメントの書式設定プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア によってソートされ、最適なマッチングプロバイダーが使用されます。選択されたプロバイダーの失敗は、操作全体の失敗の原因になります。

ドキュメントハイライトプロバイダーを登録します。

1つの言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーはスコアでソートされ、グループごとに順次ドキュメントハイライトを要求されます。プロセスは、プロバイダーがnon-falsyまたはnon-failureの結果を返すときに停止します。

ドキュメントリンクプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

新しいDocumentPasteEditProviderを登録します。

言語ごとに複数のプロバイダーを登録できます。言語に登録されているすべてのプロバイダーは、DocumentPasteProviderMetadataで指定された処理対象のMIMEタイプに基づいて、コピー&ペースト操作のために呼び出されます。

コピー操作の場合、各プロバイダーによって行われたDataTransferへの変更は、クリップボードにデータを投入するために使用される単一のDataTransferにマージされます。

[DocumentPasteEditProvider.providerDocumentPasteEdits ペースト操作](#DocumentPasteEditProvider.providerDocumentPasteEdits ペースト操作)の場合、各プロバイダーが呼び出され、1つ以上のDocumentPasteEditを返すことができます。編集はDocumentPasteEdit.yieldToプロパティを使用してソートされます。デフォルトでは、最初の編集が適用され、残りの編集はペーストウィジェットで選択可能なペーストオプションとしてユーザーに表示されます。

ドキュメント範囲の書式設定プロバイダーを登録します。

注: ドキュメント範囲プロバイダーはドキュメントフォーマッターでもあります。つまり、範囲プロバイダーも登録する場合は、ドキュメントフォーマッターを登録する必要はありません。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア によってソートされ、最適なマッチングプロバイダーが使用されます。選択されたプロバイダーの失敗は、操作全体の失敗の原因になります。

ドキュメント範囲のセマンティックトークンプロバイダーを登録します。

注: ドキュメントにDocumentSemanticTokensProviderとDocumentRangeSemanticTokensProviderの両方がある場合、範囲プロバイダーは、フルドキュメントプロバイダーが最初の要求を解決するのにかかる時間の間、最初にのみ呼び出されます。フルドキュメントプロバイダーが最初の要求を解決すると、範囲プロバイダーを介して提供されたセマンティックトークンは破棄され、それ以降はドキュメントプロバイダーのみが使用されます。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア によってソートされ、最適なマッチングプロバイダーが使用されます。選択されたプロバイダーの失敗は、操作全体の失敗の原因になります。

ドキュメント全体のセマンティックトークンプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア によってソートされ、最適なマッチングプロバイダーが使用されます。選択されたプロバイダーの失敗は、操作全体の失敗の原因になります。

ドキュメントシンボルプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

テキストドキュメント内で評価可能な式を検索するプロバイダーを登録します。エディターはアクティブなデバッグセッションで式を評価し、デバッグホバーに結果を表示します。

1つの言語に対して複数のプロバイダーが登録されている場合、任意のプロバイダーが使用されます。

折りたたみ範囲プロバイダーを登録します。

1つの言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。同じ位置で複数の折りたたみ範囲が開始する場合、最初に登録されたプロバイダーの範囲のみが使用されます。折りたたみ範囲がより小さい位置を持つ別の範囲と重なる場合、それも無視されます。

失敗したプロバイダー (拒否されたプロミスまたは例外) は、操作全体の失敗を引き起こしません。

ホバープロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

実装プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

インレイヒントプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

インライン補完プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

デバッガーの「インライン値」機能のデータを返すプロバイダーを登録します。汎用デバッガーがソースファイルで停止するたびに、そのファイルの言語に登録されたプロバイダーが呼び出され、行の終わりにエディターに表示されるテキストデータが返されます。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

リンクされた編集範囲プロバイダーを登録します。

1つの言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーはスコアでソートされ、結果を持つ最も一致するプロバイダーが使用されます。選択されたプロバイダーの失敗は、操作全体の失敗を引き起こします。

入力時に機能する書式設定プロバイダーを登録します。プロバイダーは、ユーザーが設定editor.formatOnTypeを有効にするとアクティブになります。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア によってソートされ、最適なマッチングプロバイダーが使用されます。選択されたプロバイダーの失敗は、操作全体の失敗の原因になります。

参照プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

名前変更プロバイダーを登録します。

1つの言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーはスコアでソートされ、順次呼び出されます。結果を生成した最初のプロバイダーが、操作全体の結果を定義します。

選択範囲プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

シグネチャヘルププロバイダーを登録します。

1つの言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーはスコアでソートされ、プロバイダーが有効な結果を返すまで順次呼び出されます。

参照: languages.registerSignatureHelpProvider

型定義プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否された Promise または例外) は、操作全体が失敗する原因にはなりません。

型階層プロバイダーを登録します。

ワークスペースシンボルプロバイダーを登録します。

複数のプロバイダーを登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー (拒否されたプロミスまたは例外) は、操作全体の失敗を引き起こしません。

言語の言語設定を設定します。

指定されたドキュメントに関連付けられている言語を設定 (および変更) します。

注: この関数を呼び出すと、onDidCloseTextDocumentイベントがトリガーされ、その後にonDidOpenTextDocumentイベントがトリガーされます。

すべての拡張機能がlm.registerToolを使用して登録した利用可能なすべてのツールのリスト。これらは、宣言されたinputSchemaに一致する入力でlm.invokeToolを使用して呼び出すことができます。

利用可能なチャットモデルのセットが変更されたときに発生するイベント。

lm.toolsに名前でリストされているツールを、指定された入力で呼び出します。入力はツールによって宣言されたスキーマに対して検証されます。

ツールは、チャット参加者によって、チャットリクエストの処理のコンテキストで、または任意のカスタムフローで任意の拡張機能によってグローバルに呼び出すことができます。

前者では、呼び出し元はチャットリクエストから取得したtoolInvocationTokenを渡す必要があります。これにより、チャットUIが正しい会話のツール呼び出しを表示することが保証されます。

ツールの結果は、テキストおよびprompt-tsxパーツの配列です。ツール呼び出し元がvscode/prompt-tsxを使用している場合、ToolResultを使用して応答パーツをプロンプトに組み込むことができます。そうでない場合、パーツはLanguageModelToolResultPartを含むユーザーメッセージを介してLanguageModelChatに渡すことができます。

チャット参加者が複数のターンにわたるリクエストのツール結果を保持したい場合、ハンドラーから返されたChatResult.metadataにツール結果を保存し、次のターンでChatResponseTurn.resultから取得できます。

LanguageModelChatProviderを登録します。注: package.jsonのlanguageModelChatProviders貢献点を通じて言語モデルチャットプロバイダーを定義する必要もあります。

エディターが消費するモデルコンテキストプロトコルサーバーを公開するプロバイダーを登録します。これにより、ユーザーが設定ファイルで作成するサーバーに加えて、MCPサーバーをエディターに動的に提供できます。

このメソッドを呼び出す前に、拡張機能は対応するidでcontributes.mcpServerDefinitionProviders拡張ポイントを登録する必要があります。例えば、

    "contributes": {
        "mcpServerDefinitionProviders": [
            {
                "id": "cool-cloud-registry.mcp-servers",
                "label": "Cool Cloud Registry",
            }
        ]
    }

新しいMcpServerDefinitionProviderが利用可能になると、エディターは新しいサーバーを発見するための「更新」アクションをユーザーに提示します。このフローを有効にするには、拡張機能はアクティベーション中にregisterMcpServerDefinitionProviderを呼び出す必要があります。

LanguageModelToolを登録します。ツールはpackage.jsonのlanguageModelTools貢献点にも登録されている必要があります。登録されたツールは、すべての拡張機能がlm.toolsリストで利用できます。しかし、言語モデルから認識されるためには、LanguageModelChatRequestOptions.toolsの利用可能なツールのリストに渡す必要があります。

セレクターによってチャットモデルを選択します。これにより、複数のチャットモデルまたはチャットモデルなしが生成される可能性があり、拡張機能はこれらのケース、特にチャットモデルが存在しない場合に適切に処理する必要があります。

const models = await vscode.lm.selectChatModels({ family: 'gpt-3.5-turbo' });
if (models.length > 0) {
    const [first] = models;
    const response = await first.sendRequest(...)
    // ...
} else {
    // NO chat models available
}

セレクターは、特定のベンダーまたはファミリーのすべてのモデルを広く照合するように記述することも、IDによって1つのモデルを狭く選択することもできます。利用可能なモデルのセットは時間とともに変化すること、またプロンプトは異なるモデルで異なるパフォーマンスを示す可能性があることに留意してください。

注: 拡張機能はこの関数によって返された結果を保持し、後で使用できます。ただし、onDidChangeChatModelsイベントが発火した場合、チャットモデルのリストが変更されている可能性があり、拡張機能は再クエリする必要があります。

新しいノートブックコントローラーを作成します。

特定のレンダラーとの通信に使用される新しいメッセージングインスタンスを作成します。

• 注1: 拡張機能は、package.jsonファイルで定義したレンダラーのみを作成できます。
• 注2: レンダーラーは、そのnotebookRenderer貢献でrequiresMessagingがalwaysまたはoptionalに設定されている場合にのみメッセージングにアクセスできます。

指定されたノートブックタイプに対してセルステータスバーアイテムプロバイダーを登録します。

拡張機能によって最後に作成されたソースコントロールの入力ボックス。

• 非推奨 - 代わりにSourceControl.inputBoxを使用してください。

新しいソースコントロールインスタンスを作成します。

現在アクティブなタスク実行、または空の配列。

タスクが終了したときに発火します。

基になるプロセスが終了したときに発火します。このイベントは、基になるプロセスを実行しないタスクでは発火しません。

タスクが開始したときに発火します。

基になるプロセスが開始されたときに発火します。このイベントは、基になるプロセスを実行しないタスクでは発火しません。

エディターによって管理されるタスクを実行します。返されたタスク実行を使用してタスクを終了できます。

• スロー - 新しいプロセスを開始できない環境でShellExecutionまたはProcessExecutionタスクを実行する場合。このような環境では、CustomExecutionタスクのみを実行できます。

システムで利用可能なすべてのタスクを取得します。これには、tasks.jsonファイルからのタスクと、拡張機能を通じて貢献されたタスクプロバイダーからのタスクが含まれます。

タスクプロバイダーを登録します。

新しいテストコントローラーを作成します。

設定で構成されている現在アクティブなカラーテーマ。アクティブなテーマは、workbench.colorTheme設定を介して変更できます。

現在アクティブなノートブックエディター、またはundefined。アクティブなエディターとは、現在フォーカスがあるエディター、またはフォーカスがない場合は最近入力が変更されたエディターです。

現在アクティブなターミナル、またはundefined。アクティブなターミナルとは、現在フォーカスがあるターミナル、または最も最近フォーカスがあったターミナルです。

現在アクティブなエディター、またはundefined。アクティブなエディターとは、現在フォーカスがあるエディター、またはフォーカスがない場合は最近入力が変更されたエディターです。

現在のウィンドウの状態を表します。

メインエディター領域内のグリッドウィジェットを表します。

現在開いているターミナル、または空の配列。

現在表示されているノートブックエディター、または空の配列。

現在表示されているエディター、または空の配列。

アクティブなカラーテーマが変更されたとき、または変更があるときに発火するイベント。

アクティブなノートブックエディターが変更されたときに発火するイベント。注: アクティブなエディターがundefinedに変更された場合にもイベントが発火します。

アクティブなターミナルが変更されたときに発火するイベント。注: アクティブなターミナルがundefinedに変更された場合にもイベントが発火します。

アクティブなエディターが変更されたときに発火するイベント。注: アクティブなエディターがundefinedに変更された場合にもイベントが発火します。

ノートブックエディターの選択範囲が変更されたときに発火するイベント。

ノートブックエディターの表示範囲が変更されたときに発火するイベント。

シェル統合がアクティブになったとき、またはターミナルのプロパティのいずれかが変更されたときに発火します。

ターミナルの状態が変更されたときに発火するイベント。

エディターのオプションが変更されたときに発火するイベント。

エディターの選択範囲が変更されたときに発火するイベント。

エディターのビュー列が変更されたときに発火するイベント。

エディターの可視範囲が変更されたときに発火するイベント。

表示されているノートブックエディターが変更されたときに発火するイベント。

表示されているエディターの配列が変更されたときに発火するイベント。

現在のウィンドウのフォーカスまたはアクティビティ状態が変更されたときに発火するイベント。イベントの値は、ウィンドウがフォーカスされているかどうかを表します。

ターミナルが破棄されたときに発火するイベント。

ターミナルコマンドが終了したときに発火します。このイベントは、ターミナルでシェル統合がアクティブ化されている場合にのみ発火します。

createTerminal APIまたはコマンドを通じてターミナルが作成されたときに発火するイベント。

ターミナルコマンドが開始されたときに発火します。このイベントは、ターミナルでシェル統合がアクティブ化されている場合にのみ発火します。

ユーザーにテキスト入力を入力させるためのInputBoxを作成します。

多くの場合、より便利なwindow.showInputBoxの方が使いやすいことに注意してください。window.createInputBoxは、window.showInputBoxが必要な柔軟性を提供しない場合に使用する必要があります。

指定された名前と言語IDを持つ新しい出力チャネルを作成します。言語IDが提供されていない場合、デフォルトの言語IDとしてLogが使用されます。

表示されているまたはアクティブな出力チャネルを表示されているエディターまたはアクティブなエディターからテキストドキュメントとしてアクセスし、言語IDを使用して構文の色付け、コードレンズなどの言語機能を提供できます。

指定された名前を持つ新しいログ出力チャネルを作成します。

ユーザーがタイプTのアイテムのリストからアイテムを選択できるようにするQuickPickを作成します。

多くの場合、より便利なwindow.showQuickPickの方が使いやすいことに注意してください。window.createQuickPickは、window.showQuickPickが必要な柔軟性を提供しない場合に使用する必要があります。

ステータスバーアイテムを作成します。

ステータスバーアイテムを作成します。

参照: 識別子付きステータスバーアイテムの作成についてはcreateStatusBarItem。

バッキングシェルプロセスを持つターミナルを作成します。ターミナルのCWDは、存在する場合はワークスペースディレクトリになります。

• スロー - 新しいプロセスを開始できない環境で実行する場合。

バッキングシェルプロセスを持つターミナルを作成します。

• スロー - 新しいプロセスを開始できない環境で実行する場合。

拡張機能がその入力と出力を制御するターミナルを作成します。

テキストエディターに装飾を追加するために使用できるTextEditorDecorationTypeを作成します。

拡張ポイントviewsを使用して貢献されたビューのTreeViewを作成します。

新しいウェブビューパネルを作成して表示します。

customEditors拡張ポイントによって貢献されたviewTypeのカスタムエディターのプロバイダーを登録します。

カスタムエディターが開かれると、onCustomEditor:viewTypeアクティベーションイベントが発火します。拡張機能は、アクティベーションの一部として、viewTypeのCustomTextEditorProvider、CustomReadonlyEditorProvider、CustomEditorProviderを登録する必要があります。

ファイル装飾プロバイダーを登録します。

ターミナル内のリンクの検出と処理を可能にするプロバイダーを登録します。

貢献されたターミナルプロファイルのプロバイダーを登録します。

拡張ポイントviewsを使用して貢献されたビューのTreeDataProviderを登録します。これにより、TreeViewにデータを貢献し、データが変更された場合に更新できるようになります。

注: TreeViewにアクセスし、それに対して操作を実行するには、createTreeViewを使用します。

システム全体のURIを処理できるURIハンドラーを登録します。複数のウィンドウが開いている場合、最上位のウィンドウがURIを処理します。URIハンドラーは、それが貢献された拡張機能にスコープされます。拡張機能自体に向けられたURIのみを処理できます。URIは次の規則を尊重する必要があります。

• URIスキームはvscode.env.uriSchemeである必要があります。
• URIオーソリティは拡張機能IDである必要があります (例: my.extension)。
• URIパス、クエリ、およびフラグメント部分は任意です。

たとえば、my.extension拡張機能がURIハンドラーを登録する場合、product-name://my.extensionというプレフィックスを持つURIのみを処理できます。

拡張機能は、そのアクティベーションライフタイム全体で1つのURIハンドラーのみを登録できます。

• 注: 現在の拡張機能に向けられたURIが処理されようとしているときに発火するアクティベーションイベントonUriがあります。

ウェブビューパネルシリアライザーを登録します。

復元をサポートする拡張機能は、"onWebviewPanel:viewType"アクティベーションイベントを持ち、アクティベーション中にregisterWebviewPanelSerializerが呼び出されることを確認する必要があります。

特定のviewTypeに対して一度に登録できるシリアライザーは1つだけです。

webviewビューの新しいプロバイダーを登録します。

ステータスバーにメッセージを設定します。これは、より強力なステータスバーのアイテムの省略形です。

ステータスバーにメッセージを設定します。これは、より強力なステータスバーのアイテムの省略形です。

ステータスバーにメッセージを設定します。これは、より強力なステータスバーのアイテムの省略形です。

注意: ステータスバーメッセージはスタックされ、不要になったら破棄する必要があります。

エラーメッセージを表示します。

関連項目 showInformationMessage

エラーメッセージを表示します。

関連項目 showInformationMessage

エラーメッセージを表示します。

関連項目 showInformationMessage

エラーメッセージを表示します。

関連項目 showInformationMessage

ユーザーに情報メッセージを表示します。オプションで、クリック可能なボタンとして表示されるアイテムの配列を提供します。

ユーザーに情報メッセージを表示します。オプションで、クリック可能なボタンとして表示されるアイテムの配列を提供します。

情報メッセージを表示します。

関連項目 showInformationMessage

情報メッセージを表示します。

関連項目 showInformationMessage

ユーザーに入力を求める入力ボックスを開きます。

入力ボックスがキャンセルされた場合（例: ESCキーを押した場合）、返される値はundefinedになります。それ以外の場合、返される値はユーザーが入力した文字列、またはユーザーが何も入力せずにOKで入力ボックスを閉じたら空の文字列になります。

指定されたNotebookDocumentをノートブックエディターで表示します。

ファイルを開く目的でファイルを選択できるファイルを開くダイアログをユーザーに表示します。

複数の選択を可能にする選択リストを表示します。

選択リストを表示します。

複数の選択を可能にする選択リストを表示します。

選択リストを表示します。

ファイルを保存する目的でファイルを選択できるファイル保存ダイアログをユーザーに表示します。