Salesforce DX 開発者ガイド
j同期または変換時のソースの除外方法
ローカルファイルシステムとスクラッチ組織の間でメタデータを同期するとき、ソースファイルを除外する必要が生じる場合があります。同様に、ソースを Salesforce DX プロジェクト形式に変換するとき、特定のファイルを除外する必要が生じることがあります。どちらの場合も、.forceignore ファイルを使用して個々のファイルまたはディレクトリ内のすべてのファイルを除外できます。
任意のテキストエディタを使用して .forceignore ファイルを作成し、除外するファイルまたはディレクトリを指定します。「dot」で開始するソースファイルまたはディレクトリ (.DS_Store など) はデフォルトで除外されます。
force:source:push、force:source:pull、および force:source:status が実行されるとき、.forceignore ファイルによって ファイルが除外されます。source:status の場合、リモートの変更が .forceignore ファイルのエントリに対してチェックされます。たとえば、サーバに HelloWorld.cls というクラスを追加し、.forceignore にはファイル名が一致するエントリ (HelloWorld.cls や HelloWorld.* など) を追加したとします。source:status の出力では HelloWorld.cls が除外されます。
.forceignore を配置する場所
.forceignore ファイルが機能するためには、実行するコマンドに応じて適切な場所に配置する必要があります。
- force:source:push の場合、.forceignore ファイルをプロジェクトのルートに追加します。
- force:mdapi:convert の場合、ファイルをメタデータ retrieve ディレクトリ (package.xml を含む) に追加します。
.forceignore のサンプル構文
.forceignore ファイルには .gitignore と似た機能があります。次は除外するソースを示すオプションです。すべてのパスは、プロジェクトルートディレクトリに対する相対パスです。
1# Specify a relative path to a directory from the project root
2helloWorld/main/default/classes
3
4# Specify a wildcard directory - any directory named “classes” is excluded
5**classes
6
7# Specify file extensions
8**.cls
9**.pdf
10
11# Specify a specific file
12helloWorld/main/default/HelloWorld.cls