ソリューション エクスプローラーでのファイルの入れ子

ソリューション エクスプローラーでは、関連ファイルを入れ子にして、それらを整理し、見つけやすくしています。 たとえば、Windows フォーム フォームをプロジェクトに追加すると、フォームのコード ファイルは ソリューション エクスプローラーのフォームの下に入れ子になります。 .NET Core (および .NET 5 以降) プロジェクトでは、ファイルの入れ子をさらに一歩進めることができます。 ファイルの入れ子のプリセット (Off、 Default、 Web) から選択できます。 また、ファイルの入れ子の方法をカスタマイズしたり、ソリューション固有およびプロジェクト固有の設定を作成したりすることもできます。

注

Visual Studio 2022 バージョン 17.2 以前では、この機能は ASP.NET Core プロジェクトでのみサポートされていました。 バージョン 17.3 以降では、.NET を対象とするすべてのプロジェクトでファイルの入れ子がサポートされています。

ファイルの入れ子オプション

カスタマイズされていないファイルの入れ子に使用できるオプションは次のとおりです。

• オフ: このオプションを選択すると、入れ子にすることなくファイルのフラット リストが表示されます。

• 既定値: このオプションでは、 ソリューション エクスプローラーでの既定のファイル入れ子動作が提供されます。 特定のプロジェクトの種類の設定が存在しない場合、プロジェクト内のファイルは入れ子になっていません。 設定が存在する場合 (Web プロジェクトなど)、入れ子が適用されます。

• Web: このオプションは、 現在 のソリューション内のすべてのプロジェクトに Web ファイルの入れ子動作を適用します。 多くのルールがあるので、是非ご確認いただき、ご意見をお聞かせください。 次のスクリーンショットでは、このオプションで取得するファイルの入れ子動作の例をいくつか示しています。

  

ファイルの入れ子をカスタマイズする

既存の設定に満足できない場合は、独自のカスタムファイル入れ子設定を作成して、ソリューション エクスプローラー にファイルを入れ子にする方法を指示できます。 必要な数のカスタム ファイル入れ子設定を追加でき、必要に応じて切り替えることができます。 新しいカスタム設定を作成するには、空のファイルから開始するか、 既定 の設定を開始点として使用できます。

既定 の 設定を出発点として使用することをお勧めします。これは、既に機能するものを操作する方が簡単であるためです。 既定の設定を開始点として使用する場合、.filenesting.json ファイルは次のファイルのようになります。

ノード 依存FileProviders とその子ノードに焦点を当ててみましょう。 各子ノードは、Visual Studio がファイルの入れ子に使用できるルールの一種です。 たとえば、 同じファイル名を持ちますが、拡張子が異なる のは 1 種類のルールです。 使用可能なルールは次のとおりです。

• extensionToExtension: file.js を file.ts の下に入れ子にするには、この規則の種類を使います

• fileSuffixToExtension: file-vsdoc.js を file.js の下に入れ子にするには、この規則の種類を使います

• addedExtension: file.html.css を file.html の下に入れ子にするには、この規則の種類を使います

• pathSegment: jquery.min.js を jquery.js の下に入れ子にするには、この規則の種類を使います

• allExtensions: file.* を file.js の下に入れ子にするには、この規則の種類を使います

• fileToFile: bower.json を .bowerrc の下に入れ子にするには、この規則の種類を使います

extensionToExtension プロバイダー

このプロバイダーを使用すると、特定のファイル拡張子を使用してファイルの入れ子の規則を定義できます。 次の例を確認してください。

• file.js は、最初の extensionToExtension ルールにより、file.ts の下に入れ子になっています。

• file.js は file.tsx の下で入れ子になりません。これは、規則で .ts が .tsx よりも先に定義されており、親が 1 つしか存在できないためです。

• 2 つ目の extensionToExtension 規則により、light.cssは light.sass の下に入れ子になっています。

• home.html は、3 番目の extensionToExtension ルールのために home.md の下に入れ子になっています。

fileSuffixToExtension プロバイダー

このプロバイダーは extensionToExtension プロバイダーと同じように機能しますが、唯一の違いは、ルールが拡張子ではなくファイルのサフィックスを見ることです。 次の例を確認してください。

• `portal-vsdoc.js は、portal.js の下に、fileSuffixToExtension ルールのために入れ子になっています。`

• ルールの他のすべての側面は 、extensionToExtension と同じように動作します。

addedExtension プロバイダー

