組み込みコマンド
このドキュメントでは、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 に組み込まれている、または拡張機能によって提供されるすべてのコマンドが、そのキーバインディングと visibility 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
- rename プロバイダーの 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
- newWindow 引数に応じて、現在のウィンドウまたは新しいウィンドウでフォルダーまたはワークスペースを開きます。newWindow パラメーターが true に設定されていない限り、同じウィンドウで開くと、現在の拡張ホストプロセスがシャットダウンされ、指定されたフォルダー/ワークスペースで新しいプロセスが開始されることに注意してください。
- uri - (オプション) 開くフォルダーまたはワークスペースファイルの URI。指定しない場合、ネイティブダイアログがユーザーにフォルダーを尋ねます。
- options - (オプション) オプション。次のプロパティを持つオブジェクト:
forceNewWindow
: フォルダー/ワークスペースを新しいウィンドウで開くか、同じウィンドウで開くか。デフォルトは同じウィンドウで開く。forceReuseWindow
: フォルダー/ワークスペースを強制的に同じウィンドウで開くか。デフォルトは false。noRecentEntry
: 開かれた URI が「最近開いたファイル」リストに表示されるかどうか。デフォルトは false。なお、下位互換性のため、options は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) を実行します。