Code review is an unavoidable topic at work for developers. Coding style aside, if the code format is different, that would add difficulty to the code review.
Since then, this article has been about the basic code format for everyone in the same team, which can go through different IDE and platforms. Especially for Jetbrain IDE of C#, Rider. (If anyone is interested in VSCode, we can talk about it later).
Here, I'd like to combine CSharpier and Dotnet format.
Let's get started!
CSharpier
What is CSharpier?
CSharpier is an opinionated code formatter for c#. It uses Roslyn to parse your code and re-prints it using its own rules. The printing process was ported from prettier but has evolved over time.
Quick Start
Install CSharpier globally using the following command.
dotnet tool install csharpier -g
Then format the contents of a directory and its children with the following command.
dotnet csharpier .
Steps:
Open Settings -> Plugins -> Search "CSharpier"
After installation, please "On Save" is turned on.
Dotnet Format
What is Dotnet Format?
dotnet-format is a code formatter for dotnet that applies style preferences to a project or solution. Preferences will be read from an .editorconfig file, if present, otherwise a default set of preferences will be used. At this time dotnet-format is able to format C# and Visual Basic projects with a subset of supported .editorconfig options.
Quick Start
Install dotnet format
dotnet tool install -g dotnet-format
Steps:
1.Open Settings -> Tools -> File Watchers
2.Press The “Plus Sign” to Add a Custom watcher
Set the name to “dotnet format on save”
- FileType: C#
- Scope: Open Files
- Program: Write dotnet-format
- Arguments: $SolutionPath$ -verbosity diagnostic--include $FileRelativePath$
- Append --fix-style warning to fix any style issues automatically on save.
- Append --fix-analyzers warning to fix any analyzer warnings on save.
- Advanced (Options)
- Disabled all advanced option checkboxes.
- All other values were left default
3.Press Ok, and Save Settings.
That's it!
Any feedback is welcome. Happy Coding 🤘!
Top comments (4)
1 - As another commenter mentioned, there's now a
formatutility built into .NET. The new command isdotnet format, without the hyphen.2 - If you don't specifically need the command-line version of
dotnet format, Rider understands the same.editorconfigfile format thatdotnet formatuses, so you can easily turn it on in Jetbrains Rider > Settings > Tools > Actions on Save > Reformat and Clean up Code.Not working. It gives me error like below:
"Error: Invalid executable"
This picture looks like it's from an Apple device. I don't know if it will look the same on other systems. Just so you know, I'm using Windows for this example.
dotnet-format is not a command in dotnet6+ anymore. The new correct command is
dotnet formatand so the program should bedotnetand arguments should be prefixed withformat