While there's nothing wrong with this coding style, it's not widely used since Visual Studio puts using statements outside the namespace when you create a new C# file. For example, the SA1200 rule requires that using statements be placed within the namespace declaration. StyleCop's default ruleset is extremely opinionated and I recommend disabling rules that don't bring value to your team. StyleCop's suggestions will appear in the Error List and you'll get green Intellisense squigglies.
editorconfig file, which you're welcome to copy.įinally, rebuild the solution. editorconfig GUI to tweak the Formatting and Code Style settings, but a text editor is much more convenient for configuring analyzers. editorconfig file, also in the same directory as your solution file.editorconfig is Microsoft's recommended way of configuring analyzers. 1.2.0 introduces support for the latest C# features, so I recommend it even though it is still technically in beta. You should update the version number to whatever the latest is on. This adds the StyleCop.Analyzers NuGet package to every project in your solution. Reformat method signatures & calls with inconsistent argument formatting such asĮnter fullscreen mode Exit fullscreen mode.Enforce consistent placement of curly braces.all dotnet-format did was remove extraneous whitespace. I used it to reformat a medium C# 9 codebase and inspected the diff. I was really excited about dotnet-format when I heard about it, but sadly, it did not live up to the hype. Johnny Reilly has a great post about setting up dotnet-format together with lint-staged. NET 6 yet, you can still easily install dotnet-format with dotnet tool install dotnet-format (pass the -g option for a global install). Given the limitations of these built-in solutions, I set out to find something better.ĭotnet-format is a formatting tool that's being included in the upcoming. These are helpful but only scratch the surface when compared to ESLint. It doesn't split up long lines, refuses to format certain language constructs, and is generally far less opinionated than Prettier.įor linting, the C# compiler already has a few lint-like warnings, such as reminding you when you've forgotten to await an async method.
Both tools have nearly universal adoption and deliver significant value.īut what about linting and formatting C# code?įor formatting, there's Visual Studio's autoformatter (Edit > Advanced > Format Document), but it only formats a single file at a time and mainly fixes indentation and whitespace issues. The JavaScript ecosystem has amazing tools for formatting and statically analyzing your code: Prettier and ESLint. Tl dr: Use SonarLint and optionally StyleCop.
0 kommentar(er)
