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