概要
最新版のVisualStudio CodeでSalesforce開発環境を構築する手順を残したいと思います
長年、Eclipseを開発環境として使っていましたが、Salesforce DXの登場でEclipse版の開発終了?で対応するAPIバージョンが古い状況です
開発コンソールもありますが、ソースコードのバージョン管理や使い勝手などを含めて考えると手元に開発環境があると便利です
構築手順
こちらをおすすめします!
下記ではサードパーティー製の拡張機能の導入手順になりますが、
Salesforce公式拡張機能を用いた開発手順「Visual Studio CodeでSalesforceの開発環境を構築する」をおすすめします!
公式拡張機能を用いた開発手順の補足
VS CodeのRemote Containerに対応しましたので、導入手順は「リモート開発 - コンテナ」になります。
公式手順のため、丁寧に解説されているので、導入手順は割愛します。
※注意点としてはDockerfileのベースイメージがlatestタグになっているので扱う時は要注意!
Remote Containerとは何かというと、開発環境(Salesforceに限らず)で必要な環境一式(JDK、拡張機能など)をコンテナに閉じ込めることで、誰でもボタン一つで開発環境を導入することができるようになります。また、壊れても容易に環境を再構築できるのがメリットです。
上記の理由により下記は読んでも役に立たないと思います。
1. ForceCodeの導入
VS Codeの拡張機能で「ForceCode」(2018.12.26時点で3.11.3)と検索してインストールすると古いバージョン(2018.9.25時点で3.6.3)が表示されるので、リポジトリから最新バージョン(2018.9.25時点で3.9.1)を取得します
※プロジェクトがマージされたようです
https://github.com/daishi4u/ForceCode のルートにある「forcecode-x.x.x.vsix」をローカルにダウンロードし、拡張機能の「VSIXからインストール」でインストールできます
※ForceCode 0.x.x版では最新版のVS Codeに対応していないが、上記のリポジトリは0.x.x版からForkして機能拡張されたバージョンになっています(Salesforce DX経由)
インストール後はVS Codeの「再読み込み」を実施すると適用されます
ついでに「Salesforce Extension Pack」もインストールすることで、コードに色がつき見やすくなります
2. ログイン
- メニューの「表示」-「コマンドパレット」-「ForceCode: ForceCode Menu」を選択
- 接続する組織では「New Org」を選択
- 組織種別では「本番組織(Production/Developer)」か「Sandbox」を選択
- 保存方法では「自動保存(Yes)」か「手動保存(No)」を選択
- OAuthによる認証のため、ブラウザが起動し、接続先の組織にログインし、当プラグインからの接続を許可
※旧バージョンのForceCodeでは自動生成されるforce.jsonに認証情報が保存されていましたが、OAuthになったことでセキュリティが向上しました - 認証が完了次第以下のようなファイルが生成されます
3. ForceCode Menuを開く
設定完了後に下部に「ForceCode Menu」が表示されます
当メニューで様々な機能を実行できます
詳細は割愛させて頂きます
機能紹介
組織からソースを取得
既存のpackage.xmlがある場合は、srcフォルダ配下にpackage.xmlを配置し、ForceCode Menuで「Retrieve Package/Metadata」で組織のコードがローカルに反映されます
package.xmlがない場合は、手で作るか、retrieve時に取得したいパッケージを選択すると生成されます
※0.x.x版の**「Refresh from server」はメニュー上に表示されるが機能しない**ので、「Retrieve Package」を使用してください
変更通知
今まで同一組織で複数人が同時開発していた際に、組織のコードとローカルのコードに差異が発生しているかはローカルに組織のコードを取得されるまではわかりませんでしたが、当プラグインでは組織のコードに変更があった際にリアルタイムで通知してくれる機能があります。検知した際には「組織のコードをローカルに反映」、「Diffを確認」、「無視」の操作が選べます
デフォルトで無効になっているので、.forceCode/接続アカウント名/setting.json
のcheckForFileChanges
をtrueに変更すること