Skip to content

Commit b24acb9

Browse files
committed
Update Readme and Changelog
1 parent 756d5a1 commit b24acb9

File tree

2 files changed

+89
-6
lines changed

2 files changed

+89
-6
lines changed

CHANGELOG.md

Lines changed: 84 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,90 @@
11
# Changelog
22
All changes to the project will be documented in this file.
33

4-
## [4.1.x] - Not yet released
5-
- [Remove the 255 argument limit for OneOrMany options such as --include and --exclude(700)](https://www.github.com/dotnet/roslyn/pull/700)
6-
- [Only run Imports formatter when is has configuration in the .editorconfig(701)](https://www.github.com/dotnet/roslyn/pull/701)
4+
## [5.1.225507] - 2021-05-05
5+
[View Complete Diff of Changes](https://www.github.com/dotnet/format/compare/b95e1694941ca2595941f1c9cd0d9727b6c53d43...756d5a1c121be3e57e924788af64aa5607dc24e1)
6+
7+
### Breaking Changes
8+
9+
- Implicit restore when fixing code style or 3rd party analyzers (disable with `--no-restore`)
10+
- Adopt csc style for warnings and errors
11+
- Warnings and errors are now written to the standard error stream
12+
13+
### Merged PRs:
14+
- [Add DiagnosticId to the format report (1133)](https://github.com/dotnet/format/pull/1133)
15+
- [Reenabled .NET Core 2.1 support (1021)](https://github.com/dotnet/format/pull/1021)
16+
- [Update System.CommandLine to 2.0.0-beta1.21216.1 (1118)](https://www.github.com/dotnet/format/pull/1118)
17+
- [Support AdditionalDocument changes (1106)](https://www.github.com/dotnet/format/pull/1106)
18+
- [Fix typo in examples (1082)](https://www.github.com/dotnet/format/pull/1082)
19+
- [Run CodeStyle formatter before removing unnecessary imports (1071)](https://www.github.com/dotnet/format/pull/1071)
20+
- [Allow Solution Filter files to be passed as the workspace path (1059)](https://www.github.com/dotnet/format/pull/1059)
21+
- [Add .pre-commit-hooks.yaml (872)](https://www.github.com/dotnet/format/pull/872)
22+
- [Add implicit restore when running analysis. Adds `--no-restore` option. (1015)](https://www.github.com/dotnet/format/pull/1015)
23+
- [Add separate command for binary log (1044)](https://www.github.com/dotnet/format/pull/1044)
24+
- [Use correct flag for codestyle codefixes (1037)](https://www.github.com/dotnet/format/pull/1037)
25+
- [Enhance whitespace issue logging with a detailed TextChange message (1017)](https://www.github.com/dotnet/format/pull/1017)
26+
- [Log all formatter error messages in a csc-style (1016)](https://www.github.com/dotnet/format/pull/1016)
27+
- [LogDebug each project's applied .editorconfig (1013)](https://www.github.com/dotnet/format/pull/1013)
28+
- [Add option to filter diagnostics by id (1007)](https://www.github.com/dotnet/format/pull/1007)
29+
- [Fix pre-commit directory (1004)](https://www.github.com/dotnet/format/pull/1004)
30+
- [Log warnings and errors to the standard error stream (982)](https://www.github.com/dotnet/format/pull/982)
31+
- [Only report fixable compiler diagnostics. (981)](https://www.github.com/dotnet/format/pull/981)
32+
33+
## [5.0.211103] - 2021-02-11
34+
[View Complete Diff of Changes](https://www.github.com/dotnet/format/compare/82a5527cd93d66bffc885c0bb901499f5981db35...b95e1694941ca2595941f1c9cd0d9727b6c53d43)
35+
36+
### Breaking Changes
37+
- Removed `--dry-run` should use `--check` instead
38+
- Removed `--files` should use `--include` instead
39+
- Removed `--workspace` this option is now implied
40+
41+
### Merged PRs:
42+
- [Isolate each Analyzer assembly into its own LoadContext. (959)](https://www.github.com/dotnet/format/pull/959)
43+
- [Implement GetDocumentDiagnosticsAsync in CodeFix DiagnosticProvider (958)](https://www.github.com/dotnet/format/pull/958)
44+
- [Fix missing ` in README.md (914)](https://www.github.com/dotnet/format/pull/914)
45+
- [Add unit test for 3rd party fixer formatting (896)](https://www.github.com/dotnet/format/pull/896)
46+
- [Add unit test for code style fixer formatting (893)](https://www.github.com/dotnet/format/pull/893)
47+
- [Improve FixAll support by using equivalence key when available (884)](https://www.github.com/dotnet/format/pull/884)
48+
- [Only run analyzers against specified project when workspace is a project (865)](https://www.github.com/dotnet/format/pull/865)
49+
- [When matching all files don't rely on FileMatcher (864)](https://www.github.com/dotnet/format/pull/864)
50+
- [Fix markdown formatting in example table (858)](https://www.github.com/dotnet/format/pull/858)
51+
- [Add ability to read --{in,ex}clude value from stdin (790)](https://www.github.com/dotnet/format/pull/790)
52+
- [Add test to ensure code containing <auto-generated> comment is treated as generated. (857)](https://www.github.com/dotnet/format/pull/857)
53+
- [Fixes #834 : error reportfile without directory specified (842)](https://www.github.com/dotnet/format/pull/842)
54+
- [Log there were warnings loading the workspace if diagnostics are reported (841)](https://www.github.com/dotnet/format/pull/841)
55+
- [Fix CommandLine_AllArguments_Bind test (818)](https://www.github.com/dotnet/format/pull/818)
56+
- [Fix Run argument names (817)](https://www.github.com/dotnet/format/pull/817)
57+
- [Add option for whitespace formatting (774)](https://www.github.com/dotnet/format/pull/774)
58+
- [Load analyzer assemlbies in their own AssemblyLoadContext (746)](https://www.github.com/dotnet/format/pull/746)
59+
- [Check that file exists before considering it for formatting (775)](https://www.github.com/dotnet/format/pull/775)
60+
- [Report formatted files and counts based based on reported issues. (776)](https://www.github.com/dotnet/format/pull/776)
61+
- [Support generated_code editorconfig setting (780)](https://www.github.com/dotnet/format/pull/780)
62+
- [Create integrations.md (777)](https://www.github.com/dotnet/format/pull/777)
63+
- [Fix warnings and apply suggestions. (767)](https://www.github.com/dotnet/format/pull/767)
64+
- [Improve folder workspace performance (763)](https://www.github.com/dotnet/format/pull/763)
65+
- [Improve folder performance (760)](https://www.github.com/dotnet/format/pull/760)
66+
- [Update --include and --exclude documentation (761)](https://www.github.com/dotnet/format/pull/761)
67+
- [Remove aliases for the fix style and fix analyzers options (753)](https://www.github.com/dotnet/format/pull/753)
68+
- [Run analyzers during integration tests (728)](https://www.github.com/dotnet/format/pull/728)
69+
- [Remove unnecessary imports (749)](https://www.github.com/dotnet/format/pull/749)
70+
- [Only include compiler diagnostics if a fixer supports them (750)](https://www.github.com/dotnet/format/pull/750)
71+
- [Added CodeFormatter tests for `--fix-style` (751)](https://www.github.com/dotnet/format/pull/751)
72+
- [Format one solution per repo during integration tests (739)](https://www.github.com/dotnet/format/pull/739)
73+
- [Filter analyzers by project language before running (725)](https://www.github.com/dotnet/format/pull/725)
74+
- [Run all analyzers even when a fixer isn't present (723)](https://www.github.com/dotnet/format/pull/723)
75+
- [Update documentation for analyzers (722)](https://www.github.com/dotnet/format/pull/722)
76+
- [Add devcontainer to better support Codespaces (721)](https://www.github.com/dotnet/format/pull/721)
77+
- [Add validation when specifying --folder and analyzers (715)](https://www.github.com/dotnet/format/pull/715)
78+
- [Merge in Feature/analyzers (713)](https://www.github.com/dotnet/format/pull/713)
79+
- [Remove deprecated options and aliases (710)](https://www.github.com/dotnet/format/pull/710)
80+
- [Added reflection based discovery of analyzers and fixes (698)](https://www.github.com/dotnet/format/pull/698)
81+
- [Only run Imports formatter when is has configuration in the .editorconfig (701)](https://www.github.com/dotnet/format/pull/701)
82+
83+
## [4.1.131201] - 2020-06-15
84+
[View Complete Diff of Changes](https://www.github.com/dotnet/format/compare/f772fc306ff4b70cabebbea76beba9cdfd7ecb80...82a5527cd93d66bffc885c0bb901499f5981db35)
85+
## Merged PRs:
86+
- [Only run Imports formatter when is has configuration in the .editorconfig (701)](https://www.github.com/dotnet/format/pull/701)
87+
- [Remove the 255 argument limit for OneOrMany options such as --include and --exclude (700)](https://www.github.com/dotnet/format/pull/700)
788

889
## [4.0.130203] - 2020-06-01
990
[View Complete Diff of Changes](https://www.github.com/dotnet/format/compare/3f2b20c65d32a59ca6bbc68b788a31ed38576d8e...f772fc306ff4b70cabebbea76beba9cdfd7ecb80)

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010

1111
`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).
1212

13-
### New in v5.1
13+
### New in v5.1.225507
1414

1515
#### New Features
1616

1717
- Can now specify that format run against a solution filter with `dotnet format solution.slnf`
1818
- Can now filter diagnostics with `dotnet format --fix-analyzers --diagnostics ID0001`
1919
- 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
20+
- Can now support analyzers which update non-code files, such as the [PublicApiAnalyzers](https://github.com/dotnet/roslyn-analyzers#microsoftcodeanalysispublicapianalyzers)
2121

2222
#### Breaking Changes
2323

@@ -26,6 +26,8 @@
2626
- Warnings and errors are now written to the standard error stream
2727

2828
#### Changes
29+
- [Add DiagnosticId to the format report (1133)](https://github.com/dotnet/format/pull/1133)
30+
- [Reenabled .NET Core 2.1 support (1021)](https://github.com/dotnet/format/pull/1021)
2931
- [Update System.CommandLine to 2.0.0-beta1.21216.1 (1118)](https://www.github.com/dotnet/format/pull/1118)
3032
- [Support AdditionalDocument changes (1106)](https://www.github.com/dotnet/format/pull/1106)
3133
- [Fix typo in examples (1082)](https://www.github.com/dotnet/format/pull/1082)
@@ -45,7 +47,7 @@
4547

4648
### .NET Core 2.1 SDK Support
4749

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.
50+
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](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.
4951

5052
### How To Install
5153

0 commit comments

Comments
 (0)