Configure Stylecop rules #270
Closed
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
(This is going to be a mess.)
This PR switches code style setup from
.editorconfig+omnisharp.jsonto.editorconfig+StyleCop.AnalyzersNuGet package. The main idea is to setup proper style rules that can also be enforced at compile time if needed.I've supressed some of the StyleCop rules that didn't really fit SFML.Net's style (or my biases), while keeping others intact for now. No code changes are done yet, since 1) some changes that StyleCop wants would be breaking changes as far as the API is concerned, and 2) we might want to tweak it further until we've reached a comfortable setup.
How to test?
Grab the branch, check the warnings generated by Intellisense, and check the warnings generated at compile time by the analyzer. Ideally also look through the code to check for other style changes that are needed.