スコープとファイルの色
スコープ 
は、プロジェクト内のファイルとフォルダーの名前付きセットです。 スコープを使用すると、さまざまな IDE 表示のproject項目を 視覚的に区別し 、特定の操作範囲を制限できます。
スコープを使用すると、ファイルを論理的に整理できます。 たとえば、テストソースをテストスコープに配置し、本番環境のコードを本番環境スコープに配置することができます。 これにより、大スコーププロジェクトでの作業が容易になります。 インスペクションをテストのみで実行すると、コードベース全体で実行するよりも高速になります。
PhpStorm には 定義済みのスコープ が付属していますが、独自のスコープを作成することもできます。 カスタムスコープには、たとえば自分が担当するプロジェクトの一部のみなど、任意のファイルセットを含めることができます。
PhpStorm では、スコープは さまざまな機能で使用されます。例えば、コードインスペクション、一部のリファクタリング、検索、コピーライト設定、コード解析などの機能です。
PhpStorm には、ローカルと共有の 2 種類のスコープがあります。
ローカルスコープ は IDE 構成ディレクトリに格納されているため、VCS を通じて共有されず、チームの他のメンバーは使用できません。
projectが バージョン管理されている場合は、共有スコープを使用することは理にかなっています。 VCS を使用しない場合は、ローカルスコープで十分です。
新しいスコープを定義する
PhpStorm には一連の 定義済みスコープがありますが、独自のスコープを定義することもできます。
Ctrl+Alt+S を押して設定を開き、 を選択します。
「スコープの追加 」ボタン (
) をクリックし、定義するスコープの種類 (ローカルまたは 共有) を選択します。後で VCS で共有する チェックボックスを使用して、選択したスコープの状態（ローカルまたは共有）を変更できます。
開いたダイアログで、新しいスコープに名前を付け、 OK をクリックします。
新しいスコープにファイルを追加します。 projectツリーで必要な項目を選択し、ツリーの右側にあるオプションのいずれかをクリックします。
含める: 選択したアイテムを含めます。 フォルダーを含める場合、このアクションはこのフォルダー内にあるファイルのみを追加します。 ネストされたすべてのサブフォルダーとその内容は含まれません。
再帰的に含める: ネストされたサブフォルダーとその内容とともに、選択したフォルダーを含めます。
除外: 選択したアイテムをスコープから除外します。 フォルダーを除外する場合、このアクションはこのフォルダー内にあるファイルのみを削除します。 ネストされたすべてのサブフォルダーとその内容はスコープに残ります。
再帰的に除外する: 選択したフォルダーをネストされたサブフォルダーとその内容と共に除外します。
スコープにファイルを追加すると、PhpStorm は式を作成し、それを Pattern フィールドに表示します。
ボタンを使用する代わりに、 スコープ言語構文リファレンスを使用して、 Pattern フィールドにパターンを手動で入力することもできます。
変更を適用し、ダイアログを閉じます。
選択した範囲で表示されるファイルとフォルダーは、含まれているものと含まれていないものを理解するのに役立つように、さまざまな色で表示されます。
スコープに含まれるファイルとフォルダー。
除外されたファイルとフォルダーと包含されたファイルとフォルダーの両方を含むフォルダー。
選択した範囲から除外されるファイルとフォルダー。
カスタムスコープを作成すると、 Project ツールウィンドウと、アクションを適用するファイルの数を制限できる すべてのダイアログでそのスコープを見つけることができます。
定義済みのスコープ
PhpStorm は、事前定義されたスコープのセットを提供します。 IDE は、ファイルに関する情報に基づいて、これらのスコープにファイルを自動的に追加します。 これらのスコープは変更できないことに注意してください。
定義済みスコープのリスト
プロジェクトファイル: projectコンテンツルート内のすべてのファイルが含まれます。 詳細については、 個別のファイルを適用するを参照してください。 ライブラリおよびフレームワークはこの範囲に含まれません。
問題: 構文エラーのあるprojectコンテンツルート内のファイルが含まれます。
すべての変更ファイル: 最近変更されたすべてのファイルが含まれます。
すべての変更ファイル: エディターで開いたり変更した最後の 50 個のファイルが含まれます。 最近のファイルの数を変更するには、 Ctrl+Alt+S を押して設定を開き、 詳細設定 を選択して、 最近使用したファイルの最大数 フィールドを検索し、希望する数を指定します。
Git によって追跡されるプロジェクトファイル: Git でバージョン管理されているすべてのプロジェクトファイルが含まれます。
Git-Ignored を除くプロジェクトファイル:
.gitignoreで指定されたファイルを除き、Git でバージョン管理されているファイルとバージョン管理されていないファイルの両方を含むすべてのプロジェクトファイルが含まれます。テスト: このスコープは、プロジェクトテストソースルートに限定されます。
開いているファイル: 現在エディターで開いているファイルが含まれます。
ローカルの変更 (これらのスコープは、 VCS 統合が有効になっているの場合に表示されます)
すべての変更ファイル: すべての変更リストから VCS にまだ追加されていない変更を含む変更されたファイルが含まれます。
デフォルト変更リスト: Default 変更リストから VCS にまだ追加されていない変更を含む変更されたファイルが含まれます。
「変更リスト名」: 特定のカスタム変更リストから VCS にまだ追加されていない変更が加えられた変更済みファイルが含まれます。
スコープを色に関連付ける
異なるスコープに属するファイルは、検索結果、エディタータブ、 Project ツールウィンドウ (Alt+1) で異なる色でハイライトできます。
各スコープに、独自の色を割り当てることができます。 例: 開いているファイル スコープに色を割り当て、 Project ツールウィンドウにこの色を表示するように IDE を構成できます。 この場合、エディターで現在作業しているファイルは、プロジェクトツリーで色分けされます。 これにより、projectのナビゲーションがより速く簡単になります。 ファイルの色はスコープに関連してのみ機能することに注意してください。
スコープと同様に、色の関連付けは ローカルで 共有できます。
ローカル色 はあなただけに表示され、VCS を通じて共有されません。
新しい色の関連付けを作成する
Ctrl+Alt+S を押して設定を開き、 を選択します。
ファイルカラーを有効にする のチェックボックスが選択されていることを確認してから、色を使用する場所を選択します： エディタータブで使用する または プロジェクトビューで使用する を選択します。
プロジェクトビューで使用する チェックボックスを選択すると、 Project ツールウィンドウ (Alt+1) と検索結果 (たとえば、 複数ファイル内検索 ダイアログ Ctrl+Shift+F) に色が表示されます。
追加 ボタン (
) をクリックし、色を設定するスコープを選択します。事前定義されたスコープの 1 つを選択するか、 カスタムスコープを使用できます。
必要なスコープの横にある矢印
をクリックし、開いたリストから色を選択します。独自の色を構成するには、 カスタム をクリックします。
色を編集するには、 色 列で必要なスコープに対応するセルをクリックし、リストから新しい色を選択します。
VCS を介して色を 共有するには、 VCS で共有する 列の対応する行のチェックボックスを選択します。 チェックボックスがオフの場合、色は ローカルで使用されます。
変更を適用し、ダイアログを閉じます。
ファイルが複数のスコープに含まれている場合、スコープの順序が重要になります: PhpStorm はローカルスコープから始めて、上から下へスコープを処理します。 つまり、IDE はリスト内の最後のスコープの色をそのようなファイルに適用します。
IntelliJ IDEA で色の関連付けを別の順序で処理する場合は、スコープの順序を変更できます。
スコープの順序を変更する
Ctrl+Alt+S を押して設定を開き、 を選択します。
移動するスコープを選択し、 上へ移動 (
) または 下へ移動 (
) ボタンをクリックします。 または、 Alt+Up または Alt+Down を押します。変更を適用し、ダイアログを閉じます。
スコープ言語構文リファレンス
説明 | Pattern | Example |
|---|---|---|
名前で単一のファイルを含める |
|
|
サブディレクトリなしで、ディレクトリ内のすべてのファイルのセットを含める |
|
|
サブディレクトリを持つディレクトリにすべてのファイルのセットを含める |
|
|
特定のプロジェクトからの名前でファイルを含める |
|
|
使用可能な論理演算子 &&·(AND)、||·(OR)、!·(NOT)。 |
|
|
サンプル
file:*.php||file:*.twig: すべての PHP と Twig ファイルを含みます。file:*php&&!file:*test*.php: 名前に文字列testを含むものを除くすべての PHP ファイルを含めます。file:www/wp-content/themes/my-site-child//*.php||file:www/wp-content/themes/my-site-child//*.css||file:www/wp-content/themes/my-site-child//*.js||file:www/wp-content/plugins/my-site//*.php||file:www/wp-content/plugins/my-site//*.css||file:www/wp-content/plugins/my-site//*.js: WordPress Web サイトのテーマとプラグインからのすべての .PHP、.CSS、.JS ファイルを含めます。file:*.js||file:*.coffee: すべての JavaScript と CoffeeScript ファイルを含みます。file:*js&&!file:*.min.*:min拡張子で示されるminによって生成されたものを除くすべての JavaScript ファイルを含めます。
スコープのユースケース
次の例は、日常業務でスコープを使用する方法を示しています：
特定のファイルグループのみをインスペクトします。
スコープを使うことで、コードベースの特定部分をインスペクトできます。 たとえば、本番コードとテストコードを分けてインスペクトできます。 さらに、最近変更されたファイルに異なるインスペクション設定を適用して、新しい変更部分がより厳密にチェックされるようにできます。
インスペクションを実行する の詳細を参照してください。
検索と置換の結果を制限します。
スコープは 複数ファイル内検索 機能や 複数ファイル内置換 機能と組み合わせることで、無関係な結果を減らし、リファクタリングの速度を向上させられます。
プロジェクト内のターゲットを検索 の詳細を参照してください。
ナビゲーションにスコープを利用します。
Project ツールウィンドウで、スコープによりナビゲーションも簡略化できます。 必要なスコープを選択すれば、今必要な項目だけを含んだ簡易ツリーを作成できます。
プロジェクトツールウィンドウ の詳細を参照してください。
特定のファイルのみを整形します。
スコープを使うことで、現在のファイルやコードベース全体だけでなく、特定のファイルを整形できます。 たとえば、コードを変更した後、最近変更されたファイルを整形してコードスタイルの要件に適合させられます。
コードの整形 の詳細を参照してください。
異なるファイルセットごとに異なるコピーライト通知を設定できます。
これは、プロジェクト内のファイルの著作権者が異なる場合や、サードパーティ・オープンソースプロジェクト由来のファイルで元のコピーライトを維持したい場合など、様々な状況で役立ちます。
Copyright の詳細を参照してください。