拡張機能 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 で構築されたカスタム Web ページを表示する Webview を作成する - Webview ガイド
- 新しいプログラミング言語をサポートする - 言語拡張機能の概要
- 特定のランタイムのデバッグをサポートする - デバッガー拡張機能ガイド
拡張機能 API のより包括的な概要を知りたい場合は、拡張機能の機能概要ページを参照してください。拡張機能ガイドの概要には、さまざまな拡張機能 API の使用法を示すコードサンプルとガイドのリストも含まれています。
拡張機能の構築方法
優れた拡張機能を構築するには、多くの時間と労力がかかることがあります。API ドキュメントの各セクションがどのように役立つかを以下に示します。
- はじめにでは、Hello World サンプルを使って、拡張機能構築の基本的な概念を学びます。
- 拡張機能の機能では、VS Code の広大な API をより小さなカテゴリに分類し、より詳細なトピックを案内します。
- 拡張機能ガイドには、VS Code 拡張機能 API の特定の使用法を説明するガイドとコードサンプルが含まれています。
- UX ガイドラインでは、拡張機能で優れたユーザー体験を提供するためのベストプラクティスを紹介します。
- 言語拡張機能では、ガイドとコードサンプルを用いて、プログラミング言語のサポートを追加する方法を説明します。
- テストと公開には、拡張機能のテストや公開など、さまざまな拡張機能開発トピックに関する詳細なガイドが含まれています。
- 高度なトピックでは、拡張機能ホスト、リモート開発と GitHub Codespaces のサポート、Proposed API などの高度な概念を説明します。
- リファレンスには、VS Code API、Contribution Points、およびその他多くのトピックに関する網羅的なリファレンスが含まれています。
新着情報
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 で新しい issue を作成してください。回答が見つからない拡張機能に関する質問や、VS Code 拡張機能 API に関する問題がある場合は、Microsoft/vscode で新しい issue をオープンしてください。