Skip to main content

A DotNet tool to build a solution filter from a solution, controlled by MSBuild project properties.

Total Downloads
9.3K
9,277
Published
Dec 1, 2023
2y ago

Get Started

dotnet add package SolutionFilterBuilder --version 1.0.3

No framework information available.

README

SolutionFilterBuilder

A DotNet tool to create a solution filter form a Visual Studio solution, controlled by MSBuild project properties.

Build Nuget

Easily create a solution filter to avoid loading more than necessary, and update your filter whenever your solution changes.

This tool uses MSBuild logic to control which projects should be part of your filter, giving you a high grade of flexibility.

All projects containing a property IncludeInSolutionFilter set to true are included in the specified filter, along with all their referenced projects. A property SolutionFilterName is provided to be able to write MSBuild conditions based on the filter name.

You can mark individual projects by adding the IncludeInSolutionFilter property to the project file:

  • Include the project and all references in any filter:
    <IncludeInSolutionFilter>true</IncludeInSolutionFilter>
  • Include the project only if the filter name is Setup.slnf:
    <IncludeInSolutionFilter Condition="'$(SolutionFilterName)'=='Setup'">true</IncludeInSolutionFilter>

You can include several projects by convention by adding conditional properties in the Directory.Build.targets file:

  • Include all test projects in Test.slnf:
    <IncludeInSolutionFilter Condition="'$(IncludeInSolutionFilter)'=='' AND '$(IsTestProject)'=='True' AND '$(SolutionFilterName)'=='Test'">true</IncludeInSolutionFilter>
  • Include all projects ending with Something in Something.slnf:
    <_IsSomeProject>$(MSBuildProjectName.ToUpperInvariant().EndsWith("SOMETHING"))</_IsSomeProject>
    <IncludeInSolutionFilter Condition="'$(IncludeInSolutionFilter)'=='' AND $(_IsSomeProject) AND '$(SolutionFilterName)'=='Something'">true</IncludeInSolutionFilter>
  • Include all executables in Apps.slnf:
     <IncludeInSolutionFilter Condition="'$(IncludeInSolutionFilter)'=='' AND '$(OutputType)'=='Exe' AND '$(IsTestProject)'!='true' AND '$(SolutionFilterName)'=='Apps'">true</IncludeInSolutionFilter>

Installation

dotnet tool install solutionfilterbuilder -g

Usage

build-slnf [options]
Options
  -i, --input  <input>              The path to the solution file that is the source for the filter.
                                    If no solution is specified, it tries to find a single one in the current directory.
  -o, --output <output> (REQUIRED)  The name of the solution filter that is created.
                                    An existing file will be overwritten without confirmation.
  --version                         Show version information
  -?, -h, --help                    Show help and usage information
Sample

Build a solution filter Test.sln from the solution in the current directory.

build-slnf -o Test 

Downloads by Version

Similar & Alternative Packages

Hand-picked matching NuGet libraries based on tags & ecosystem

Depended On By

Find packages that declare this package as a dependency. NuGet does not provide a reverse-dependency endpoint, so candidates are checked on demand.

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

No target framework metadata is available. Confirm compatibility in a representative project before standardising on this package.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.