VS Code API

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

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

現在、エディターの組み込み拡張機能から提供され、GitHub および Microsoft 認証を実装している認証プロバイダーは 2 つのみです。それぞれの providerId は '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 回登録するとエラーが発生します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

アプリケーションがホストされている場所。デスクトップでは 'desktop' です。Web では指定された埋め込み先（例：'github.dev'、'codespaces'）であり、埋め込み先がその情報を提供しない場合は 'web' です。

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

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

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

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

アプリケーションがポータブルモードで実行されているかどうかを示します。

ポータブルモードは、アプリケーションが data ディレクトリを含むフォルダーから実行されたときに有効になり、自己完結型のインストールを可能にします。

ポータブルモード について詳しく学びます。

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

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

de-CH、fr、en-US などの推奨ユーザー言語を表します。

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

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

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

注意：リモート拡張ホストがない場合、値は undefined になりますが、リモート拡張ホストが存在する場合、すべての拡張ホスト（ローカルおよびリモート）で値が定義されます。特定の拡張機能がリモートで実行されているかどうかを知るには Extension.extensionKind を使用してください。

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

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

UI 種類のプロパティは、拡張機能がどの UI からアクセスされているかを示します。たとえば、拡張機能はデスクトップアプリケーションや Web ブラウザーからアクセスされる場合があります。

エディターがオペレーティングシステムに登録するカスタム 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);

注意：解決された URI はシステムやユーザーのアクションによって無効になる可能性があるため、拡張機能は asExternalUri の結果をキャッシュすべきではありません。たとえば、リモートの場合、ユーザーが 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 値が挿入されます）。

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

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

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

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

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

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

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

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

1. DocumentSelector が配列である場合、含まれる各 DocumentFilter または言語識別子についてマッチを計算し、最大値をとります。
2. 文字列は DocumentFilter の language 部分になるように脱糖されるため、"fooLang" は { language: "fooLang" } のようになります。
3. DocumentFilter は、その部分をドキュメントと比較することでドキュメントと照合されます。以下のルールが適用されます。
   1. DocumentFilter が空 ({}) の場合、結果は 0 です。
   2. scheme、language、pattern、または notebook が定義されているが、一致しない場合、結果は 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 プロパティを使用して並べ替えられます。デフォルトでは、最初の編集が適用されます。追加の編集がある場合は、ドロップウィジェットでユーザーが選択可能なドロップオプションとして表示されます。

ドキュメントのフォーマットプロバイダーを登録します。

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは スコア によって並べ替えられ、最も一致するプロバイダーが使用されます。選択されたプロバイダーが失敗すると、操作全体が失敗します。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは スコア によって並べ替えられ、ドキュメントのハイライトを順次求められます。プロバイダーが 非偽 または 非失敗 の結果を返すと、プロセスは停止します。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

新しい DocumentPasteEditProvider を登録します。

言語に対して複数のプロバイダーを登録できます。DocumentPasteProviderMetadata で指定された処理対象の MIME タイプに基づいて、言語に対して登録されたすべてのプロバイダーがコピーおよび貼り付け操作のために呼び出されます。

コピー操作 の場合、各プロバイダーによって DataTransfer に加えられた変更は、クリップボードを生成するために使用される単一の DataTransfer にマージされます。

貼り付け操作 の場合、各プロバイダーが呼び出され、1 つ以上の DocumentPasteEdits を返すことができます。編集は DocumentPasteEdit.yieldTo プロパティを使用して並べ替えられます。デフォルトでは、最初の編集が適用され、残りの編集は貼り付けウィジェットでユーザーが選択可能な貼り付けオプションとして表示されます。

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

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは スコア によって並べ替えられ、最も一致するプロバイダーが使用されます。選択されたプロバイダーが失敗すると、操作全体が失敗します。

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

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは スコア によって並べ替えられ、最も一致するプロバイダーが使用されます。選択されたプロバイダーが失敗すると、操作全体が失敗します。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは スコア によって並べ替えられ、最も一致するプロバイダーが使用されます。選択されたプロバイダーが失敗すると、操作全体が失敗します。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

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

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

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

プロバイダーが失敗（拒否されたPromiseまたは例外）しても、操作全体が失敗することはありません。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

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

入力中に動作するフォーマットプロバイダーを登録します。ユーザーが設定 editor.formatOnType を有効にしているときにプロバイダーがアクティブになります。

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは スコア によって並べ替えられ、最も一致するプロバイダーが使用されます。選択されたプロバイダーが失敗すると、操作全体が失敗します。

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

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

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

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

参照 languages.registerSignatureHelpProvider

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

言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーは並列で問い合わせられ、結果はマージされます。失敗したプロバイダー（拒否された Promise や例外）は、操作全体の失敗を引き起こしません。

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

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

複数のプロバイダーを登録できます。その場合、プロバイダーは並列で呼び出され、結果がマージされます。プロバイダーが失敗（拒否された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 寄与ポイントを介して言語モデルチャットプロバイダーも定義する必要があります。

エディターが消費できるようにModel Context Protocolサーバーを公開するプロバイダーを登録します。これにより、ユーザーが設定ファイルで作成したものに加えて、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。アクティブなエディターとは、現在フォーカスがあるもの、またはフォーカスがない場合は、最も最近入力が変更されたものです。

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

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

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

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

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

アクティブなカラーテーマが変更された、または変更があるときに発生する Event。

アクティブなノートブックエディターが変更されたときに発生する Event。注意: このイベントは、アクティブなエディターが undefined に変更されたときにも発生します。

アクティブなターミナルが変更されたときに発生する Event。注意: このイベントは、アクティブなターミナルが undefined に変更されたときにも発生します。

アクティブなエディターが変更されたときに発生する Event。注意: このイベントは、アクティブなエディターが undefined に変更されたときにも発生します。

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

ノートブックエディターの可視範囲が変更されたときに発生する Event。

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

ターミナルの状態が変更されたときに発生する Event。

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

エディター内の選択範囲が変更されたときに発生する Event。

エディターのビュー列が変更されたときに発生する Event。

エディターの可視範囲が変更されたときに発生する Event。

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

表示されているエディターの配列が変更されたときに発生する Event。

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

ターミナルが破棄されたときに発生する Event。

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

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

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

ユーザーがテキスト入力を入力できるように InputBox を作成します。

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

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

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

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

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

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

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

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

参照 createStatusBarItem（識別子付きのステータスバーアイテムを作成する場合）。

基盤となるシェルプロセスを持つ Terminal を作成します。ターミナルの作業ディレクトリ (cwd) は、ワークスペースディレクトリが存在する場合は、そのディレクトリになります。

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

基盤となるシェルプロセスを持つ Terminal を作成します。

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

拡張機能がその入力と出力を制御する Terminal を作成します。

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

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

新しいWebviewパネルを作成して表示します。

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

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

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

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

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

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

注: TreeView にアクセスし、その上で操作を実行するには、createTreeView を使用してください。

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

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

例えば、my.extension 拡張機能がuriハンドラーを登録する場合、product-name://my.extension で始まるuriのみを処理できます。

拡張機能は、そのアクティベーション期間全体で単一のuriハンドラーのみを登録できます。

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

Webviewパネルシリアライザーを登録します。

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

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

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

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

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

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

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

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

関連項目 showInformationMessage

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

関連項目 showInformationMessage

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

関連項目 showInformationMessage

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

関連項目 showInformationMessage

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

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

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

関連項目 showInformationMessage

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

関連項目 showInformationMessage

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

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

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

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

複数選択が可能な選択リストを表示します。

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

複数選択が可能な選択リストを表示します。