組み込みコマンド
このドキュメントでは、vscode.commands.executeCommand API で使用できる Visual Studio Code コマンドのサブセットを一覧表示します。
コマンド API の使用方法については、コマンドガイドを参照してください。
以下は、VS Code で新しいフォルダーを開く方法のサンプルです。
let uri = Uri.file('/some/path/to/folder');
let success = await commands.executeCommand('vscode.openFolder', uri);
注: VS Code コマンドの全セットは、キーボードショートカットエディター(ファイル > ユーザー設定 > キーボードショートカット)から確認できます。キーボードショートカットエディターには、VS Code に組み込まれている、または拡張機能によって提供されるすべてのコマンドが、キーバインドや「when」句の表示条件とともに一覧表示されます。
コマンド
vscode.executeDataToNotebook - ノートブックシリアライザーを呼び出す
- notebookType - ノートブックの種類
- data - データに変換するバイト列
- (戻り値) - ノートブックデータ
vscode.executeNotebookToData - ノートブックシリアライザーを呼び出す
- notebookType - ノートブックの種類
- NotebookData - バイト列に変換するノートブックデータ
- (戻り値) - バイト列
notebook.selectKernel - 指定されたノートブックエディターウィジェットのカーネルピッカーをトリガーする
- options - カーネル選択オプション
- (戻り値) - 結果なし
interactive.open - インタラクティブウィンドウを開き、ノートブックエディターと入力 URI を返す
- showOptions - 表示オプション
- resource - インタラクティブリソースの URI
- controllerId - ノートブックコントローラー ID
- title - インタラクティブエディターのタイトル
- (戻り値) - ノートブックおよび入力 URI
vscode.editorChat.start - 新しいエディターチャットセッションを呼び出す
- 実行引数 -
- (戻り値) - 結果なし
vscode.executeDocumentHighlights - ドキュメントハイライトプロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - DocumentHighlight インスタンスの配列に解決される Promise。
vscode.executeDocumentSymbolProvider - ドキュメントシンボルプロバイダーを実行する。
- uri - テキストドキュメントの URI
- (戻り値) - SymbolInformation および DocumentSymbol インスタンスの配列に解決される Promise。
vscode.executeFormatDocumentProvider - ドキュメントフォーマットプロバイダーを実行する。
- uri - テキストドキュメントの URI
- options - フォーマットオプション
- (戻り値) - TextEdit の配列に解決される Promise。
vscode.executeFormatRangeProvider - 範囲フォーマットプロバイダーを実行する。
- uri - テキストドキュメントの URI
- range - テキストドキュメント内の範囲
- options - フォーマットオプション
- (戻り値) - TextEdit の配列に解決される Promise。
vscode.executeFormatOnTypeProvider - 入力時フォーマットプロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- ch - トリガー文字
- options - フォーマットオプション
- (戻り値) - TextEdit の配列に解決される Promise。
vscode.executeDefinitionProvider - すべての定義プロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - Location または LocationLink インスタンスの配列に解決される Promise。
vscode.executeTypeDefinitionProvider - すべての型定義プロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - Location または LocationLink インスタンスの配列に解決される Promise。
vscode.executeDeclarationProvider - すべての宣言プロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - Location または LocationLink インスタンスの配列に解決される Promise。
vscode.executeImplementationProvider - すべての実装プロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - Location または LocationLink インスタンスの配列に解決される Promise。
vscode.executeReferenceProvider - すべての参照プロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - Location インスタンスの配列に解決される Promise。
vscode.executeHoverProvider - すべてのホバープロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - Hover インスタンスの配列に解決される Promise。
vscode.executeSelectionRangeProvider - 選択範囲プロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - 範囲の配列に解決される Promise。
vscode.executeWorkspaceSymbolProvider - すべてのワークスペースシンボルプロバイダーを実行する。
- query - 検索文字列
- (戻り値) - SymbolInformation インスタンスの配列に解決される Promise。
vscode.prepareCallHierarchy - ドキュメント内の位置でコール階層を準備する
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - CallHierarchyItem インスタンスの配列に解決される Promise
vscode.provideIncomingCalls - アイテムへの呼び出し元を計算する
- item - コール階層アイテム
- (戻り値) - CallHierarchyIncomingCall インスタンスの配列に解決される Promise
vscode.provideOutgoingCalls - アイテムからの呼び出し先を計算する
- item - コール階層アイテム
- (戻り値) - CallHierarchyOutgoingCall インスタンスの配列に解決される Promise
vscode.prepareRename - 名前変更プロバイダーの prepareRename を実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - 範囲とプレースホルダーテキストに解決される Promise。
vscode.executeDocumentRenameProvider - 名前変更プロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- newName - 新しいシンボル名
- (戻り値) - WorkspaceEdit に解決される Promise。
vscode.executeLinkProvider - ドキュメントリンクプロバイダーを実行する。
- uri - テキストドキュメントの URI
- linkResolveCount - (オプション) リンクが未解決の場合のみ、解決されるべきリンクの数。
- (戻り値) - DocumentLink インスタンスの配列に解決される Promise。
vscode.provideDocumentSemanticTokensLegend - ドキュメントのセマンティックトークン凡例を提供する
- uri - テキストドキュメントの URI
- (戻り値) - SemanticTokensLegend に解決される Promise。
vscode.provideDocumentSemanticTokens - ドキュメントのセマンティックトークンを提供する
- uri - テキストドキュメントの URI
- (戻り値) - SemanticTokens に解決される Promise。
vscode.provideDocumentRangeSemanticTokensLegend - ドキュメント範囲のセマンティックトークン凡例を提供する
- uri - テキストドキュメントの URI
- range - (オプション) テキストドキュメント内の範囲
- (戻り値) - SemanticTokensLegend に解決される Promise。
vscode.provideDocumentRangeSemanticTokens - ドキュメント範囲のセマンティックトークンを提供する
- uri - テキストドキュメントの URI
- range - テキストドキュメント内の範囲
- (戻り値) - SemanticTokens に解決される Promise。
vscode.executeCompletionItemProvider - 補完アイテムプロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- triggerCharacter - (オプション)
,や(のような文字を入力したときに補完をトリガーする - itemResolveCount - (オプション) 解決する補完の数(大きすぎると補完が遅くなります)
- (戻り値) - CompletionList インスタンスに解決される Promise。
vscode.executeSignatureHelpProvider - シグネチャヘルププロバイダーを実行する。
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- triggerCharacter - (オプション)
,や(のような文字を入力したときにシグネチャヘルプをトリガーする - (戻り値) - SignatureHelp に解決される Promise。
vscode.executeCodeLensProvider - コードレンズプロバイダーを実行する。
- uri - テキストドキュメントの URI
- itemResolveCount - (オプション) 解決して返すレンズの数。解決されたレンズのみを返しますが、パフォーマンスに影響します。
- (戻り値) - CodeLens インスタンスの配列に解決される Promise。
vscode.executeCodeActionProvider - コードアクションプロバイダーを実行する。
- uri - テキストドキュメントの URI
- rangeOrSelection - テキストドキュメント内の範囲。一部のリファクタリングプロバイダーは Selection オブジェクトを必要とします。
- kind - (オプション) コードアクションを返すためのコードアクションの種類
- itemResolveCount - (オプション) 解決するコードアクションの数(大きすぎるとコードアクションが遅くなります)
- (戻り値) - Command インスタンスの配列に解決される Promise。
vscode.executeDocumentColorProvider - ドキュメントカラープロバイダーを実行する。
- uri - テキストドキュメントの URI
- (戻り値) - ColorInformation オブジェクトの配列に解決される Promise。
vscode.executeColorPresentationProvider - カラープレゼンテーションプロバイダーを実行する。
- color - 表示および挿入する色
- context - URI と範囲を含むコンテキストオブジェクト
- (戻り値) - ColorPresentation オブジェクトの配列に解決される Promise。
vscode.executeInlayHintProvider - インレイヒントプロバイダーを実行する
- uri - テキストドキュメントの URI
- range - テキストドキュメント内の範囲
- (戻り値) - Inlay オブジェクトの配列に解決される Promise
vscode.executeFoldingRangeProvider - 折りたたみ範囲プロバイダーを実行する
- uri - テキストドキュメントの URI
- (戻り値) - FoldingRange オブジェクトの配列に解決される Promise
vscode.resolveNotebookContentProviders - ノートブックコンテンツプロバイダーを解決する
- (戻り値) - NotebookContentProvider の静的情報オブジェクトの配列に解決される Promise。
vscode.executeInlineValueProvider - インライン値プロバイダーを実行する
- uri - テキストドキュメントの URI
- range - テキストドキュメント内の範囲
- context - InlineValueContext
- (戻り値) - InlineValue オブジェクトの配列に解決される Promise
vscode.open - 指定されたリソースをエディターで開きます。テキストファイル、バイナリファイル、または http(s) URL が指定可能です。テキストファイルを開く際のオプションをより細かく制御したい場合は、代わりに vscode.window.showTextDocument を使用してください。
- uri - テキストファイル、バイナリファイル、または http(s) URL の URI
- columnOrOptions - (オプション) 開くカラム、またはエディターオプション。
vscode.TextDocumentShowOptionsを参照してください。 - label - エディターのラベル (オプション)
- (戻り値) - 結果なし
vscode.openWith - 指定されたリソースを特定のエディターで開きます。
- resource - 開くリソース
- viewId - カスタムエディターのビュー ID、または VS Code のデフォルトエディターを使用する場合は 'default'
- columnOrOptions - (オプション) 開くカラム、またはエディターオプション。vscode.TextDocumentShowOptions を参照してください。
- (戻り値) - 結果なし
vscode.diff - 指定されたリソースを Diff エディターで開き、内容を比較します。
- left - Diff エディターの左側のリソース
- right - Diff エディターの右側のリソース
- title - Diff エディターの人間が読めるタイトル
- options - (オプション) 開くカラム、またはエディターオプション(vscode.TextDocumentShowOptions を参照)
vscode.changes - リソースのリストを Changes エディターで開き、内容を比較します。
- title - Changes エディターの人間が読めるタイトル
- resourceList - 比較するリソースのリスト
vscode.prepareTypeHierarchy - ドキュメント内の位置で型階層を準備する
- uri - テキストドキュメントの URI
- position - テキストドキュメント内の位置
- (戻り値) - TypeHierarchyItem インスタンスの配列に解決される Promise
vscode.provideSupertypes - アイテムのスーパークラスを計算する
- item - 型階層アイテム
- (戻り値) - TypeHierarchyItem インスタンスの配列に解決される Promise
vscode.provideSubtypes - アイテムのサブクラスを計算する
- item - 型階層アイテム
- (戻り値) - TypeHierarchyItem インスタンスの配列に解決される Promise
vscode.revealTestInExplorer - エクスプローラーでテストインスタンスを表示する
- testItem - VS Code TestItem。
- (戻り値) - 結果なし
setContext - when 句で使用できるカスタムコンテキストキーの値を設定する。
- name - コンテキストキー名
- value - コンテキストキーの値
- (戻り値) - 結果なし
cursorMove - ビュー内の論理的な位置にカーソルを移動する
- カーソル移動引数オブジェクト - この引数を通じて渡すことができるプロパティと値のペア
- 'to': カーソルの移動先を指定する必須の論理位置値。
'left', 'right', 'up', 'down', 'prevBlankLine', 'nextBlankLine', 'wrappedLineStart', 'wrappedLineEnd', 'wrappedLineColumnCenter' 'wrappedLineFirstNonWhitespaceCharacter', 'wrappedLineLastNonWhitespaceCharacter' 'viewPortTop', 'viewPortCenter', 'viewPortBottom', 'viewPortIfOutside' - 'by': 移動単位。デフォルトは 'to' の値に基づいて計算されます。
'line', 'wrappedLine', 'character', 'halfLine' - 'value': 移動する単位数。デフォルトは '1'。
- 'select': 'true' の場合、選択範囲を作成する。デフォルトは 'false'。
- 'to': カーソルの移動先を指定する必須の論理位置値。
editorScroll - 指定された方向にエディターをスクロールする
- エディタースクロール引数オブジェクト - この引数を通じて渡すことができるプロパティと値のペア
- 'to': 必須の方向値。
'up', 'down' - 'by': 移動単位。デフォルトは 'to' の値に基づいて計算されます。
'line', 'wrappedLine', 'page', 'halfPage', 'editor' - 'value': 移動する単位数。デフォルトは '1'。
- 'revealCursor': 'true' の場合、カーソルがビューポートの外にあるときにカーソルを表示する。
- 'to': 必須の方向値。
revealLine - 指定された行を指定された論理位置に表示する
- 行表示引数オブジェクト - この引数を通じて渡すことができるプロパティと値のペア
- 'lineNumber': 必須の行番号値。
- 'at': 行を表示する論理位置。
'top', 'center', 'bottom'
editor.unfold - エディター内のコンテンツを展開する
- 展開引数 - この引数を通じて渡すことができるプロパティと値のペア
- 'levels': 展開する階層数。設定しない場合はデフォルトで 1。
- 'direction': 'up' の場合、指定した階層数分だけ上方向に展開する。それ以外は下方向に展開する。
- 'selectionLines': 展開アクションを適用するエディター選択範囲の開始行(0 始まり)の配列。設定しない場合は、現在のアクティブな選択範囲が使用されます。
editor.fold - エディター内のコンテンツを折りたたむ
- 折りたたみ引数 - この引数を通じて渡すことができるプロパティと値のペア
- 'levels': 折りたたむ階層数。
- 'direction': 'up' の場合、指定した階層数分だけ上方向に折りたたむ。それ以外は下方向に折りたたむ。
- 'selectionLines': 折りたたみアクションを適用するエディター選択範囲の開始行(0 始まり)の配列。設定しない場合は、現在のアクティブな選択範囲が使用されます。レベルも方向も設定されていない場合、その場所の領域を折りたたみます。すでに折りたたまれている場合は、折りたたまれていない最初の親を折りたたみます。
editor.toggleFold - 現在の状態に応じて、エディター内のコンテンツを折りたたむか展開する
editor.actions.findWithArgs - 特定のオプションで新しいエディター内検索ウィジェットを開く。
- searchString - 検索入力に事前入力する文字列
- replaceString - 置換入力に事前入力する文字列
- isRegex - 正規表現を有効にする
- preserveCase - 置換時に大文字小文字を維持しようとする
- findInSelection - 検索場所を現在の選択範囲に制限する
- matchWholeWord
- isCaseSensitive
editor.action.goToLocations - ファイル内の位置から場所へ移動する
- uri - 開始するテキストドキュメント
- position - 開始する位置
- locations - 場所の配列。
- multiple - 複数の結果がある場合の動作を定義する。
peek,gotoAndPeek, またはgoto - noResultsMessage - 場所が空の場合に表示する人間が読めるメッセージ。
editor.action.peekLocations - ファイル内の位置から場所をプレビューする
- uri - 開始するテキストドキュメント
- position - 開始する位置
- locations - 場所の配列。
- multiple - 複数の結果がある場合の動作を定義する。
peek,gotoAndPeek, またはgoto
workbench.action.quickOpen - クイックアクセス
- prefix -
notebook.cell.toggleOutputs - 出力の切り替え
- options - セル範囲オプション
notebook.fold - セルの折りたたみ
- index - セルインデックス
notebook.unfold - セルの展開
- index - セルインデックス
notebook.selectKernel - ノートブックカーネルの引数
- kernelInfo - カーネル情報
notebook.cell.changeLanguage - セル言語の変更
- range - セル範囲
- language - ターゲットのセル言語
notebook.execute - すべて実行
- uri - ドキュメント URI
notebook.cell.execute - セルの実行
- options - セル範囲オプション
notebook.cell.executeAndFocusContainer - セルを実行してコンテナーにフォーカスする
- options - セル範囲オプション
notebook.cell.cancelExecution - セル実行の停止
- options - セル範囲オプション
workbench.action.findInFiles - ワークスペース検索を開く
- 検索用オプションセット -
_interactive.open - インタラクティブウィンドウを開く
- showOptions - 表示オプション
- resource - インタラクティブリソースの URI
- controllerId - ノートブックコントローラー ID
- title - ノートブックエディターのタイトル
interactive.execute - 入力ボックスの内容を実行する
- resource - インタラクティブリソースの URI
search.action.openNewEditor - 新しい検索エディターを開く。渡される引数には ${relativeFileDirname} などの変数が含まれます。
- 新しい検索エディターの引数 -
search.action.openEditor - 新しい検索エディターを開く。渡される引数には ${relativeFileDirname} などの変数が含まれます。
- 新しい検索エディターの引数 -
search.action.openNewEditorToSide - 新しい検索エディターをサイドに開く。渡される引数には ${relativeFileDirname} などの変数が含まれます。
- 新しい検索エディターの引数 -
vscode.openFolder - 現在のウィンドウまたは新しいウィンドウでフォルダーやワークスペースを開きます。newWindow 引数に依存します。同じウィンドウで開くと、現在の拡張機能ホストプロセスがシャットダウンされ、新しいウィンドウパラメーターが true に設定されていない限り、指定されたフォルダー/ワークスペースで新しいプロセスが開始されることに注意してください。
- uri - (オプション) 開くフォルダーまたはワークスペースファイルの URI。提供されない場合は、ネイティブダイアログでユーザーにフォルダーが尋ねられます。
- options - (オプション) オプション。以下のプロパティを持つオブジェクト:
forceNewWindow:フォルダー/ワークスペースを新しいウィンドウで開くか同じウィンドウで開くか。デフォルトは同じウィンドウ。forceReuseWindow:フォルダー/ワークスペースを同じウィンドウで強制的に開くかどうか。デフォルトは false。noRecentEntry:開いた URI が「最近開いた」リストに表示されるかどうか。デフォルトは false。後方互換性のため、オプションはforceNewWindow設定を表すブール型にすることもできます。
vscode.newWindow - newWindow 引数に応じて新しいウィンドウを開きます。
- options - (オプション) オプション。以下のプロパティを持つオブジェクト:
reuseWindow:新しいウィンドウで開くか同じウィンドウで開くか。デフォルトは新しいウィンドウ。
vscode.removeFromRecentlyOpened - 最近開いたリストから指定されたパスのエントリを削除します。
- path - 最近開いたリストから削除する URI または URI 文字列。
moveActiveEditor - アクティブなエディターをタブまたはグループ単位で移動する
- アクティブエディター移動引数 - 引数プロパティ
- 'to': 移動先を指定する文字列値。
- 'by': 移動単位を指定する文字列値(タブ単位またはグループ単位)。
- 'value': 移動する位置の数または絶対的な移動位置を指定する数値。
copyActiveEditor - アクティブなエディターをグループ単位でコピーする
- アクティブエディターコピー引数 - 引数プロパティ
- 'to': コピー先を指定する文字列値。
- 'value': コピーする位置の数または絶対的なコピー位置を指定する数値。
vscode.getEditorLayout - エディターレイアウトを取得する
- (戻り値) - vscode.setEditorLayout と同じ形式のエディターレイアウトオブジェクト
workbench.action.files.newUntitledFile - 新しい無題のテキストファイル
- 新しい無題のテキストファイルの引数 - 既知の場合はエディターのビュータイプまたは言語 ID
workbench.extensions.installExtension - 指定された拡張機能をインストールする
- extensionIdOrVSIXUri - 拡張機能 ID または VSIX リソース URI
- options - (オプション) 拡張機能インストール用のオプション。以下のプロパティを持つオブジェクト:
installOnlyNewlyAddedFromExtensionPackVSIX:有効にすると、VS Code は拡張機能パック VSIX から新しく追加された拡張機能のみをインストールします。このオプションは VSIX をインストールする場合のみ考慮されます。
workbench.extensions.uninstallExtension - 指定された拡張機能をアンインストールする
- アンインストールする拡張機能の ID -
workbench.extensions.search - 特定の拡張機能を検索する
- 検索に使用するクエリ -
workbench.action.tasks.runTask - タスクを実行する
- args - クイックピックに表示されるタスクをフィルタリングする
workbench.action.openIssueReporter - 問題報告ツールを開き、オプションでフォームの一部を事前入力する。
- options - 問題報告ツールに事前入力するために使用するデータ。
vscode.openIssueReporter - 問題報告ツールを開き、オプションでフォームの一部を事前入力する。
- options - 問題報告ツールに事前入力するために使用するデータ。
workbench.action.openLogFile - workbench.action.openLogFile
- logFile -
workbench.action.openWalkthrough - ウォークスルーを開く。
- walkthroughID - 開くウォークスルーの ID。
- toSide - ウォークスルーをサイドの新しいエディターグループで開く。
シンプルなコマンド
パラメーターを必要としないシンプルなコマンドは、デフォルトの keybindings.json ファイル内のキーボードショートカットリストで見つけることができます。バインドされていないコマンドは、ファイル末尾のコメントブロックにリストされています。
デフォルトの keybindings.json を確認するには、コマンドパレットから 基本設定: 既定のキーボードショートカットを開く (JSON) を実行します(⇧⌘P (Windows, Linux Ctrl+Shift+P))。