Loic.dotnet.format 1.0.0

dotnet-format

<img width="480" alt="dotnet-format" src="https://user-images.githubusercontent.com/9797472/61659851-6bbdc880-ac7d-11e9-95f7-d30c7de1a18a.png">

Branch	Windows (Debug)	Windows (Release)	Linux (Debug)	Linux (Release)	Localization (Debug)	Localization (Release)
main

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.

New in v5.1.225507

New Features

• Can now specify that format run against a solution filter with dotnet format solution.slnf
• Can now filter diagnostics with dotnet format --fix-analyzers --diagnostics ID0001
• Can now generate a MSBuild binary log with dotnet format --binary-log PATH
• Can now support analyzers which update non-code files, such as the PublicApiAnalyzers

Breaking Changes

• Implicit restore when fixing code style or 3rd party analyzers (disable with --no-restore)
• Adopt csc style for warnings and errors
• Warnings and errors are now written to the standard error stream

Changes

• Add DiagnosticId to the format report (1133)
• Reenabled .NET Core 2.1 support (1021)
• Update System.CommandLine to 2.0.0-beta1.21216.1 (1118)
• Support AdditionalDocument changes (1106)
• Fix typo in examples (1082)
• Run CodeStyle formatter before removing unnecessary imports (1071)
• Allow Solution Filter files to be passed as the workspace path (1059)
• Add .pre-commit-hooks.yaml (872)
• Add implicit restore when running analysis. Adds --no-restore option. (1015)
• Add separate command for binary log (1044)
• Use correct flag for codestyle codefixes (1037)
• Enhance whitespace issue logging with a detailed TextChange message (1017)
• Log all formatter error messages in a csc-style (1016)
• LogDebug each project's applied .editorconfig (1013)
• Add option to filter diagnostics by id (1007)
• Fix pre-commit directory (1004)
• Log warnings and errors to the standard error stream (982)
• Only report fixable compiler diagnostics. (981)

.NET Core 2.1 SDK Support

The dotnet-format 5.1.x releases will continue to support users who only have .NET Core 2.1 SDK installed. Releases with bug fixes will continue until it reaches end of support on August 21, 2021. Version 6.0 will require .NET Core SDK 3.1 or higher.

How To Install

The dotnet-format nuget package is published to nuget.org.

You can install the tool using the following command.

dotnet tool install -g dotnet-format

Installing Development Builds

Development builds of dotnet-format are being hosted on Azure Packages. You can visit the dotnet-format Azure Packages page.

You can install the latest build of the tool using the following command.

dotnet tool install -g dotnet-format --version 6.0.* --add-source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json

How To Use

By default dotnet-format will look in the current directory for a project or solution file and use that as the workspace to format. If more than one project or solution file is present in the current directory, you will need to specify the workspace to format. You can control how verbose the output will be by using the -v option.

Usage:
  dotnet-format [options] [<workspace>]

Arguments:
  <workspace>    A path to a solution file, a project file, or a folder containing a solution or project file. If a path is not specified then the current directory is used.

Options:
  --no-restore                        Doesn't execute an implicit restore before formatting.
  --folder, -f                        Whether to treat the `<workspace>` argument as a simple folder of files.
  --fix-whitespace, -w                Run whitespace formatting. Run by default when not applying fixes.
  --fix-style, -s <severity>          Run code style analyzers and apply fixes.
  --fix-analyzers, -a <severity>      Run 3rd party analyzers and apply fixes.
  --diagnostics <diagnostic ids>      A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
  --include <include>                 A list of relative file or folder paths to include in formatting. All files are formatted if empty.
  --exclude <exclude>                 A list of relative file or folder paths to exclude from formatting.
  --check                             Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
  --report <report>                   Accepts a file path, which if provided, will produce a json report in the given directory.
  --binarylog <binary-log-path>       Log all project or solution load information to a binary log file.
  --verbosity, -v <verbosity>         Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]
  --version                           Show version information

Add format after dotnet and before the command arguments that you want to run:

How To Uninstall

You can uninstall the tool using the following command.

dotnet tool uninstall -g dotnet-format

How To Build From Source

You can build and package the tool using the following commands. The instructions assume that you are in the root of the repository.

build -pack
# The final line from the build will read something like
# Successfully created package '..\artifacts\packages\Debug\Shipping\dotnet-format.6.0.0-dev.nupkg'.
# Use the value that is in the form `6.0.0-dev` as the version in the next command.
dotnet tool install --add-source .\artifacts\packages\Debug\Shipping -g dotnet-format --version <version>
dotnet format

Note: On macOS and Linux, .\artifacts will need be switched to ./artifacts to accommodate for the different slash directions.