拡張機能 API
Visual Studio Code は拡張性を考慮して構築されています。UI から編集エクスペリエンスまで、VS Code のほぼすべての部分を Extension API を通じてカスタマイズおよび拡張できます。実際、VS Code の多くのコア機能は拡張機能として構築されており、同じ Extension API を使用しています。
このドキュメントでは、以下について説明します。
- 拡張機能のビルド、実行、デバッグ、テスト、および公開方法
- VS Code の豊富な Extension API を活用する方法
- 開始に役立つガイドとコードサンプルの入手先
- ベストプラクティスに関するUX ガイドライン
コードサンプルは、Microsoft/vscode-extension-samples で入手できます。
公開されている拡張機能をお探しの場合は、VS Code 拡張機能 Marketplace にアクセスしてください。
拡張機能で何ができるか
Extension API で実現できることの例をいくつかご紹介します。
- カラーテーマまたはファイルアイコンテーマで VS Code の外観を変更する - テーマ
- UI にカスタムコンポーネントとビューを追加する - ワークベンチの拡張
- HTML/CSS/JS で構築されたカスタム Web ページを表示する Webview を作成する - Webview ガイド
- 新しいプログラミング言語をサポートする - 言語拡張機能の概要
- 特定のランタイムのデバッグをサポートする - デバッガー拡張機能ガイド
Extension API のより包括的な概要を知りたい場合は、拡張機能の機能の概要ページを参照してください。拡張機能ガイドの概要には、さまざまな Extension API の使用方法を示すコードサンプルとガイドのリストも含まれています。
拡張機能の作成方法
優れた拡張機能を構築するには、多くの時間と労力がかかる場合があります。API ドキュメントの各セクションが役立つ内容を以下に示します。
- はじめにでは、Hello World サンプルを使用した拡張機能の構築に関する基本的な概念を説明します。
- 拡張機能の機能では、VS Code の広大な API をより小さなカテゴリに分解し、より詳細なトピックを紹介します。
- 拡張機能ガイドには、VS Code Extension API の特定の用途を説明するガイドとコードサンプルが含まれています。
- UX ガイドラインでは、拡張機能で優れたユーザーエクスペリエンスを提供するためのベストプラクティスを紹介します。
- 言語拡張機能では、ガイドとコードサンプルを使用してプログラミング言語のサポートを追加する方法を示します。
- テストと公開には、テストや公開拡張機能など、さまざまな拡張機能開発トピックに関する詳細なガイドが含まれています。
- 高度なトピックでは、拡張機能ホスト、リモート開発と GitHub Codespaces のサポート、Proposed API などの高度な概念について説明します。
- リファレンスには、VS Code API、Contribution Points、およびその他の多くのトピックに関する詳細なリファレンスが含まれています。
新機能
VS Code は毎月更新され、Extension API にも適用されます。VS Code 拡張機能の機能と範囲を拡大するために、新機能と API が毎月利用可能になります。
Extension 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 Extension API に関する問題がある場合は、Microsoft/vscode で新しい issue を開いてください。