organize-csproj 1.1.3

.NET Core 3.1
There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global organize-csproj --version 1.1.3
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local organize-csproj --version 1.1.3
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=organize-csproj&version=1.1.3
nuke :add-package organize-csproj --version 1.1.3

Usage

Install as a global dotnet tool.

dotnet tool install -g organize-csproj

Then, use it via:

organize-csproj --input=your-project.csproj

CLI Arguments

--input

Description: The path to a .csproj file.

Default: None

Required: Yes

--output

Description: The filename to save the input.csproj after it has been sorted.

Default: The value of --input (overwrites existing file)

Required: No

--config

Description: The path to a configuration json file

Default: None

Required: No


Example

dotnet organize-csproj --input=project.csproj --output=project.sorted.csproj --config=my.config.json

Configuration

The default configuration can be seen here: csproj.config.defaults.json It should work as a solid reference to get yourself started. The configuration needs to map to SortConfiguration.cs.

If this isn't sufficient documentation, open an issue and I'll write out more.

Sort Options

Below are the primary steps taken when cleaning up a .csproj file.

They each can be disabled using your own configuration file, like so:

{
  "SortOptions": {
    "GroupByNodeType": true,
    "GroupByFileType": true,
    "RemoveEmptyItemGroups": true,
    "SortItemsWithinItemGroups": true
  }
}

They all default to true.

  • GroupByNodeType
    • Groups all Items of the same type into their own <ItemGroup>

      (e.g., <Content>, <Compile>, <TypeScriptCompile>, etc)

  • GroupByFileType
    • Creates <ItemGroup>s for each distinct filetype
    • Subdivides existing <ItemGroup>s into even more granular <ItemGroup>s
  • RemoveEmptyItemGroups
    • Removes <ItemGroup>s without any children. The tool doesn't create empty <ItemGroup>s―this option is for tidying up.
  • SortItemsWithinItemGroups
    • Whether to alphanum sort all <ItemGroup>s. Performed last.
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp3.1
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.1.5 442 11/1/2020
1.1.3 290 10/26/2020
1.1.3-a 257 10/26/2020
1.0.3 253 10/17/2020