組み込みコマンド
このドキュメントは、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
- 指定されたリソースを diff エディターで開いて内容を比較します。
- left - diff エディターの左側のリソース
- right - diff エディターの右側のリソース
- title - diff エディターの人間に読みやすいタイトル
- 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
- newWindow 引数に応じて、現在のウィンドウまたは新しいウィンドウでフォルダーまたはワークスペースを開きます。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
を確認するには、コマンド パレット (⇧⌘P (Windows, Linux Ctrl+Shift+P)) から基本設定: デフォルトのキーボード ショートカット (JSON) を開くを実行します。