この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Salesforce DX プロジェクトの設定

プロジェクト設定ファイル sfdx-project.json は、ディレクトリが Salesforce DX プロジェクトであることを示しています。設定ファイルには、プロジェクトの情報が含まれ、スクラッチ組織の認証と第二世代パッケージの作成が容易になります。また、プロジェクトとスクラッチ組織の同期時にファイルを保存する場所を CLI に指示します。

サンプルリポジトリには、CLI または VS コード向け拡張機能を使用してプロジェクトを作成するためのサンプルの 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": "44.0"
10}

次のパラメータは手動で編集できます。

oauthLocalPort (省略可能)

デフォルトでは、OAuth ポートは 1717 です。ただし、このポートがすでに使用中の場合は変更します。また JWT ベース認証をサポートするために Dev Hub 組織に接続アプリケーションを作成することを計画します。さらに、「接続アプリケーションの作成」の手順に従ってコールバック URL を変更します。

packageDirectories (必須)

パッケージディレクトリは、スクラッチ組織との間でソースを同期するときに対象となるディレクトリを示します。これらのディレクトリには、管理パッケージ、未管理パッケージのソース、または Ant ツールや変更セットなどのパッケージ化されていないソースを含めることができます。

パッケージディレクトリを使用する場合は、次の点に注意してください。

パッケージディレクトリの場所は、プロジェクトからの相対パスです。絶対パスを指定しないでください。次の 2 つは同等です。
1"path": "helloWorld" 2"path" : "./helloWorld"
デフォルトパスは 1 つだけ指定できます (パッケージディレクトリ)。パスが 1 つしかない場合は、それがデフォルトであるとみなされるため、明示的に default パラメータを設定する必要はありません。複数のパスがある場合は、どれがデフォルトであるかを指定する必要があります。
CLI は、スクラッチ組織の変更を取得してローカルプロジェクトを同期するときの対象ディレクトリとしてデフォルトのパッケージディレクトリを使用します。このデフォルトパスは、第二世代パッケージを作成するときにも使用されます。
出力ディレクトリを指定しない場合、デフォルトのパッケージディレクトリはソース変換中にファイルが保存される場所にもなります。ソース変換は、メタデータ形式からソース形式へとソース形式からメタデータ形式への両方があります。

plugins (省略可能)

Salesforce プラグインジェネレータを使用して開発したプラグインを Salesforce DX プロジェクトで使用するには、sfdx-project.json ファイルに plugins セクションを追加します。このセクションで、プラグインの動作を変更するための設定値と設定を追加します。

1"plugins": {
2  "yourPluginName": {
3    "timeOutValue": "2"
4  },
5  "yourOtherPluginName": {
6    "yourCustomProperty": true
7  }
8}

プロジェクトのソース制御に含める値についてのみ、設定値を保存します。これらの設定値は、開発チーム全体に影響を与えます。

namespace (省略可能)

パッケージで使用されるグローバル名前空間です。名前空間は、Dev Hub 組織に関連付けられている組織に登録されている必要があります。この名前空間は、org:create コマンドで作成されたスクラッチ組織に割り当てられています。ロック解除済みパッケージを作成する場合、名前空間なしでパッケージを作成するオプションがあります。

Salesforce に名前空間を登録してから、登録した名前空間を持つ組織を Dev Hub 組織に接続します。

重要

sfdcLoginUrl (省略可能)

force:auth が使用するログイン URL です。指定��ない場合のデフォルトは login.salesforce.com です。特定の Salesforce インスタンスに対してユーザを認証したい場合は、デフォルト値に優先する値を指定してください。たとえば、Sandbox 組織に対して認証する場合は、このパラメータを test.salesforce.com に設定してください。

ここでデフォルトのログイン URL を指定しない場合や、プロジェクトの外部で force:auth を実行した場合は、組織を認証するときにインスタンス URL を指定します。

sourceApiVersion (省略可能)

ソースに互換性がある API のバージョンです。デフォルトは Salesforce CLI と同じバージョンです。

sourceApiVersion によって、source:push、source:pull、source:convert 中に取得される各メタデータ型の項目が決まります。最近のリリースで変更されたメタデータ型を使用している場合、この項目は重要です。(メタデータソースのバージョンを指定したい場合があるため)。たとえば、API バージョン 14.0 の CustomTab には icon 項目が追加されました。バージョン 13.0 以前のコンポーネントを取得する場合、コンポーネントに icon 項目が含まれていないため、source コマンドを実行するとエラーが表示されます。

このプロジェクト設定値を同じような名前の apiVersion CLI ランタイム設定値と混同しないようにしてください。

Salesforce DX 開発者ガイド

Salesforce DX プロジェクトの設定

関連項目: