拡張機能 API
Visual Studio Code は、拡張性を念頭に置いて構築されています。UI から編集体験まで、VS Code のほとんどすべての部分は、拡張機能 API を通じてカスタマイズおよび強化できます。実際、VS Code の多くのコア機能は拡張機能として構築されており、同じ拡張機能 API を使用しています。
このドキュメントでは、次のことを説明します。
- 拡張機能の構築、実行、デバッグ、テスト、公開方法
- VS Code の豊富な拡張機能 API の活用方法
- 開始に役立つガイドやコードサンプルの探し方
- ベストプラクティスについては、UX ガイドラインに従ってください。
コードサンプルはMicrosoft/vscode-extension-samplesで入手できます。
公開されている拡張機能をお探しの場合は、VS Code 拡張機能マーケットプレイスにアクセスしてください。
拡張機能で何ができるか?
拡張機能 API で実現できることの例をいくつか示します。
- 配色テーマやファイルアイコンテーマで VS Code の外観を変更する - テーマ設定
- UI にカスタムコンポーネントやビューを追加する - ワークベンチの拡張
- HTML/CSS/JS で構築されたカスタムウェブページを表示する Webview を作成する - Webview ガイド
- 新しいプログラミング言語をサポートする - 言語拡張機能の概要
- 特定のランタイムのデバッグをサポートする - デバッガー拡張機能ガイド
拡張機能 API のより包括的な概要については、拡張機能の機能概要ページを参照してください。拡張機能ガイドの概要には、さまざまな拡張機能 API の使用法を示すコードサンプルとガイドのリストも含まれています。
拡張機能の構築方法
優れた拡張機能の構築には、多くの時間と労力が必要です。API ドキュメントの各セクションは、次のことを支援します。
- はじめにでは、Hello World サンプルを使用して拡張機能を構築するための基本的な概念を説明します。
- 拡張機能の機能では、VS Code の広範な API を小さなカテゴリに分類し、より詳細なトピックに誘導します。
- 拡張機能ガイドには、VS Code 拡張機能 API の特定の用途を説明するガイドとコードサンプルが含まれています。
- UX ガイドラインでは、拡張機能で優れたユーザーエクスペリエンスを提供するためのベストプラクティスを紹介しています。
- 言語拡張機能では、ガイドとコードサンプルを使用してプログラミング言語のサポートを追加する方法を説明しています。
- テストと公開には、拡張機能のテストや公開など、さまざまな拡張機能開発トピックに関する詳細なガイドが含まれています。
- 高度なトピックでは、拡張ホスト、リモート開発と GitHub Codespaces のサポート、提案された API などの高度な概念を説明しています。
- リファレンスには、VS Code API、貢献点、その他多くのトピックに関する網羅的なリファレンスが含まれています。
新機能
VS Code は毎月更新され、拡張機能 API も同様です。VS Code 拡張機能の能力と範囲を広げるために、毎月新しい機能と API が利用可能になります。
拡張機能 API の最新情報を入手するには、毎月のリリースノートを確認してください。リリースノートには、次の専用セクションがあります。
- 拡張機能の作成 - 最新リリースで利用可能な新しい拡張機能 API を学習します。
- 提案された拡張機能 API - 今後の提案された API を確認し、フィードバックを提供します。
ヘルプを求める
拡張機能開発に関する質問がある場合は、次の場所で質問してみてください。
- VS Code Discussions: VS Code の拡張プラットフォームについて議論し、質問し、コミュニティの他のメンバーを助け、回答を得るための GitHub コミュニティ。
- Stack Overflow:
vscode-extensionsのタグが付いた何千もの質問があり、その半分以上はすでに回答されています。あなたの問題を検索し、質問し、または VS Code 拡張機能開発の質問に答えることで、他の開発者を助けてください! - VS Code Dev Slack: 拡張機能開発者向けの公開チャットルーム。VS Code チームのメンバーもよく会話に参加しています。
ドキュメントに関するフィードバックを提供するには、Microsoft/vscode-docs で新しいイシューを作成してください。回答が見つからない拡張機能に関する質問や、VS Code 拡張機能 API に関する問題がある場合は、Microsoft/vscode で新しいイシューを開いてください。