Salesforceの開発でVS Code（Visual Studio Code）を使用するエンジニアの方は多いと思います。
私もVS Codeは頻繁に使用するのですが、PJが変わって新しい端末でVS Codeの初期設定をする際、毎度手順を忘れてしまいます。
そこで今回は、VS CodeインストールからSalesforce組織との接続・メタデータの取得までの手順を備忘録として書き留めておこうと思います。
また、VS Codeの設定がうまくいかない時の対処法もいくつか記載していますので困った時は参考にしてみてください。
① Visual Studio Codeのインストール
まずは以下のリンクからVS Codeのインストーラーをダウンロードします。
Windowsの方はWindows版を、Macの方はMac版をダウンロードします。
ダウンロードしたexeファイルをダブルクリックして実行します。
「同意する」を選択します。
インストール先を指定します。（特に指定のない場合、デフォルトのパスでOKです。）
スタートメニューのフォルダを指定します。（特に指定のない場合、デフォルトのフォルダでOKです。）
「デスクトップ上にアイコンの作成する」にチェックを入れます。（ご自由に）
インストールします。
インストール完了です。
「Visual Studio Codeを実行する」にチェックを入れて「完了」を押すと、VS Codeが立ち上がります。
② JDK11のインストール
VS Codeの使用には「JDK 11 」が必要になります。（JDK8でもよさそう。）
JDK 11 がインストールされているか
まず端末にJDK 11 が備わっているか確認します。
スタートメニューの検索窓に「コマンドプロンプト」と入力し、コマンドプロンプトを開きます。
以下のコマンドをコピー&ペーストしエンターキーを押します。
javac -versionインストールされていれば次のように表示されます。
インストールされていない場合、「javacは～認識されていません。」とメッセージが表示されます。
JDK 11 のインストール方法
Oracleのホームページからダンロードしてもよいのですが、
以下のSalesforceのヘルプ記事からZulu OpenJDK をダウンロード・インストールできます。
OpenJDK version 11 のダウンロードおよびインストール
Salesforceを使用しているとデータローダもセットで使うことが多いので、いつもこちらのサイトからインストールしています。
手順についてもヘルプ記事内で詳しく解説されているので参考にしてみてください。
③ Salesforce CLIのインストール
続いて「Salesforce CLI」をインストールします。
Salesforce CLIは、VS CodeとSalesforce組織を接続するために必要なソフトです。
OSを選択しインストーラーをダウンロードします。
ダウンロードしたexeファイルをダブルクリックして実行します。
「Next」を押します。
インストール先を指定し、インストールします。（デフォルトのパスでOKです。）
インストール完了です。
④ VS Codeの設定
続いてVS Codeの設定です。
VS Codeの画面左端のツールバーから「拡張機能」を選択し、「Salesforce Extension Pack」を検索 ⇒ インストール
Salesforce Extension PackとはSalesforce公式のVS Codeで使える拡張機能の詰め合わせです。
これらは開発で必須なので最初にインストールしておきましょう。
VS Codeのデフォルトの言語は英語です。
日本語に翻訳するために、「Japanese Language Pack for Visual Studio Code」拡張機能をインストールします。
「Ctrl」+「Shift」+「p」でコマンドパレットを開き、「SFDX」と入力し、
「SFDX：マニフェストを使用してプロジェクトを作成」を選択します。
「標準」を選択します。
任意のプロジェクト名を入力します。
プロジェクトの作成先を指定し、プロジェクトを作成します。
プロジェクトが作成されます。
この段階ではまだSalesforce組織と接続していないため左下に「デフォルトの組織が未設定」と表示されます。
⑤ Salesforce組織との接続
続いて、VS CodeをSalesforce組織と接続します。
組織を接続させることで組織のソースコードを取得し、編集（開発）し、組織に反映させることができます。
「Ctrl」+「Shift」+「p」でコマンドパレットを開き、「SFDX」と入力し、
「SFDX：組織を認証」を選択します。
「私のドメイン」を使用しているSandboxであれば、「カスタム」を、使用していないSandboxであれば、「Sandbox」を選択。
※本記事では「カスタム」を選択。
SalesforceのログインURLを入力し、エンターキーを押します。
組織につける任意の名称を入力し、エンターキーを押します。
ブラウザが立ち上がりSalesforceログイン画面に遷移します。
ログイン情報を入力し、ログインします。
画面右下に「組織を認証が正常に実行されました。」と表示されます。
画面左下には接続した組織名（先ほど設定した組織の名称）が表示されます。
接続がうまくいかない場合は、こちら
⑥ メタデータの取得
組織と接続できたら、次は組織のメタデータを取得してみましょう。
メタデータとは、データをより詳細に説明してくれる情報です。
例えば、Salesforceの項目のメタデータであれば、表示ラベルやAPI参照名、データ型や項目レベルセキュリティ設定などが挙げられます。
まず、VS Codeの画面左端のツールバーから「拡張機能」から
「Salesforce Package.xml Generator Extension for VS Code」を検索しインストールします。
「Ctrl」+「Shift」+「p」でコマンドパレットを開き、「SFDX」と入力し、
「SFDX：Package.xml Generator: Choose Metadata Components」を選択します。
「Metadata Types」からPackage.xmlに追加したいデータを選択し、「UPDATE PACKAGE.XML」をクリックします。
AboデフォルトのPackage.xmlにはオブジェクや項目情報が含まれていないため必要なデータはここで自身で追加しましょう！
続いて、「package.xml」を右クリックし、「SFDX：マニフェストファイルのソースを組織から取得」を選択します。
うまくいかない時の対処法
ここまでVS Codeのインストールからメタデータの取得までの手順をお伝えしてきましたが、中にはうまくいかなかった方もいるかと思います。
そのほとんどが、「組織との接続」もしくは「メタデータの取得」でうまくいかないという状態かと。
そこでいくつか対処法をご紹介します。
No.1から順に試してみてください。
No.1：VS Codeの再起動
VS Codeを閉じて再起動します。
これで解決することも案外多いです。
No.2：VS Codeのプロキシ設定
プロキシサーバーを使用している場合は、VS Codeでプロキシ設定を行います。
画面右下の設定マークから「設定」を選択します。
設定画面が開くので、画面右上のファイルマークをクリックします。
jsonファイルの中にプロキシサーバーのIPアドレスとポート番号を以下の形式で入力し、ファイルを保存します。
No.3：環境変数の設定
端末の環境変数の設定を行います。
スタートメニューの検索窓で「環境変数」と検索し、「環境変数を編集」を選択します。
ユーザ環境変数に「JAVA＿HOME」を追加し、JDKのパスを指定します。
続いて、上記画像の「Path」を選択し、「編集」ボタンを押します。
以下の2行を新規で追加します。
No.4：Salesforce CLIの再インストール
まだ、VS Codeがうまく動かない場合は、Salesforce CLIをアンインストールし、再度インストールしてみてください。
これでうまくいったことも何度かあります。
No.5：VS Codeのインストール
最後の手段ですが、VS Codeをアンインストールし、再度インストールします。
正直面倒くさいですが、やるしかないですね。
これでもうまくいかない場合は先輩に相談してみてください。。。
【おわりに】
VS Codeの初期設定はうまくいかない時も多いですよね。
対処法は他にもいくつかあると思いますので、ぜひ参考程度に受け取っていただけると幸いです。
また、今回はVS Codeのさまざまな拡張機能についてはお伝えしませんでしたが、開発をする上で非常に便利な機能が多々ありますのでそちらもぜひチェックしてみてください。
そちらもまた記事にしようかなと思います～
終わりです。
コメント