リモート開発 - コンテナ

リモート開発 - コンテナ

概要

Salesforce Extension for VS Code は、リモート開発をサポートし、コンテナをフル機能の開発環境として利用することができます。コンテナにマウントされたプロジェクトを開いて、完全なコード補完、コードナビゲーション、デバッグなどを使用して編集することができます。

注意: リモート開発機能は現在ベータ版です。バグを発見したかフィードバックがある場合は、GitHub に issue をオープンしてください。

リモート開発についての詳細を理解するには、VS Code のドキュメントを参照してください。

インストール

開発コンテナでリモート開発を開始するには、以下をインストールします。

  • Docker Desktop。システム要件とインストール手順については、以下を参照してください。
  • VS Code の最新版
  • VS Code Remote Development Extension Pack の最新版 VS Code と Docker Desktop を OS にインストール後、
    • Windows の場合、コンテナで開きたいソースコードの場所を設定してください。Docker で右クリックし、 Settings / Preferences > Shared Drives / File Sharing を選択します。共有がうまくいかない場合は、Container tips を参照してください。
    • Linux の場合、supported platforms を参照してください。ターミナルから、sudo usermod -aG docker $USER を実行して、ユーザを docker グループに追加します。この設定は、一度サインアウトして再度ログインした後に有効になります。
  • Salesforce Extension Pack の最新版

サンプルプロジェクトで開発コンテナを試す

サンプルプロジェクトを使用して、Salesforce Extension が備わった Docker コンテナでリモート開発を試してみましょう。

  1. サンプルリポジトリをクローンします。サンプルプロジェクト内の .devcontainer フォルダには、開発コンテナの設定方法や使用する Dockerfile、インストールする拡張機能を定義した devcontainer.json ファイルが格納されています。詳細については、Creating a devcontainer.json file および devcontainer.json reference を参照してください。
  2. コマンドパレットから Remote-Containers: Open Folder in Container を実行しクローンしたプロジェクトを開きます。VS Code は、プロジェクトを初めて開いたときに開発コンテナを作成します。開発コンテナが作成されると、ローカルシステム内のプロジェクトフォルダがコンテナに自動的に接続、マップされ、サイドバーには Dev Container: Salesforce Project が表示されます。コンテナでは、Java、Git、Salesforce CLI、および devcontainer.json ファイルで定義された他のすべての拡張機能がプリインストールされ設定されます。

    開発コンテナ

  3. コマンドパレットから、SFDX:Authorize a Dev Hub (SFDX: Dev Hub を認証) をコンテナで実行します。出力パネル (エディタ領域の下) から、認証を完了するために必要なユーザコードと検証 URL を取得することができます。 Dev Hub として認証したくない組織にログインしている場合は、必ずログアウトしてください。そうしないと、認証したい組織の認証情報を入力するプロンプトが表示されません。 認証が完了すると、SFDX: Authorize a Dev Hub successfully ran というメッセージが表示されます。成功メッセージが表示されない場合は、正しいユーザコードを入力しているかどうかを確認してから再度実行してください。ログインページでコードの再入力を促されない場合は、コマンドを終了して再度実行してください。もし興味がある場合は、デバイス認証フロー を参照してください。 認証成功のメッセージ
  4. SFDX: Create a Default Scratch Org (SFDX: デフォルトのスクラッチ組織を作成) を実行します。

    これでコンテナをフル機能の開発環境として使用できるようになりました。

開発コンテナでプロジェクトを開く

  1. 作業したい既存のプロジェクトを開くか、新しいプロジェクトを作成ます。
  2. コマンドパレットから、Remote-Container: Add Development Container Configuration Files を実行します。 このコマンドが表示されない場合は、VS Code Remote Development Extension Pack の最新版をインストールしていることを確認してください。 開発コンテナの設定ファイルを追加
  3. テンプレートの一覧から Salesforce Project を選択し、SFDX .devcontainer フォルダを追加します。VS Code では開発コンテナの設定ファイルが検出され、コンテナ内のプロジェクトフォルダを再度開くように促されます。
  4. Reopen in Container をクリックして、開発コンテナをビルドします。これでサイドバーには Dev Container: Salesforce Project と表示されます。

    既存のプロジェクトの開発コンテナを設定して、フルタイムの開発環境として使用できるようになりました。

参考 (VS Code のドキュメント):

Feedback or Bugs | Edit this Article