組み込みコマンド
このドキュメントでは、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 に組み込まれているすべてのコマンド、または拡張機能によって提供されるすべてのコマンドが、キーバインドと表示条件句と共にリストされます。
コマンド
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 - 指定されたリソースを差分エディターで開いて、その内容を比較します。
- left - 差分エディターの左側のリソース
- right - 差分エディターの右側のリソース
- title - 差分エディターの人間が読めるタイトル
- options - (オプション) 開く列、またはエディターオプション (vscode.TextDocumentShowOptions を参照) のいずれか
vscode.changes - 変更エディターでリソースのリストを開いて、その内容を比較します。
- title - 変更エディターの人間が読めるタイトル
- 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 - コンテキストキー値
- (戻り値) - 結果なし
vscode.executeMappedEditsProvider - マップされた編集プロバイダーを実行します
- uri - テキストドキュメントの URI
- string_array - 文字列の配列
- MappedEditsContext - マップされた編集コンテキスト
- (戻り値) - ワークスペース編集または null に解決される Promise
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 - 新しいウィンドウ引数に応じて、現在のウィンドウまたは新しいウィンドウでフォルダーまたはワークスペースを開きます。新しいウィンドウパラメーターが true に設定されていない限り、同じウィンドウで開くと、現在の拡張機能ホストプロセスがシャットダウンされ、指定されたフォルダー/ワークスペースで新しいプロセスが開始されることに注意してください。
- uri - (オプション) 開くフォルダーまたはワークスペースファイルの URI。指定されていない場合は、ネイティブダイアログがユーザーにフォルダーを尋ねます
- options - (オプション) オプション。次のプロパティを持つオブジェクト:
forceNewWindow: フォルダー/ワークスペースを新しいウィンドウで開くか、同じウィンドウで開くか。デフォルトは同じウィンドウで開くです。forceReuseWindow: フォルダー/ワークスペースを同じウィンドウで開くことを強制するかどうか。デフォルトは false です。noRecentEntry: 開かれた URI が「最近開いたファイル」リストに表示されるかどうか。デフォルトは false です。なお、後方互換性のために、options はforceNewWindow設定を表すブール型でも構いません。
vscode.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 を確認するには、コマンドパレット (⇧⌘P (Windows, Linux Ctrl+Shift+P)) から 基本設定: デフォルトのキーボードショートカットを開く (JSON) を実行します。