Visual Studio Code開発環境で役立つエクステンション機能について（その１）

今回は、Salesforceの開発環境についてのお話です。

2019年10月12日をもって、Eclipse の Force.com IDE プラグインのサポートが終了しました。

参照：Salesforce Spring '19 リリースノート　2019 年 10 月に廃止される Force.com IDE
https://releasenotes.docs.salesforce.com/ja-jp/spring19/release-notes/rn_vscode_forcecom_ide_retirement.htm

Salesforce開発環境は今後、 Visual Studio Code が中心になるようシフトしていくものと考えられます。

Visual Studio Code 自体も頻繁なアップデートで機能拡張が繰り返されており、Salesforceの開発環境は日々目まぐるしく進化しています。

今回は、Salesforce開発環境の構築において一助となる Visual Studio Code のエクステンションと、その機能について、いくつかご紹介したいと思います。

※以下の内容は、Windows10 環境を前提とし、すべて本稿執筆時点（2019/10/03）のバージョンでのものとなります。

Salesforce公式のエクステンションの詰め合わせです。
Visual Studio CodeでSalesforceの開発を行うにはもちろんこれを入れなければ始まらないのですが、今回はこのエクステンションから覚えておきたい機能についてご紹介します。


※未導入の方は弊社のこちらの過去記事を参照してください。

Apexクラスファイルの編集中にショートカットキー「Ctrl+Space」でコードのインテリセンス機能が呼び出せますが、初期状態で何もしないままではオブジェクト名などは十分に補完してくれません。

あらかじめオブジェクトのメタ情報を取得しておくことで、オブジェクトのフィールド名も補完させることができます。

コマンドパレットから「SFDX:Refresh SObject Definitions」コマンドを実行します。

情報を取得するオブジェクト範囲を指定します。
全て、標準のみ、カスタムのみから選択可能です。

コマンド実行後、組織からオブジェクトの情報が読み込まれ、完了後オブジェクトの補完が可能になります。

※オブジェクト情報取得後は一度 Visual Studio Code を再起動した方がよさそうです。

組織でオブジェクトに項目の追加があった際などは、再度コマンドを実行して再取得します。


オブジェクトの情報はワークスペース内の「tools＞sobjects」フォルダ下にクラスファイルとして保存されています。

本機能は執筆時点（2019/10/03）ではベータ機能で提供されています。

Apexコードの編集中、右クリックメニューから「SFDX:Diff File Against Org」コマンドが選べるようになっています。メニューには表示されていますがベータ機能のため、利用する際は自分でコマンドをインストールする必要があります。

下記の手順にてコマンドを追加します。
Salesforce Extension Pack 本体が正しくインストールされていることが前提条件となります。

下記のコマンドをコマンドプロンプトから実行します。

Visual Studio Code を開いているならばターミナルから実行するとよいでしょう。

コマンド実行すると確認されますので「y」を押します。

しばらくするとインストールが完了します。

インストールに成功すると右クリックメニューからコマンドを実施することで、サーバー側のファイルとの差分比較を行うことが可能となります。ApexクラスファイルだけでなくVisualForceページや、メタファイルについても比較が可能となっています。

複数名のエンジニアで同時にApex開発を行っている場合、ほかの誰かにソースの変更を行われていても気づかないまま組織にデプロイしてしまい、せっかくのコードを上書きしてしまうことが時折発生します。

この機能を活用して、デプロイを行う直前に必ず比較する習慣を身に着けておくのがよいでしょう。

いかがでしたでしょうか。

Salesforce Extension Pack は現在、だいたい週1ペースでバージョンアップされています。
思いもよらぬ強力な機能が追加されていることもありますので、かかさずバージョンアップの内容についてはチェックしておくのがよいと思います。


次回からはSalesforce公式以外のエクステンションをご紹介します。それでは！