CSharpier

What CSharpier is

CSharpier is a free, open-source formatter for C# and XML. It parses code and prints it using a consistent set of rules, with a small number of configuration choices rather than support for requests for additional options. It supports C# through version 14 and can be installed as a .NET tool locally for a project or globally. Configuration can be kept in .csharpierrc JSON or YAML files, or in .editorconfig; available settings include print width, tabs, indentation, and line endings. CSharpier can check files and, by default, returns a failing exit code when it finds unformatted code. It can also run as a pre-commit hook, during MSBuild builds, or in CI/CD workflows. Listed editor integrations include Visual Studio 2022 and 2019, Visual Studio Code, and Rider, with setup guidance for Neovim, Emacs, and Zed. The CSharpier.Core NuGet package provides a programmatic formatting API. It runs on Windows, macOS, and Linux, but cannot format code that does not compile; such files produce error diagnostics.

Who it suits

CSharpier suits C# and XML developers who want a consistent formatter in an editor, project build, or CI/CD workflow. It also fits applications that need programmatic formatting through its NuGet package.

Limits

Code that cannot compile cannot be formatted and returns error diagnostics. The formatter offers a few basic options; requests for additional formatting options are out of scope.

Getting started

1. Open the CSharpier website.
2. Install the .NET tool locally for a project or globally.
3. Add configuration in .csharpierrc JSON or YAML, or in .editorconfig, if needed.
4. Use a listed editor extension or plugin, or follow the setup guidance for Neovim, Emacs, or Zed.
5. Run it as a pre-commit hook, during MSBuild builds, or in a CI/CD workflow.

Verdict

CSharpier provides an opinionated way to format C# and XML across common development workflows. Its formatting check and integrations are useful, but code must compile and the available configuration is intentionally limited.