Skip to main content

Dotnet format

I find code consistency important. Naming conventions, code formatting, … should all be aligned to make the code readable and consistent.

In .NET you can force this consistency through the .editorconfig file. (If you don’t have one in your projects, please stop reading and go add one first). This is not the first time I’m mentioning the .editorconfig file:

Today I want to take it one step further and enforce the coding style through our build pipeline. We’ll do this through a dotnet cli tool dotnet-format.

Let’s first install it:

dotnet tool update -g dotnet-format

Now you can browse to your solution or project folder invoke the tool using:

dotnet format

This will apply the code formatting rules defined in our .editorconfig to our code.

If we want to use it inside our builds, we probably don’t want to change the code itself. Instead we only want to check if the rules are followed. This can be done by adding an extra --check and --dryrun parameter:

dotnet format --check –dryrun

This is how the output should look like:

C:\Projects\mestbankportaal\MestbankPortaal\Mestbank.Core>dotnet format --check --dry-run
  Formatting code files in workspace 'C:\Projects\mestbankportaal\MestbankPortaal\Mestbank.Core\Mestbank.Core.csproj'.
  Warnings were encountered while loading the workspace. Set the verbosity option to the 'diagnostic' level to log warnings.
  Domain\IE_ROL_FUNCTIE.cs(3,35): Fix whitespace formatting.
  Services\GebruikerService.cs(25,37): Fix whitespace formatting.
  Services\GebruikerService.cs(25,38): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(27,39): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(27,64): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(27,66): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(40,50): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(42,62): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(42,77): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(42,79): Fix whitespace formatting.
  Services\MestbankAuthorizationService.cs(61,9): Fix whitespace formatting.
  Formatted code file 'IE_ROL_FUNCTIE.cs'.
  Formatted code file 'GebruikerService.cs'.
  Formatted code file 'MestbankAuthorizationService.cs'.
  Format complete in 3695ms.

A non-zero exit code is returned if any files would have been changed. Thanks to this we can easily use it in a dotnetcli task on our build agent.

Popular posts from this blog

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Color B

Help! I accidently enabled HSTS–on localhost

I ran into an issue after accidently enabling HSTS for a website on localhost. This was not an issue for the original website that was running in IIS and had a certificate configured. But when I tried to run an Angular app a little bit later on http://localhost:4200 the browser redirected me immediately to https://localhost . Whoops! That was not what I wanted in this case. To fix it, you need to go the network settings of your browser, there are available at: chrome://net-internals/#hsts edge://net-internals/#hsts brave://net-internals/#hsts Enter ‘localhost’ in the domain textbox under the Delete domain security policies section and hit Delete . That should do the trick…

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.