DarkPatterns.Build.Autoformat 0.1.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package DarkPatterns.Build.Autoformat --version 0.1.0                

                    
                

            
NuGet\Install-Package DarkPatterns.Build.Autoformat -Version 0.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="DarkPatterns.Build.Autoformat" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add DarkPatterns.Build.Autoformat --version 0.1.0                

                    
                

            
#r "nuget: DarkPatterns.Build.Autoformat, 0.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install DarkPatterns.Build.Autoformat as a Cake Addin
#addin nuget:?package=DarkPatterns.Build.Autoformat&version=0.1.0

// Install DarkPatterns.Build.Autoformat as a Cake Tool
#tool nuget:?package=DarkPatterns.Build.Autoformat&version=0.1.0

DarkPatterns.Build.Autoformat

Adds autoformat tooling to MSBuild projects via dotnet format.

  1. In a .NET project, add a package reference to DarkPatterns.Build.Autoformat.

  2. Set PrivateAssets="All" on the PackageReference to prevent the Autoformat library from being referenced in the build outputs.

  3. Configure your .editorconfig to match rules for your .NET coding standard. See Microsoft's .editorconfig documentation for more details.

For solution-wide settings:

  1. Add the reference to DarkPatterns.Build.Autoformat via the Directory.Build.props to ensure autoformat is set for all projects.

  2. Ensure SolutionRoot is set within the Directory.Build.props as follows:

     <SolutionRoot>$(MSBuildThisFileDirectory)</SolutionRoot>

  3. Place the .editorconfig in the same folder as your Directory.Build.props.

Additional recommendations

  • Ensure you have a .gitattributes file that sets the default line ending for a git checkout to prevent end-of-line changes on first build after switching branches. For example:

    * text=auto eol=lf

Configuration

Properties

Name Decription Default
EnforceCodeStyleInBuild See Microsoft's documentation for EnforceCodeStyleInBuild true
AnalysisLevel See Microsoft's documentation for AnalysisLevel latest-Recommended
LintSkipDotnet Skips the Lint target entirely if set to true false
LintEnforceNoChanges When true, will not update files but instead will cause an error if not already in the correct format true if Configuration is Release

Targets

Lint

Runs before build. Executes dotnet format for the project being built if LintEnforceNoChanges is not true, otherwise dotnet format --verify-no-changes.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.2.0 907 10/6/2024
0.1.2 194 8/23/2024
0.1.1 116 8/15/2024
0.1.0 94 8/5/2024