このプロバイダーは、追加の拡張子を持つファイルを、追加の拡張子を持たないファイルの下に入れ子にします。 追加の拡張子は、完全なファイル名の末尾にのみ表示できます。

次の例を確認してください。

• file.html.css は file.html の下に、addedExtension ルールに基づき配置されています。

注

addedExtension規則にはファイル拡張子を指定しません。すべてのファイル拡張子に自動的に適用されます。 つまり、別のファイルと同じ名前と拡張子を持ち、末尾に追加の拡張子を持つファイルは、他のファイルの下に入れ子になります。 このプロバイダーの効果を特定のファイル拡張子だけに制限することはできません。

pathSegment プロバイダー

このプロバイダーは、追加の拡張子を持つファイルを、追加の拡張子を持たないファイルの下に入れ子にします。 追加の拡張子は、完全なファイル名の中央にのみ表示できます。

次の例を確認してください。

• pathSegment 規則により、jquery.min.js は jquery.js の下に入れ子になっています。

注

• pathSegment規則に特定のファイル拡張子を指定しない場合は、すべてのファイル拡張子に適用されます。 つまり、別のファイルと同じ名前と拡張子を持ち、その間に追加の拡張子があるファイルは、その別のファイルに入れ子にされます。

• pathSegmentルールの効果を特定のファイル拡張子に制限するには、次のように指定します。

  "pathSegment": {
      "add": {
        ".*": [
          ".js",
          ".css",
          ".html",
          ".htm"
        ]
      }
  }
  

allExtensions プロバイダー

このプロバイダーを使用すると、拡張子が同じ基本ファイル名を持つファイルのファイル入れ子規則を定義できます。 次の例を確認してください。

• allExtensions ルールのため、Template.csとTemplate.docは Template.tt の下に入れ子になります。

fileToFile プロバイダー

このプロバイダーを使用すると、ファイル名全体に基づいてファイルの入れ子の規則を定義できます。 次の例を確認してください。

• fileToFile 規則により、file.npmrc は package.json の下に入れ子になっています。

ルールの順序

順序付けは、カスタム設定ファイルのすべての部分で重要です。 依存FileProvider ノード内でルールを上下に移動することで、ルールの実行順序を変更できます。 たとえば、file.jsをfile.tsの親にするルールと、file.coffeeをfile.tsの親にする別のルールがある場合、3つのファイルがすべて存在する時、ファイル内でのそれらの規則の表示順序によって入れ子の動作が決まります。 file.tsは親を1つしか持つことができないので、最初に実行されるルールが優先されます。

順序付けは、セクション内のファイルだけでなく、ルール セクション自体にも重要です。 ファイルのペアがファイル入れ子の規則と一致するとすぐに、ファイル内のさらに下にある他の規則は無視され、次のファイルペアが処理されます。

ファイル入れ子ボタン

ソリューション エクスプローラーの同じボタンを使用して、独自のカスタム設定を含むすべての設定を管理できます。

プロジェクト固有の設定を作成する

ソリューション固有の設定とプロジェクト固有の設定を作成するには、ソリューションルートまたはプロジェクトルートフォルダに .filenesting.json ファイルを追加します。

ソリューション固有の設定とプロジェクト固有の設定は、アクティブな Visual Studio 設定と組み合わされます。 たとえば、空のプロジェクト固有の設定ファイルがあっても、ソリューション エクスプローラー は依然としてファイルをネストしています。 入れ子の動作は、ソリューション固有の設定または Visual Studio の設定から取得されます。 ファイルの入れ子の設定をマージする場合の優先順位は、Visual Studio > Solution > Project です。

ルート ノードを true に設定することで、ソリューション固有またはプロジェクト固有の設定のみを使用するように Visual Studio に指示できます。 Visual Studio は、そのレベルでファイルのマージを停止し、階層の上位のファイルと結合しません。

ソリューション固有の設定とプロジェクト固有の設定をソース管理にチェックインでき、コードベースで作業するチーム全体で共有できます。

プロジェクトのファイル入れ子規則を無効にする

特定のソリューションまたはプロジェクトの既存のグローバル ファイル入れ子規則を無効にするには、プロバイダーに対して追加ではなく削除アクションを使用します。 たとえば、次の設定コードをプロジェクトに追加すると、この特定のプロジェクトに対してグローバルに存在する可能性がある すべての pathSegment ルールが無効になります。

"dependentFileProviders": {
  "remove": {
    "pathSegment": {}
  }
}

関連コンテンツ

• IDE をカスタマイズする
• Visual Studio のソリューションとプロジェクト