モバイル拡張機能のインストール

モバイル拡張機能を使用するには、lwc-dev-mobile Salesforce CLI プラグインをインストールします。インストールしたら、それを使用して必要な Android および iOS 設定を確認します。プラグインで問題が検出されると、コマンド出力に環境を修正する方法のヒントが表示されます。環境が設定されたら、コマンドラインまたは Visual Studio Code からコンポーネントをプレビューします。

モバイル拡張機能プラグインには、いくつかのツールがあります。

設定

force:lightning:local:setup を実行して、仮想モバイルデバイス (iOS シミュレータおよび Android エミュレータ) をローカル環境に設定します。モバイル拡張機能には、iOS および Android 用の事前設定されたデフォルトの仮想デバイスが用意されています。

プレビュー

force:lightning:lwc:preview を実行して、仮想モバイルデバイスでコンポーネントをプレビューします。デフォルトのデバイスか、自分で設定したデバイスのいずれかを選択できます。モバイル拡張機能では、仮想デバイス設定の追加および取り消しを行うことができます。プラグインにより、仮想デバイスのデフォルトブラウザでコンポーネントのプレビューが表示されます。このプレビューは Playground として機能し、コンポーネントのコードに適用した視覚的な変更はすぐに反映されます。

デバイスのリストの表示

force:lightning:local:device:list を実行すると、マシン上でモバイル拡張機能プラグインにより検出された仮装デバイスのリストが表示されます。

  1. Salesforce CLI を開発マシンにインストールしていない場合は、「Salesforce CLI のインストール」を参照してください。

  2. モバイル拡張機能プラグインをインストールします。

    プラグインがデジタル署名されていないことを示すメッセージが表示されると思われますが、問題はありません。

  3. インストールを続行するように求められた場合、「y」と入力します。

  4. 使用可能なコマンドを表示するには、grep と sfdx commands を使用します。たとえば、setup コマンドは force:lightning:local トピックにありますが、preview コマンドは force:lightning:lwc トピックにあります。

    使用可能なコマンドの構文を表示するには、--help 引数を指定して各コマンドをコールします。次に例を示します。

開発環境がモバイル拡張機能の要件を満たしていることを確認するには、setup コマンドを実行します。このコマンドでは、モバイルプラットフォームライブラリ、ツール、仮想デバイス設定の存在やバージョンをチェックする一連のテストが実行されます。コマンドで問題が検出されると、問題を解決するためのヒントがターミナルコンソールまたは Windows コマンドプロンプトに出力されます。

Android または iOS 設定を確認するには、次のコマンドを実行します。

  • -p、--platform: 検証するモバイルプラットフォーム。Android または iOS (大文字と小文字は区別されない) のいずれかになります。
  • 他の 2 つのパラメータ (--json および --loglevel) は、Salesforce CLI の標準規則であるため、setup 機能には含まれません。

Android 設定を確認するには、このコマンドを実行します。

設定が正しい場合、このコマンドのすべてのテストで「Passed」の状況が出力されます。Android でコンポーネントのプレビューを開始する準備ができました。

テストに失敗した場合は、コンソールに出力された提案を実行して、Android 環境の設定を完了させます。設定手順については、「Android Studio の設定」を参照してください。

setup コマンドを実行し、すべてのテストが「合格」になるまで、コンソールの指示に従います。

iOS 設定を確認するには、このコマンドを実行します。

設定が正しい場合、このコマンドのすべてのテストで「Passed」の状況が出力されます。iOS でコンポーネントのプレビューを開始する準備ができました。

テストに失敗した場合は、コンソールに出力された提案を実行して、iOS 環境の設定を完了させます。設定手順については、「Xcode の設定」を参照してください。

setup コマンドを実行し、すべてのテストが「合格」になるまで、コンソールの指示に従います。

モバイル拡張機能で使用できるデバイスを表示するには、次のコマンドを使用します。

  • -p、--platform: 検証するモバイルプラットフォーム。Android または iOS (大文字と小文字は区別されない) のいずれかになります。
  • このプレビューコマンドでは、インストールされている任意のシミュレータを選択できます。ただし、すべての仮装デバイスでプレビューのパフォーマンスが保証されるわけではありません。
  • iOS の場合、このコマンドで生成されたリストでは、「デバイス名, iOS_runtime バージョン」の形式が使用されます。
  • Android の場合、このコマンドで生成されたリストでは、「デバイス名, デバイス種別, Android ランタイムバージョン」の形式が使用されます。
  • Android の場合、開発環境変数が適切に設定されていない場合、このコマンドでは空のリストが返されます。

モバイル拡張機能の要件を満たすことが保証される iOS または Android デバイスを作成するには、次のコマンドを使用します:

-n、--devicename

新しい仮装デバイスの名前。指定した名前がマシンですでに使用されている場合、コマンドは失敗し、説明的なエラーが表示されます。既存のデバイス名のリストを表示するには、force:lightning:local:device:list コマンドを使用します。

-d、--devicetype

仮装デバイスの種別。コマンドでデバイス種別エントリが認識されない場合、結果のエラーメッセージで提供されたリストから 1 つを選択します。次に例を示します。

  • Android:

  • iOS:

-p、--platform

検証するモバイルプラットフォーム。Android または iOS (大文字と小文字は区別されない) のいずれかになります。

-l、--apilevel

(省略可能、Android のみ) 新しいデバイスの Android API レベル。デフォルト値は、インストールされている最新の API レベルです。iOS デバイスでは使用されません。

--json および --loglevel は、Salesforce CLI の標準規則であるため、setup 機能には含まれません。

このコマンドは、force:lightning:local:setup コマンドを実行することで開始されます。そのコマンドでエラーが報告された場合、最初に報告された失敗に対処し、force:create コマンドを再試行します。

すでにマシンに存在するデバイス名を指定した場合、コマンドは終了し、「A virtual device with the name '<existing_name>' already exists. (「<existing_name>」という名前の仮装デバイスはすでに存在します。)」というメッセージが表示されます。

仮装デバイスを起動するには、次のコマンドを使用します。

-p、--platform

対象デバイスのモバイルプラットフォーム。Android または iOS (大文字と小文字は区別されない) のいずれかになります。

-t、--target

起動する仮装デバイスの名前。

-w、--writablesystem

(省略可能、Android のみ) 値を受け入れません。存在する場合、仮装デバイスは書き込み可能なシステムで起動されます。存在しない場合、システムは参照のみです。

--json および --loglevel は、Salesforce CLI の標準規則であるため、setup 機能には含まれません。

設定の検証が正常に完了したら、仮想モバイルデバイスでコンポーネントをプレビューできます。モバイル拡張機能では、次の 2 種類の方法でプレビューを起動できます。