|
10 | 10 |
|
11 | 11 | `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](./docs/Supported-.editorconfig-options.md). |
12 | 12 |
|
13 | | -### New in v5.0.211103 |
14 | | - |
15 | | -### New Features |
16 | | -- Can now apply codestyle codefixes automatically with `dotnet format --fix-style` |
17 | | -- Can now apply analyzer codefixes automatically with `dotnet format --fix-analyzers` |
18 | | - |
19 | | -### Breaking Changes |
20 | | - |
21 | | -Removed Deprecated options from 4.0: |
22 | | -- Removed `--dry-run` should use `--check` instead |
23 | | -- Removed `--files` should use `--include` instead |
24 | | -- Removed `--workspace` this option is now implied |
25 | | - |
26 | | -#### Changes: |
27 | | -- [Isolate each Analyzer assembly into its own LoadContext. (959)](https://www.github.com/dotnet/format/pull/959) |
28 | | -- [Implement GetDocumentDiagnosticsAsync in CodeFix DiagnosticProvider (958)](https://www.github.com/dotnet/format/pull/958) |
29 | | -- [Fix missing ` in README.md (914)](https://www.github.com/dotnet/format/pull/914) |
30 | | -- [Add unit test for 3rd party fixer formatting (896)](https://www.github.com/dotnet/format/pull/896) |
31 | | -- [Add unit test for code style fixer formatting (893)](https://www.github.com/dotnet/format/pull/893) |
32 | | -- [Improve FixAll support by using equivalence key when available (884)](https://www.github.com/dotnet/format/pull/884) |
33 | | -- [Only run analyzers against specified project when workspace is a project (865)](https://www.github.com/dotnet/format/pull/865) |
34 | | -- [When matching all files don't rely on FileMatcher (864)](https://www.github.com/dotnet/format/pull/864) |
35 | | -- [Fix markdown formatting in example table (858)](https://www.github.com/dotnet/format/pull/858) |
36 | | -- [Add ability to read --{in,ex}clude value from stdin (790)](https://www.github.com/dotnet/format/pull/790) |
37 | | -- [Add test to ensure code containing <auto-generated> comment is treated as generated. (857)](https://www.github.com/dotnet/format/pull/857) |
38 | | -- [Fixes #834 : error reportfile without directory specified (842)](https://www.github.com/dotnet/format/pull/842) |
39 | | -- [Log there were warnings loading the workspace if diagnostics are reported (841)](https://www.github.com/dotnet/format/pull/841) |
40 | | -- [Fix CommandLine_AllArguments_Bind test (818)](https://www.github.com/dotnet/format/pull/818) |
41 | | -- [Fix Run argument names (817)](https://www.github.com/dotnet/format/pull/817) |
42 | | -- [Add option for whitespace formatting (774)](https://www.github.com/dotnet/format/pull/774) |
43 | | -- [Load analyzer assemlbies in their own AssemblyLoadContext (746)](https://www.github.com/dotnet/format/pull/746) |
44 | | -- [Check that file exists before considering it for formatting (775)](https://www.github.com/dotnet/format/pull/775) |
45 | | -- [Report formatted files and counts based based on reported issues. (776)](https://www.github.com/dotnet/format/pull/776) |
46 | | -- [Support generated_code editorconfig setting (780)](https://www.github.com/dotnet/format/pull/780) |
47 | | -- [Create integrations.md (777)](https://www.github.com/dotnet/format/pull/777) |
48 | | -- [Fix warnings and apply suggestions. (767)](https://www.github.com/dotnet/format/pull/767) |
49 | | -- [Improve folder workspace performance (763)](https://www.github.com/dotnet/format/pull/763) |
50 | | -- [Improve folder performance (760)](https://www.github.com/dotnet/format/pull/760) |
51 | | -- [Update --include and --exclude documentation (761)](https://www.github.com/dotnet/format/pull/761) |
52 | | -- [Remove aliases for the fix style and fix analyzers options (753)](https://www.github.com/dotnet/format/pull/753) |
53 | | -- [Run analyzers during integration tests (728)](https://www.github.com/dotnet/format/pull/728) |
54 | | -- [Remove unnecessary imports (749)](https://www.github.com/dotnet/format/pull/749) |
55 | | -- [Only include compiler diagnostics if a fixer supports them (750)](https://www.github.com/dotnet/format/pull/750) |
56 | | -- [Added CodeFormatter tests for `--fix-style` (751)](https://www.github.com/dotnet/format/pull/751) |
57 | | -- [Format one solution per repo during integration tests (739)](https://www.github.com/dotnet/format/pull/739) |
58 | | -- [Filter analyzers by project language before running (725)](https://www.github.com/dotnet/format/pull/725) |
59 | | -- [Run all analyzers even when a fixer isn't present (723)](https://www.github.com/dotnet/format/pull/723) |
60 | | -- [Update documentation for analyzers (722)](https://www.github.com/dotnet/format/pull/722) |
61 | | -- [Add devcontainer to better support Codespaces (721)](https://www.github.com/dotnet/format/pull/721) |
62 | | -- [Add validation when specifying --folder and analyzers (715)](https://www.github.com/dotnet/format/pull/715) |
63 | | -- [Merge in Feature/analyzers (713)](https://www.github.com/dotnet/format/pull/713) |
64 | | -- [Remove deprecated options and aliases (710)](https://www.github.com/dotnet/format/pull/710) |
65 | | -- [Added reflection based discovery of analyzers and fixes (698)](https://www.github.com/dotnet/format/pull/698) |
66 | | -- [Only run Imports formatter when is has configuration in the .editorconfig (701)](https://www.github.com/dotnet/format/pull/701) |
| 13 | +### New in v5.1 |
| 14 | + |
| 15 | +#### New Features |
| 16 | + |
| 17 | +- Can now specify that format run against a solution filter with `dotnet format solution.slnf` |
| 18 | +- Can now filter diagnostics with `dotnet format --fix-analyzers --diagnostics ID0001` |
| 19 | +- Can now generate a MSBuild binary log with `dotnet format --binary-log PATH` |
| 20 | +- Now with support for analyzers, such as the [PublicApiAnalyzers](https://github.com/dotnet/roslyn-analyzers#microsoftcodeanalysispublicapianalyzers), which update non-code files |
| 21 | + |
| 22 | +#### Breaking Changes |
| 23 | + |
| 24 | +- Implicit restore when fixing code style or 3rd party analyzers (disable with `--no-restore`) |
| 25 | +- Adopt csc style for warnings and errors |
| 26 | +- Warnings and errors are now written to the standard error stream |
| 27 | + |
| 28 | +#### Changes |
| 29 | +- [Update System.CommandLine to 2.0.0-beta1.21216.1 (1118)](https://www.github.com/dotnet/format/pull/1118) |
| 30 | +- [Support AdditionalDocument changes (1106)](https://www.github.com/dotnet/format/pull/1106) |
| 31 | +- [Fix typo in examples (1082)](https://www.github.com/dotnet/format/pull/1082) |
| 32 | +- [Run CodeStyle formatter before removing unnecessary imports (1071)](https://www.github.com/dotnet/format/pull/1071) |
| 33 | +- [Allow Solution Filter files to be passed as the workspace path (1059)](https://www.github.com/dotnet/format/pull/1059) |
| 34 | +- [Add .pre-commit-hooks.yaml (872)](https://www.github.com/dotnet/format/pull/872) |
| 35 | +- [Add implicit restore when running analysis. Adds `--no-restore` option. (1015)](https://www.github.com/dotnet/format/pull/1015) |
| 36 | +- [Add separate command for binary log (1044)](https://www.github.com/dotnet/format/pull/1044) |
| 37 | +- [Use correct flag for codestyle codefixes (1037)](https://www.github.com/dotnet/format/pull/1037) |
| 38 | +- [Enhance whitespace issue logging with a detailed TextChange message (1017)](https://www.github.com/dotnet/format/pull/1017) |
| 39 | +- [Log all formatter error messages in a csc-style (1016)](https://www.github.com/dotnet/format/pull/1016) |
| 40 | +- [LogDebug each project's applied .editorconfig (1013)](https://www.github.com/dotnet/format/pull/1013) |
| 41 | +- [Add option to filter diagnostics by id (1007)](https://www.github.com/dotnet/format/pull/1007) |
| 42 | +- [Fix pre-commit directory (1004)](https://www.github.com/dotnet/format/pull/1004) |
| 43 | +- [Log warnings and errors to the standard error stream (982)](https://www.github.com/dotnet/format/pull/982) |
| 44 | +- [Only report fixable compiler diagnostics. (981)](https://www.github.com/dotnet/format/pull/981) |
| 45 | + |
| 46 | +### .NET Core 2.1 SDK Support |
| 47 | + |
| 48 | +The dotnet-format 5.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](https://dotnet.microsoft.com/platform/support/policy/dotnet-core) on August 21, 2021. Version 6.0 will require .NET Core SDK 3.1 or higher. |
67 | 49 |
|
68 | 50 | ### How To Install |
69 | 51 |
|
|
0 commit comments