Visual Studio Code での GitHub プルリクエスト
2018年9月10日 Kenneth Auchenberg, @auchenberg
他の多くのオープンソースプロジェクトと同様に、Visual Studio Code コミュニティは、修正や新機能を実装するためにプルリクエストを通じて協力しています。昨年の春から、私たちのチームは、Visual Studio Code 内から直接 GitHub プルリクエストを共同作業、コメント、レビュー、検証できるように、新しい統合プルリクエストエクスペリエンスを提供するために取り組んできました。
本日、Visual Studio Code 用 GitHub プルリクエストのパブリックプレビューを発表します。これにより、私たちや何百万人ものエンジニアが日々経験しているワークフローのギャップ、つまり、ソースコードが書かれた場所、エディター内でソースコードをレビューする機能が埋められます。
プルリクエストのレビューと管理
新しい GitHub Pull Requests 拡張機能は、Visual Studio Code 内からプルリクエスト (PR) のレビューと管理を支援するように設計されており、以下が含まれます。
- Visual Studio Code を認証して GitHub に接続する機能。
- Visual Studio Code 内から PR を一覧表示および参照する。
- Markdown サポートによるエディター内コメントなど、エディター内で PR を操作する。
- 定義へ移動や IntelliSense などの豊富な言語機能のために、新しいローカルの
checkout and run
ワークフローを使用して、エディターから PR を検証する。 - Visual Studio Code UI と
git
などのコマンドラインツールが共存できるように、ターミナルを統合する。
GitHub との連携
昨年、プルリクエストを Visual Studio Code に導入するための広範な取り組みの一環として、多くのパートナーに働きかけました。GitHub Editor チームがすでに同様のことを考えていることを知った後、4 月から協力して Visual Studio Code で新しいプルリクエストエクスペリエンスを作成し始めました。新しい Visual Studio Code 拡張機能 API のセットを通じて、Visual Studio Code に直接統合されたプルリクエストを作成およびレビューするための新しい拡張機能を開発しました。
より自然な PR エクスペリエンス
今日、ソースコードをレビューする際、私たちの多くは、変更点を別のエディターで表示する簡略化された Web インターフェースまたはサードパーティのレビューツールを使用するために、エディターを離れざるを得ません。これにより、変更点の視覚的な概要を簡単に把握できますが、ほとんどの場合、変更がどこで行われたか、周囲のソースコードにどのように影響するかについての完全なコンテキストはありません。通常のコーディング環境の外にいるということは、お気に入りのキーボードショートカット、テーマ、カスタマイズがないことも意味します。さらに重要なことは、レビューしている変更が実際に期待どおりに機能することを検証するために、ソースコードをナビゲートする力を持つ環境がないことを意味します。
新しいプルリクエスト拡張機能は、Visual Studio Code のソース管理ビュー内に新しい [プルリクエスト] エクスプローラーを導入することで、これを変えます。ここでは、プルリクエストを参照および操作できます。
新しいオープン拡張機能 API
当社の新しいプルリクエストエクスペリエンスは、Visual Studio Code 拡張機能の作成者がプルリクエストとその関連メタデータを管理する拡張機能を作成できるようにする、一連の拡張機能 API によって強化されています。このオープンな拡張機能モデルは、プルリクエストプロバイダーが既存のソース管理プロバイダーと同様に機能し、誰でも Visual Studio Code 用の拡張機能を記述して、プラットフォームでホストされているソースコードをレビューするためのエディター内コメント機能と機能を提供できることを意味します。新しい API の詳細については、2018 年 8 月のリリースノートをご覧ください。
ご興味があれば、新しい API の導入方法、および拡張機能 API プロセスの詳細について詳しく読むことができます。
今後の展望
プルリクエストを Visual Studio Code に導入することに興奮しています。これにより、ソースコードのレビュー方法が簡素化されると信じているからです。当社の GitHub 拡張機能は、Visual Studio Code でコードレビュー用のソース管理プラットフォームプロバイダーを統合する最初の例にすぎません。
Visual Studio Code 用 GitHub プルリクエストのパブリックプレビューをお試しください。そしていつものように、フィードバックをお待ちしておりますので、GitHub または Twitter の @code までお気軽にご連絡ください。
もう 1 つお知らせです。本日、Azure DevOps と、GitHub Marketplace で新しい Azure Pipelines 拡張機能もリリースします。詳細については、https://aka.ms/azurecicd をご覧ください。
Kenneth Auchenberg (Microsoft), Rachel Macfarlane (Microsoft), Kai Maetzel (Microsoft), Peng Lyu (Microsoft) , Sarah Guthals (GitHub) および Andreia Gaita (GitHub)
そして Visual Studio Code チームを代表して
Happy Coding!