Ghyston.editorconfig 1.0.0

Prefix Reserved
.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package Ghyston.editorconfig --version 1.0.0
                    


                    

                
NuGet\Install-Package Ghyston.editorconfig -Version 1.0.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="Ghyston.editorconfig" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Ghyston.editorconfig" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Ghyston.editorconfig" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Ghyston.editorconfig --version 1.0.0
                    


                    

                
#r "nuget: Ghyston.editorconfig, 1.0.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. 
#addin nuget:?package=Ghyston.editorconfig&version=1.0.0
                    


                            Install Ghyston.editorconfig as a Cake Addin
                        

                    

                
#tool nuget:?package=Ghyston.editorconfig&version=1.0.0
                    


                            Install Ghyston.editorconfig as a Cake Tool

Ghyston.editorconfig

Overview

The purpose of this package is to distribute a shared .editorconfig file, and have a single source of truth for which rules we use on our projects. It is intended to be used alongside CSharpier, so most of the formatting rules have been disabled.

It's not possible for a .editorconfig file to be referenced/extended from a NuGet package, so we take the approach of copying the .editorconfig file into the project at build time.

A lot of the rules come from StyleCop.Analyzers, which is a dependency of this package. There is no need to install it separately.

Installation

  • Install this package from NuGet, using our private source
    • Build the project, and you'll get an .editorconfig file in the project root (the same folder as your .csproj). Note that this will overwrite any existing .editorconfig file.
  • Ignore the generated .editorconfig file from git, by adding /*/.editorconfig to your .gitignore (assuming you only want to ignore the .editorconfig files one level below the git root, which is usually where your .csproj files are)
  • Make sure your build pipeline runs the following two commands, to ensure that all rules are followed:
    • dotnet format style --verify-no-changes
    • dotnet format analyzers --verify-no-changes

Overrides

If you need to make any edits to the generated .editorconfig file, you can create an .editorconfig.overrides file at your project root, and the contents of this file will be appended to the generated .editorconfig file.

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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.1

    • 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
1.0.0 340 3/7/2025