Salesforce DX 開発者ガイド
jSalesforce DX プロジェクトの作成
Salesforce DX プロジェクトには特定の構造と設定ファイルがあります。設定ファイルは、ディレクトリを Salesforce DX プロジェクトとして指定します。
プロジェクトを作成する前に、組織ベースとパッケージベースのどちらのプロジェクト開発モデルを使用するかを決めてください。
組織ベースの開発を行う場合は、DX プロジェクトを配置するディレクトリに変更します。その後、force:project:create -n MyProject --manifest を実行して、デフォルトのマニフェスト (package.xml) ファイルを使用してプロジェクトを生成します。
パッケージベースの開発を行う場合は、最小 (empty) または拡張 (standard) スキャフォールディングでプロジェクトを作成できます。デフォルトは standard であり、これにより組織でのソースの移動を促進する拡張スキャフォールディングが提供されます。- DX プロジェクトを配置するディレクトリに変更します。
-
DX プロジェクトを作成します。
出力ディレクトリを指定しない場合、プロジェクトディレクトリは現在の場所に作成されます。また、スクラッチ組織との間でソースを同期するときに対象となるデフォルトのパッケージディレクトリも指定できます。デフォルトのパッケージディレクトリを指定しない場合、このコマンドによってデフォルトのパッケージディレクトリ force-app が作成されます。
1force:project:create -n MyProjectテンプレートの種類を選択しない場合、デフォルトは --template standard です。標準テンプレートでは、完全なディレクトリ構造が提供され、ソースの配置位置について推測する必要がなくなります。さらに、VS Code 向け Salesforce 拡張機能を使用した際に特に有効な、次のファイルも提供されます。
- .gitignore: バージョン管理に Git を使い始めることが容易になります。
- .prettierrc および .prettierignore: Prettier を使用した Aura コンポーネントの書式設定の開始が容易になります。
- .vscode/extensions.json: Visual Studio Code を起動したときに、プロジェクトに推奨される拡張機能をインストールするようユーザに促します。
- .vscode/launch.json: Replay Debugger を設定して、検出可能性と使いやすさを向上します。
- .vscode/settings.json: デフォルトで、このファイルには保存時に転送またはリリースする設定が 1 つあり、false に設定されています。この値を変更したり、他の設定を追加したりできます。
--template empty を選択すると、使用を開始できるように、プロジェクトに次のサンプル設定ファイルが含まれます。
- .forceignore
- config/project-scratch-def.json
- sfdx-project.json
- package.json
--template analytics を選択すると、役に立つ VS Code ファイルがすべて提供されますが、プロジェクトスキャフォールディングに含まれるディレクトリは /force-app/main/default/waveTemplates のみになります。
例
1sfdx force:project:create --projectname mywork --template standard1sfdx force:project:create --projectname mywork --defaultpackagedir myapp次のステップ:
- (省略可能) 名前空間を Dev Hub 組織に登録します。
- プロジェクトを設定します (sfdx-project.json)。名前空間を使用する場合、それを含めるようにこのファイルを更新します。
- 開発で使用する別の組織 (Sandbox 組織、パッケージ化組織、本番組織など) の形状を模倣するスクラッチ組織を生成するスクラッチ組織定義を作成します。新しいプロジェクトの config ディレクトリには、スクラッチ組織定義ファイルのサンプル (project-scratch-def.json) が含まれています。