Code style rules cleanup #19801
Merged
Code style rules cleanup #19801
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RoosterDragon
suggested changes
Nov 14, 2021
Removed some obsolete entries now that there is a new build directory.
It currently has two functions, both of which are covered by our .editorconfig file.
penev92
force-pushed
the
codeStyleRulesCleanup
branch
from
910d64e
to
70aacdc
Compare
|
The initial goal of making ReSharper respect our non-standard rule of omitting explicit access modifiers is looking like a failure, but the cleanup is still worth and we now get CI enforcement of that rule, so overall I rate this a win. P.S.: The misleading warning text for explicit access modifiers still applies, but that's the best we're going to get until the .NET people fix it. |
abcdefg30
reviewed
Jan 5, 2022
RoosterDragon
previously approved these changes
Jan 5, 2022
- The DEFAULT_PRIVATE_MODIFIER behaviour is now handled by the .editorconfig file via `dotnet_style_require_accessibility_modifiers = omit_if_default:warning`. Also added `dotnet_diagnostic.IDE0040.severity = warning` there to raise compile-time errors in the CI. - The field naming conventions seem to already be covered by (some) analyzer rules (checked in both VS and VSCode) - IDE1006/SA1306 and SA1307.
penev92
force-pushed
the
codeStyleRulesCleanup
branch
from
70aacdc
to
992282a
Compare
|
Fixed the new comments in |
RoosterDragon
approved these changes
Jan 6, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Between
.editorconfigOpenRA.rulesetOpenRA.sln.DotSettingsstylecop.jsonI felt our code style rules configuration is all over the place. So I took a peek inside them and it turns out two of them have been made redundant over the years.
stylecop.jsononly contains generic file formatting rules that are already(/now) covered by.editorconfigOpenRA.sln.DotSettingscontains C# field naming rules that are already covered by code analyzers and a rule about default access modifiers, that we can cover with an.editorconfigsettingAlso removed some obsolete entries from
.gitignore.(I am going to try and sneak this onto the release milestone. If it proves problematic somehow we can remove it.)