Salesforce DX プロジェクトの設定
サンプルリポジトリには、CLI または IDE を使用してプロジェクトを作成するためのサンプルの sfdx-project.json ファイルが用意されています。
独自のソースを使用してこのファイルを確認することをお勧めします。
1{
2"packageDirectories" : [
3 { "path": "force-app", "default": true},
4 { "path" : "unpackaged" },
5 { "path" : "utils" }
6 ],
7"namespace": "",
8"sfdcLoginUrl" : "https://login.salesforce.com",
9"sourceApiVersion": "42.0"
10}次のパラメータは手動で編集できます。
- oauthLocalPort
- デフォルトでは、OAuth ポートは 1717 です。ただし、このポートがすでに使用中の場合は変更します。また JWT ベース認証をサポートするために Dev Hub 組織に接続アプリケーションを作成することを計画します。さらに、「接続アプリケーションの作成」の手順に従ってコールバック URL を変更します。
- packageDirectories
-
パッケージディレクトリは、スクラッチ組織との間でソースを同期するときにターゲットとなるディレクトリを示します。これらのディレクトリには、管理パッケージ、未管理パッケージのソース、または Ant ツールや変更セットなどのパッケージ化されていないソースを含めることができます。
パッケージディレクトリを使用する場合は、次の点に注意してください。
- パッケージディレクトリの場所は、プロジェクトからの相対パスです。絶対パスを指定しないでください。次の 2 つは同等です。
1"path": "helloWorld" 2"path" : "./helloWorld" - デフォルトパスは 1 つだけ指定できます (パッケージディレクトリ)。パスが 1 つしかない場合は、それがデフォルトであるとみなされるため、明示的に default パラメータを設定する必要はありません。複数のパスがある場合は、どれがデフォルトであるかを指定する必要があります。
- CLI は、スクラッチ組織の変更を取得してローカルプロジェクトを同期するときのターゲットディレクトリとしてデフォルトのパッケージディレクトリを使用します。このデフォルトパスは、第二世代パッケージを作成するときにも使用されます。
- 出力ディレクトリを指定しない場合、デフォルトのパッケージディレクトリはソース変換中にファイルが保存される場所にもなります。ソース変換は、メタデータ API 形式から Salesforce DX プロジェクト形式へとプロジェクト形式からメタデータ API 形式への両方があります。
- パッケージディレクトリの場所は、プロジェクトからの相対パスです。絶対パスを指定しないでください。次の 2 つは同等です。
- namespace
-
パッケージで使用されるグローバル名前空間です。名前空間は、Dev Hub 組織に関連付けられている組織に登録されている必要があります。この名前空間は、org:create コマンドで作成されたスクラッチ組織に割り当てられています。開発者制御パッケージ (DCP) を作成する場合、名前空間なしでパッケージを作成するオプションがあります。
- sfdcLoginUrl
-
force:auth が使用するログイン URL です。デフォルトは、login.salesforce.com です。ユーザを特定の Salesforce インスタンスに認証する場合は、デフォルト値を上書きします。たとえば、Sandbox 組織に認証するには、このパラメータを test.salesforce.com に設定します。
ここでデフォルトのログイン URL を指定しない場合や、プロジェクトの外部で force:auth を実行した場合は、組織を認証するときにインスタンス URL を指定します。
- sourceApiVersion
-
ソースに互換性がある API のバージョンです。SourceApiVersion によって、各メタデータ型で取得される項目が決まります。たとえば、API バージョン 14.0 の CustomTab には icon 項目が追加されました。バージョン 13.0 以前のコンポーネントを取得する場合、コンポーネントには icon 項目は含まれません。