VS Code API

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

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

現在、エディターに組み込み拡張機能から貢献されている認証プロバイダーは、GitHubとMicrosoftの認証を実装する2つのみです。それらのproviderIdは「github」と「microsoft」です。

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

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

現在、エディターに組み込み拡張機能から貢献されている認証プロバイダーは、GitHubとMicrosoftの認証を実装する2つのみです。それらのproviderIdは「github」と「microsoft」です。

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

現在、エディターに組み込み拡張機能から貢献されている認証プロバイダーは、GitHubとMicrosoftの認証を実装する2つのみです。それらのproviderIdは「github」と「microsoft」です。

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

現在、エディターに組み込み拡張機能から貢献されている認証プロバイダーは、GitHubとMicrosoftの認証を実装する2つのみです。それらのproviderIdは「github」と「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に変換します。ソースディスクリプターがパスに基づいている場合、ファイルUriが返されます。ソースディスクリプターが参照番号を使用する場合、対応するContentProviderと実行中のデバッグセッションを必要とする特定のデバッグUri (スキーム 'debug') が構築されます。

「Source」ディスクリプターにUriを作成するための情報が不足している場合、エラーがスローされます。

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

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

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

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

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

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

アプリケーションのホストされている場所。デスクトップでは「desktop」であり、Webでは、指定されたエンベッダー、つまり「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: スキーム

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

拡張機能がクライアントマシンで実行されている場合、これはno-opです。

拡張機能がリモートで実行されている場合、この関数はローカルマシンからリモートの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値が挿入されます)。

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

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

新しい言語ステータス項目を作成します。

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

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

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

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

一致はこれらのルールに従って計算されます

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

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

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

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

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

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

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

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

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

1つの言語に対して複数のプロバイダーを登録できます。その場合、プロバイダーはスコアでソートされ、同等のスコアを持つグループは順次補完項目を要求されます。1つまたは複数のグループのプロバイダーが結果を返すと、プロセスは停止します。プロバイダーの失敗 (拒否されたPromiseまたは例外) は、操作全体の失敗を引き起こしません。

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

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

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

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

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

新しいDocumentDropEditProviderを登録します。

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

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

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

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

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

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

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

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

新しいDocumentPasteEditProviderを登録します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

失敗したプロバイダー（拒否されたPromiseまたは例外）は、操作全体が失敗する原因にはなりません。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

参照: languages.registerSignatureHelpProvider

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

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

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

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

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

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

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

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

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

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

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

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

前者の場合、呼び出し元は、チャットリクエストとともに提供されるtoolInvocationTokenを渡す必要があります。これにより、チャットUIが正しい会話に対してツールの呼び出しを表示することを保証します。

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

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

エディターが利用するモデルコンテキストプロトコルサーバーを公開するプロバイダーを登録します。これにより、ユーザーが設定ファイルで作成したサーバーに加えて、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.showInputBoxが必要な柔軟性を提供しない場合に、window.createInputBoxを使用すべきです。

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

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

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

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

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

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

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

参照: 識別子を持つステータスバーアイテムを作成するための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があります。

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

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

指定されたviewTypeに対して、一度に登録できるシリアライザーは1つだけです。

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

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

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

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

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

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

関連項目: showInformationMessage

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

関連項目: showInformationMessage

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

関連項目: showInformationMessage

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

関連項目: showInformationMessage

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

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

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

関連項目: showInformationMessage

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

関連項目: showInformationMessage

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

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

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

ユーザーにファイルを開くためのファイルオープンダイアログを表示し、ファイルを選択できるようにします。

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