拡張機能マーケットプレース
Visual Studio Codeに標準で含まれている機能は、ほんの始まりに過ぎません。VS Codeの拡張機能を使用すると、言語、デバッガー、ツールをインストールに追加して、開発ワークフローをサポートできます。VS Codeの豊富な拡張性モデルにより、拡張機能の作成者はVS Code UIに直接プラグインし、VS Codeが使用するものと同じAPIを通じて機能を提供できます。この記事では、Visual Studio Code MarketplaceからVS Codeの拡張機能を見つけ、インストールし、管理する方法について説明します。
拡張機能を参照する
VS Code内から拡張機能をブラウズしてインストールできます。VS Codeの横にあるアクティビティ バーの拡張機能アイコンをクリックするか、表示: 拡張機能コマンド (⇧⌘X (Windows、Linux では Ctrl+Shift+X)) を使用して、拡張機能ビューを表示します。
これにより、VS Code Marketplaceで最も人気のあるVS Code拡張機能のリストが表示されます。
リスト内の各拡張機能には、簡単な説明、発行元、ダウンロード数、5つ星評価が含まれています。拡張機能の項目を選択すると、詳細ページが表示され、さらに詳しく知ることができます。
お使いのコンピューターのインターネットアクセスがプロキシサーバーを経由している場合は、プロキシサーバーを設定する必要があります。詳細はプロキシサーバーのサポートを参照してください。
拡張機能をインストールする
拡張機能をインストールするには、インストールボタンを選択します。インストールが完了すると、インストールボタンは管理歯車ボタンに変わります。
拡張機能はVS Code自体と同じ権限を持ちます。VS Codeリリース1.97以降、サードパーティの発行元から初めて拡張機能をインストールする際に、VS Codeは拡張機能の発行元を信頼するかどうかを確認するダイアログを表示します。拡張機能のランタイムセキュリティと、悪意のある拡張機能から身を守る方法についての詳細情報を入手してください。
拡張機能の特定のバージョンをインストールしたい場合は、拡張機能を右クリックして別のバージョンをインストールを選択します。その後、利用可能なリストからバージョンを選択できます。
設定の同期が有効になっている場合、拡張機能などのVS Codeの設定をマシン間で共有できます。拡張機能をインストールしてマシン間で同期しないようにするには、拡張機能を右クリックしてインストール (同期しない)を選択します。
拡張機能を見つけてインストールする
例として、人気のTODO Highlight拡張機能をインストールしてみましょう。この拡張機能は、ソースコード内の'TODO:'や'FIXME:'のようなテキストをハイライト表示し、未完了のセクションをすばやく見つけることができます。
拡張機能ビュー (⇧⌘X (Windows、Linuxでは Ctrl+Shift+X)) で、検索ボックスに 'todo' と入力して、タイトルやメタデータに 'todo' を含むMarketplaceの拡張機能に絞り込みます。リストにTODO Highlight拡張機能が表示されるはずです。
拡張機能は、その発行元IDと拡張機能IDによって一意に識別されます。TODO Highlight拡張機能を選択すると、拡張機能の詳細ページが表示され、そこで拡張機能ID (この場合は wayou.vscode-todo-highlight
) を見つけることができます。拡張機能IDを知っていると、似た名前の拡張機能が複数ある場合に便利です。
インストールボタンを選択すると、VS CodeがMarketplaceから拡張機能をダウンロードしてインストールします。インストールが完了すると、インストールボタンは管理歯車ボタンに置き換えられます。
TODO Highlight拡張機能の動作を確認するには、任意のソースコードファイルを開き、「TODO:」というテキストを追加すると、そのテキストがハイライト表示されます。
TODO Highlight拡張機能は、コマンドパレット (⇧⌘P (Windows、Linux では Ctrl+Shift+P)) で見つけられるTODO-Highlight: List highlighted annotationsとTODO-Highlight: Toggle highlightというコマンドを提供します。TODO-Highlight: Toggle highlightコマンドを使用すると、ハイライト表示をすばやく無効または有効にできます。
この拡張機能はまた、その動作を調整するための設定も提供しており、設定エディター (⌘, (Windows、Linuxでは Ctrl+,)) で見つけることができます。例えば、テキスト検索で大文字と小文字を区別しないようにしたい場合、Todohighlight: Is Case Sensitive設定のチェックを外すことができます。
拡張機能が必要な機能を提供しない場合は、いつでも管理ボタンのコンテキストメニューから拡張機能をアンインストールできます。
これは拡張機能をインストールして使用する方法の一例にすぎません。VS Code Marketplaceには、何百ものプログラミング言語とタスクをサポートする何千もの拡張機能があります。Java、Python、Go、C++の本格的な言語サポートから、GUIDを作成したり、カラーテーマを変更したり、エディターに仮想ペットを追加したりする単純な拡張機能まで、あらゆるものがあります。
拡張機能の詳細
拡張機能の詳細ページでは、拡張機能のREADMEを読み、拡張機能の以下を確認できます。
- 機能コントリビューション - 設定、コマンド、キーボードショートカット、言語文法、デバッガーなど、VS Codeへの拡張機能の追加機能。
- 変更ログ - 利用可能な場合、拡張機能リポジトリのCHANGELOG。
- 依存関係 - 拡張機能が他の拡張機能に依存しているかどうかをリストします。
拡張機能が拡張機能パックの場合、拡張機能パックセクションには、パックをインストールする際にどの拡張機能がインストールされるかが表示されます。拡張機能パックは、個別の拡張機能をまとめてバンドルし、一度に簡単にインストールできるようにします。
拡張機能ビューのフィルターとコマンド
拡張機能をフィルター コンテキストメニューを使用して拡張機能ビューをフィルターできます。
以下を表示するフィルターがあります
- 更新可能な古い拡張機能のリスト
- 現在有効/無効になっている拡張機能のリスト
- ワークスペースに基づいて推奨される拡張機能のリスト
- 世界的に人気のある拡張機能のリスト
拡張機能リストは、インストール数、評価、名前、公開日、または更新日で昇順または降順に並べ替えることができます。拡張機能の検索フィルターについては、後述で詳しく説明します。
...
表示とその他のアクション ボタンから、追加の拡張機能ビューコマンドを実行できます。
このコンテキストメニューを通じて、拡張機能の更新を制御したり、すべての拡張機能を有効または無効にしたり、問題のある拡張機能の動作を特定するための拡張機能バイセクトユーティリティを使用したりできます。
拡張機能を検索する
拡張機能ビューの上部にある検索ボックスをクリアし、探している拡張機能、ツール、またはプログラミング言語の名前を入力できます。
例えば、「python」と入力すると、Python言語拡張機能のリストが表示されます。
探している拡張機能の正確な識別子がわかっている場合は、@id:
プレフィックスを使用できます。例: @id:vue.volar
。さらに、結果をフィルタリングまたはソートするには、後述するフィルターおよびソートコマンドを使用できます。
プレリリース版の拡張機能をインストールする
拡張機能の発行元は、拡張機能のプレリリース版を提供することがあります。プレリリース版をインストールするには、インストールボタンのドロップダウンを選択し、プレリリース版をインストールを選択します。
拡張機能を管理する
VS Codeでは拡張機能の管理が簡単です。拡張機能ビュー、コマンドパレット(コマンドには拡張機能:プレフィックスが付いています)、またはコマンドラインスイッチを使用して、拡張機能のインストール、無効化、更新、アンインストールができます。
インストール済みの拡張機能を一覧表示する
デフォルトでは、拡張機能ビューには現在インストールされている拡張機能と、あなたに推奨されるすべての拡張機能が表示されます。コマンドパレット (⇧⌘P (Windows、LinuxではCtrl+Shift+P)) またはその他のアクション (...
) ドロップダウンメニュー > 表示 > インストール済みで利用できる拡張機能: インストール済みのビューにフォーカスコマンドを使用すると、検索ボックスのテキストをクリアし、無効化されたものを含むインストール済みのすべての拡張機能のリストを表示できます。
拡張機能をアンインストールする
拡張機能をアンインストールするには、拡張機能エントリの右側にある管理歯車ボタンを選択し、ドロップダウンメニューからアンインストールを選択します。これにより拡張機能がアンインストールされ、拡張機能ホストの再起動 (拡張機能の再起動) を促されます。
拡張機能を無効にする
拡張機能を永久に削除したくない場合は、代わりに拡張機能エントリの右側にある歯車ボタンをクリックして一時的に拡張機能を無効にすることができます。拡張機能をグローバルに無効にするか、現在のワークスペースでのみ無効にするかを選択できます。拡張機能を無効にした後、拡張機能ホストの再起動 (拡張機能の再起動) を促されます。
インストールされているすべての拡張機能をすばやく無効にしたい場合は、コマンドパレットとその他のアクション (...
) ドロップダウンメニューにインストール済みのすべての拡張機能を無効にするコマンドがあります。
拡張機能は、再有効化するまで、すべてのVS Codeセッションで無効のままです。
拡張機能を有効にする
同様に、拡張機能を無効にしている場合 (リストの無効セクションにあり、無効とマークされています)、ドロップダウンメニューの有効にするまたは有効にする (ワークスペース)コマンドで再有効化できます。
その他のアクション (...
) ドロップダウンメニューには、すべての拡張機能を有効にするコマンドもあります。
拡張機能の自動更新
VS Codeは拡張機能の更新をチェックし、自動的にインストールします。更新後、拡張機能ホストの再起動を促されます (拡張機能の再起動)。
拡張機能を手動で更新したい場合は、すべての拡張機能の自動更新を無効にするコマンドまたは拡張機能ビューの対応するアクションで自動更新を無効にできます。extensions.autoUpdate 設定を構成することもできます。自動更新を再度有効にするには、すべての拡張機能の自動更新を有効にするコマンドを使用します。
拡張機能を右クリックし、自動更新項目を切り替えることで、個々の拡張機能の自動更新を構成することもできます。
VS Codeに更新をチェックさせたくない場合は、extensions.autoCheckUpdates設定をfalseに設定できます。
拡張機能を手動で更新する
拡張機能の自動更新を無効にしている場合、@updates
フィルターを使用する古い拡張機能を表示コマンドを使って、拡張機能の更新をすばやく確認できます。これにより、現在インストールされている拡張機能で利用可能な更新が表示されます。
古い拡張機能の更新ボタンを選択します。更新がインストールされ、拡張機能ホストの再起動 (拡張機能の再起動) を促されます。すべての拡張機能を更新コマンドを使用して、すべての古い拡張機能を一度に更新することもできます。
更新の自動チェックも無効にしている場合は、拡張機能の更新を確認コマンドを使用して、どの拡張機能が更新できるかを確認できます。
推奨される拡張機能
推奨拡張機能を表示を使用して推奨される拡張機能のリストを見ることができます。これは @recommended
フィルターを設定します。拡張機能の推奨には次のいずれかがあります。
- ワークスペースの推奨 - 現在のワークスペースの他のユーザーによって推奨されます。
- その他の推奨 - 最近開いたファイルに基づいて推奨されます。
プロジェクト内の他のユーザーに推奨を提供する方法については、以下のセクションを参照してください。
推奨を無視する
推奨を無視するには、拡張機能の項目を選択して詳細ページを開き、次に管理歯車ボタンを選択してコンテキストメニューを表示します。推奨を無視メニュー項目を選択します。無視された推奨は、今後あなたに推奨されなくなります。
拡張機能の構成
VS Codeの拡張機能は、構成や要件が大きく異なる場合があります。一部の拡張機能はVS Codeに設定を提供し、これは設定エディターで変更できます。他の拡張機能には独自の構成ファイルがある場合があります。拡張機能には、コンパイラ、デバッガー、コマンドラインツールなどの追加コンポーネントのインストールとセットアップが必要な場合もあります。拡張機能のREADME(拡張機能ビューの詳細ページで表示可能)を参照するか、VS Code Marketplaceの拡張機能ページ(詳細ページで拡張機能名をクリック)にアクセスしてください。多くの拡張機能はオープンソースであり、Marketplaceページにリポジトリへのリンクがあります。
コマンドラインでの拡張機能管理
VS Codeの自動化と構成を容易にするために、コマンドラインから拡張機能を一覧表示、インストール、アンインストールすることが可能です。拡張機能を識別する際は、publisher.extension
の形式で完全な名前を指定します。例: ms-python.python
。
例
code --extensions-dir <dir>
Set the root path for extensions.
code --list-extensions
List the installed extensions.
code --show-versions
Show versions of installed extensions, when using --list-extension.
code --install-extension (<extension-id> | <extension-vsix-path>)
Installs an extension.
code --uninstall-extension (<extension-id>)
Uninstalls an extension.
code --enable-proposed-api (<extension-id>)
Enables proposed API features for extensions. Can receive one or more extension IDs to enable individually.
拡張機能IDは、拡張機能の詳細ページのMarketplace情報の下で確認できます。
拡張機能ビューのフィルター
拡張機能ビューの検索ボックスは、拡張機能の検索と管理に役立つフィルターをサポートしています。インストール済み拡張機能を表示や推奨拡張機能を表示コマンドを使用したことがあるなら、@installed
や@recommended
のようなフィルターを見たことがあるでしょう。また、人気度や評価でソートしたり、カテゴリ(例: 'Linters')やタグ(例: 'node')で検索したりできるフィルターも利用できます。拡張機能検索ボックスに@
と入力し、候補をナビゲートすることで、すべてのフィルターとソートコマンドの完全なリストを見ることができます。
以下は拡張機能ビューのフィルターの一部です
@builtin
- VS Codeに付属の拡張機能を表示します。種類 (プログラミング言語、テーマなど) ごとにグループ化されます。@deprecated
- 非推奨の拡張機能を表示します。@disabled
- 無効になっているインストール済み拡張機能を表示します。@enabled
- 有効になっているインストール済み拡張機能を表示します。拡張機能は個別に有効/無効にできます。@featured
- おすすめの拡張機能を表示します。@installed
- インストール済みの拡張機能を表示します。@popular
- 人気のある拡張機能を表示します。@recentlyPublished
- 最近Marketplaceで公開された拡張機能を表示します。@recommended
- 推奨される拡張機能を表示します。ワークスペース固有または一般用途としてグループ化されます。@updates
- 古くなったインストール済み拡張機能を表示します。Marketplaceで新しいバージョンが利用可能です。@workspaceUnsupported
- このワークスペースでサポートされていない拡張機能を表示します。@category
- 指定されたカテゴリに属する拡張機能を表示します。以下はサポートされているカテゴリの一部です。完全なリストについては、@category
と入力し、候補リストのオプションに従ってください。@category:themes
@category:formatters
@category:linters
@category:snippets
これらのフィルターは組み合わせることもできます。例えば、@installed @category:themes
を使用して、インストールされているすべてのテーマを表示します。
フィルターが指定されていない場合、拡張機能ビューには現在インストールされている拡張機能と推奨される拡張機能が表示されます。
並べ替え
@sort
フィルターを使用して拡張機能を並べ替えることができます。これには以下の値を指定できます
installs
- Marketplaceのインストール数で降順に並べ替えます。name
- 拡張機能名でアルファベット順に並べ替えます。publishedDate
- 拡張機能の公開日で並べ替えます。rating
- Marketplaceの評価 (1~5つ星) で降順に並べ替えます。updateDate
- 拡張機能の最終更新日で並べ替えます。
カテゴリとタグ
拡張機能は、その機能を説明するカテゴリとタグを設定できます。
category:
とtag:
を使用して、カテゴリとタグでフィルタリングできます。
サポートされているカテゴリは次のとおりです: [Azure, Data Science, Debuggers, Education, Extension Packs, Formatters, Keymaps, Language Packs, Linters, Machine Learning, Notebooks, Others, Programming Languages, SCM Providers, Snippets, Testing, Themes, Visualization]
。これらは拡張機能検索ボックスのIntelliSenseからアクセスできます。
カテゴリ名が複数の単語で構成されている場合(例: category:"SCM Providers"
)は、引用符で囲む必要があることに注意してください。
タグには任意の文字列を含めることができ、IntelliSenseでは提供されないため、Marketplaceで役立つタグを探してみてください。
VSIXからインストールする
.vsix
ファイルにパッケージ化されたVS Code拡張機能を手動でインストールできます。拡張機能ビューのコマンドドロップダウンにあるVSIXからインストールコマンド、またはコマンドパレットの拡張機能: VSIXからインストールコマンドを使用して、.vsix
ファイルを指定します。
VS Codeの--install-extension
コマンドラインスイッチを使用して、.vsix
ファイルへのパスを指定してインストールすることもできます。
code --install-extension myextension.vsix
コマンドラインで--install-extension
を複数回指定して、一度に複数の拡張機能をインストールできます。
VSIX経由で拡張機能をインストールすると、その拡張機能の自動更新はデフォルトで無効になります。
拡張機能のパッケージ化と公開について詳しく知りたい場合は、拡張機能APIの拡張機能の公開の記事を参照してください。
ワークスペースで推奨される拡張機能
適切な拡張機能のセットは、特定のワークスペースやプログラミング言語での作業をより生産的にし、このリストをチームや同僚と共有したいと思うことがよくあります。拡張機能: 推奨拡張機能の構成 (ワークスペースフォルダ) コマンドを使用して、ワークスペースの推奨拡張機能のリストを作成できます。
単一フォルダのワークスペースでは、このコマンドはワークスペースの .vscode
フォルダ内に extensions.json
ファイルを作成し、そこに拡張機能の識別子 ({publisherName}.{extensionName}) のリストを追加できます。
複数ルートワークスペースでは、コマンドは .code-workspace
ファイルを開き、extensions.recommendations
の下に拡張機能をリストアップできます。拡張機能: 推奨拡張機能の構成 (ワークスペースフォルダ) コマンドを使用して、複数ルートワークスペース内の個々のフォルダに拡張機能の推奨を追加することもできます。
extensions.json
の例は次のようになります。
{
"recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
}
これはリンター拡張機能とコードフォーマッター拡張機能を推奨しています。
拡張機能は、発行元識別子と拡張機能識別子 publisher.extension
を使用して識別されます。この名前は拡張機能の詳細ページで確認できます。VS Codeはこれらのファイル内でインストール済みの拡張機能に対して自動補完を提供します。
.
VS Codeは、ワークスペースが初めて開かれたときに、推奨される拡張機能をインストールするようにユーザーに促します。ユーザーは拡張機能: 推奨拡張機能を表示コマンドでリストを確認することもできます。
次のステップ
興味深いと思われるトピックをいくつか紹介します...
- 拡張機能 API - VS Code 拡張機能 API について学び始めましょう。
- 最初の拡張機能 - 簡単な Hello World 拡張機能の作成を試してみましょう。
- Marketplace への公開 - 独自の拡張機能を VS Code Marketplace に公開しましょう。
よくある質問
拡張機能はどこにインストールされますか?
拡張機能は、ユーザーごとの拡張機能フォルダにインストールされます。プラットフォームに応じて、場所は次のフォルダになります
- Windows
%USERPROFILE%\.vscode\extensions
- macOS
~/.vscode/extensions
- Linux
~/.vscode/extensions
--extensions-dir <dir>
コマンドライン オプションを指定して VS Code を起動することで、場所を変更できます。
または、VSCODE_EXTENSIONS
環境変数を拡張機能をインストールしたい場所に設定することもできます。これは、ユーザーのマシンに拡張機能がインストールされる場所を中央で管理したいエンタープライズ環境で役立ちます。
拡張機能をインストールしようとすると、必ず connect ETIMEDOUT エラーが発生します
お使いのマシンがプロキシサーバー経由でインターネットにアクセスしている場合、このエラーが表示されることがあります。詳細については、セットアップトピックのプロキシサーバーのサポートセクションを参照してください。
Marketplaceから直接拡張機能をダウンロードできますか?
一部のユーザーは、Marketplaceから一度拡張機能をダウンロードし、ローカル共有から複数のVS Codeインスタンスにインストールすることを好みます。これは、接続性の問題がある場合や、開発チームが固定の拡張機能セットを使用したい場合に便利です。
拡張機能をダウンロードするには、拡張機能ビューで検索し、結果から拡張機能を右クリックして、VSIX をダウンロードまたは特定のバージョンの VSIX をダウンロードを選択します。
VS Codeが拡張機能の推奨を表示しないようにすることはできますか?
はい、VS Codeが拡張機能ビューや通知で拡張機能の推奨を表示しないようにしたい場合は、以下の設定を変更できます
- extensions.showRecommendationsOnlyOnDemand - trueに設定すると、推奨セクションが削除されます。
- extensions.ignoreRecommendations - trueに設定すると、拡張機能の推奨通知が非表示になります。
推奨を見たい場合は、推奨拡張機能を表示コマンドがいつでも利用可能です。
Marketplaceの拡張機能は信頼できますか?
Visual Studio Marketplaceは悪意のある拡張機能からあなたを守るためにいくつかの対策を講じています。また、インストールする前に拡張機能が信頼できるかどうかを判断するために、さまざまな手順を実行することもできます。
VS Codeリリース1.97以降、サードパーティの発行元から初めて拡張機能をインストールする際に、VS Codeは拡張機能の発行元を信頼するかどうかを確認するダイアログを表示します。
拡張機能のランタイムセキュリティに関する詳細情報を入手してください。
拡張機能の署名をVS Codeで検証できません
Visual Studio Marketplaceは、すべての拡張機能が公開される際に署名します。VS Codeは拡張機能をインストールする際にこの署名を検証し、拡張機能パッケージの完全性とソースを確認します。
拡張機能をインストールする際、「Visual Studio Codeが拡張機能の署名を検証できないため、拡張機能をインストールできません」というエラーメッセージが表示されることがあります。このエラーはさまざまな原因で発生する可能性があり、このエラーに遭遇した場合は、 comunque インストールを決定する前に注意が必要です。拡張機能の署名検証を無効にするには、extensions.verifySignature設定を使用します。
パッケージの整合性の問題
パッケージの整合性の問題については、Visual Studio Marketplaceチームに連絡して問題を報告することをお勧めします。拡張機能IDを必ず含めてください。以下のリストは、パッケージの整合性の問題に関連するエラーコードを示しています。
PackageIntegrityCheckFailed
SignatureIsInvalid
SignatureManifestIsInvalid
SignatureIntegrityCheckFailed
EntryIsMissing
EntryIsTampered
Untrusted
CertificateRevoked
SignatureIsNotValid
SignatureArchiveHasTooManyEntries
NotSigned
その他の問題
サポートされていない環境や不明な理由など、その他の問題については、VS Codeで問題を報告することをお勧めします。必要な情報をすべて提供し、共有ログを含めてください: ⇧⌘P (Windows、Linux では Ctrl+Shift+P) > ビューを開く... > 共有。
リモートウィンドウに接続すると拡張機能が同期されません
設定の同期により、設定、キーボードショートカット、インストール済み拡張機能などのVisual Studio Codeの構成をマシン間で共有できるため、常にお気に入りのセットアップで作業できます。
VS Codeは、SSH、開発コンテナー(devcontainer)、またはWSLに接続しているときなど、リモートウィンドウとの間で拡張機能を同期しません。
組織内で特定の拡張機能を許可またはブロックすることはできますか?
extensions.allowed
アプリケーション設定を構成することで、組織内でインストールできる拡張機能を制御できます。設定が構成されていない場合、すべての拡張機能が許可されます。設定が構成されている場合、リストされていないすべての拡張機能のインストールがブロックされます。
許可された拡張機能の構成に関する詳細情報を入手してください。