Configure .NET analyzer and code style settings (#271)

* Configure code style and warnings

* Fix analyzer warnings

* Remove spaces between parentheses

* Change assembly info for visualbasic

* Remove explicit initializations with default values

* Require local variables to use camelCase

* Format private fields in _camelCase style

* Update code_style.md

Author: Marioalexsan

.editorconfig

@@ -65,28 +65,33 @@ end_of_line = lf
 
 # .NET Code Style Settings
 [*.{cs,csx,cake,vb}]
+
 # "this." and "Me." qualifiers
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#this_and_me
-dotnet_style_qualification_for_field = true:warning
-dotnet_style_qualification_for_property = true:warning
-dotnet_style_qualification_for_method = true:warning
-dotnet_style_qualification_for_event = true:warning
+dotnet_style_qualification_for_field = false:warning
+dotnet_style_qualification_for_property = false:warning
+dotnet_style_qualification_for_method = false:warning
+dotnet_style_qualification_for_event = false:warning
+
 # Language keywords instead of framework type names for type references
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#language_keywords
 dotnet_style_predefined_type_for_locals_parameters_members = true:warning
 dotnet_style_predefined_type_for_member_access = true:warning
+
 # Modifier preferences
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#normalize_modifiers
 dotnet_style_require_accessibility_modifiers = always:warning
 csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async
 visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async
 dotnet_style_readonly_field = true:warning
+
 # Parentheses preferences
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#parentheses
 dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:warning
 dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:warning
 dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:warning
 dotnet_style_parentheses_in_other_operators = never_if_unnecessary:suggestion
+
 # Expression-level preferences
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_level
 dotnet_style_object_initializer = true:warning
@@ -98,18 +103,21 @@ dotnet_style_prefer_auto_properties = true:warning
 dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
 dotnet_style_prefer_conditional_expression_over_assignment = false:suggestion
 dotnet_style_prefer_conditional_expression_over_return = false:suggestion
+
 # Null-checking preferences
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#null_checking
 dotnet_style_coalesce_expression = true:warning
 dotnet_style_null_propagation = true:warning
 
 # C# Code Style Settings
 [*.{cs,csx,cake}]
+
 # Implicit and explicit types
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#implicit-and-explicit-types
 csharp_style_var_for_built_in_types = true:warning
 csharp_style_var_when_type_is_apparent = true:warning
 csharp_style_var_elsewhere = true:warning
+
 # Expression-bodied members
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_bodied_members
 csharp_style_expression_bodied_methods = true:warning
@@ -118,25 +126,31 @@ csharp_style_expression_bodied_operators = true:warning
 csharp_style_expression_bodied_properties = true:warning
 csharp_style_expression_bodied_indexers = true:warning
 csharp_style_expression_bodied_accessors = true:warning
+
 # Pattern matching
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#pattern_matching
 csharp_style_pattern_matching_over_is_with_cast_check = true:warning
 csharp_style_pattern_matching_over_as_with_null_check = true:warning
+
 # Inlined variable declarations
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#inlined_variable_declarations
 csharp_style_inlined_variable_declaration = true:warning
+
 # Expression-level preferences
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#expression_level_csharp
 csharp_prefer_simple_default_expression = true:warning
 csharp_style_deconstructed_variable_declaration = true:warning
 csharp_style_pattern_local_over_anonymous_function = true:warning
+
 # "Null" checking preferences
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#null_checking_csharp
 csharp_style_throw_expression = true:warning
 csharp_style_conditional_delegate_call = true:warning
+
 # Code block preferences
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#code_block
 csharp_prefer_braces = true:warning
+csharp_style_prefer_top_level_statements = false:warning
 
 #############################
 # .NET Formatting Conventions
@@ -146,6 +160,7 @@ csharp_prefer_braces = true:warning
 # Organize usings
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#usings
 dotnet_sort_system_directives_first = true
+
 # C# formatting settings
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#c-formatting-settings
 csharp_new_line_before_open_brace = all
@@ -155,31 +170,36 @@ csharp_new_line_before_finally = true
 csharp_new_line_before_members_in_object_initializers = true
 csharp_new_line_before_members_in_anonymous_types = true
 csharp_new_line_between_query_expression_clauses = true
+
 # Indentation options
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#indent
 csharp_indent_case_contents = true
 csharp_indent_switch_labels = true
 csharp_indent_labels = no_change
+
 # Spacing options
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#spacing
 csharp_space_after_cast = false
 csharp_space_after_keywords_in_control_flow_statements = true
 csharp_space_between_method_declaration_parameter_list_parentheses = false
 csharp_space_between_method_call_parameter_list_parentheses = false
-csharp_space_between_parentheses = expressions
+csharp_space_between_parentheses = false
 csharp_space_before_colon_in_inheritance_clause = true
 csharp_space_after_colon_in_inheritance_clause = true
 csharp_space_around_binary_operators = before_and_after
 csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
 csharp_space_between_method_call_name_and_opening_parenthesis = false
 csharp_space_between_method_call_empty_parameter_list_parentheses = false
+
 # Wrapping options
 # https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference#wrapping
 csharp_preserve_single_line_statements = false
 csharp_preserve_single_line_blocks = true
+
 # More Indentation options (Undocumented)
 csharp_indent_block_contents = true
 csharp_indent_braces = false
+
 # Spacing Options (Undocumented)
 csharp_space_after_comma = true
 csharp_space_after_dot = false
@@ -199,86 +219,135 @@ csharp_space_between_square_brackets = false
 #########################
 
 [*.{cs,csx,cake,vb}]
+
 # Naming Symbols
+
 # constant_fields - Define constant fields
 dotnet_naming_symbols.constant_fields.applicable_kinds = field
 dotnet_naming_symbols.constant_fields.required_modifiers = const
+
 # non_private_readonly_fields - Define public, internal and protected readonly fields
 dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, internal, protected
 dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field
 dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly
+
 # static_readonly_fields - Define static and readonly fields
 dotnet_naming_symbols.static_readonly_fields.applicable_kinds = field
 dotnet_naming_symbols.static_readonly_fields.required_modifiers = static, readonly
+
 # private_readonly_fields - Define private readonly fields
 dotnet_naming_symbols.private_readonly_fields.applicable_accessibilities = private
 dotnet_naming_symbols.private_readonly_fields.applicable_kinds = field
 dotnet_naming_symbols.private_readonly_fields.required_modifiers = readonly
+
 # public_internal_fields - Define public and internal fields
 dotnet_naming_symbols.public_internal_fields.applicable_accessibilities = public, internal
 dotnet_naming_symbols.public_internal_fields.applicable_kinds = field
-# private_protected_fields - Define private and protected fields
-dotnet_naming_symbols.private_protected_fields.applicable_accessibilities = private, protected
-dotnet_naming_symbols.private_protected_fields.applicable_kinds = field
+
+# protected_fields - Define protected fields
+dotnet_naming_symbols.protected_fields.applicable_accessibilities = protected
+dotnet_naming_symbols.protected_fields.applicable_kinds = field
+
+# private_fields - Define private fields
+dotnet_naming_symbols.private_fields.applicable_accessibilities = private
+dotnet_naming_symbols.private_fields.applicable_kinds = field
+
 # public_symbols - Define any public symbol
 dotnet_naming_symbols.public_symbols.applicable_accessibilities = public, internal, protected, protected_internal
 dotnet_naming_symbols.public_symbols.applicable_kinds = method, property, event, delegate
+
 # parameters - Defines any parameter
 dotnet_naming_symbols.parameters.applicable_kinds = parameter
+
 # non_interface_types - Defines class, struct, enum and delegate types
 dotnet_naming_symbols.non_interface_types.applicable_kinds = class, struct, enum, delegate
+
 # interface_types - Defines interfaces
 dotnet_naming_symbols.interface_types.applicable_kinds = interface
 
+# local_variables - Defines local_variables
+dotnet_naming_symbols.local_variables.applicable_kinds = local
+
 # Naming Styles
+
 # camel_case - Define the camelCase style
 dotnet_naming_style.camel_case.capitalization = camel_case
+
+# underscored_camel_case - Define the camelCase style with an underscore prefix
+dotnet_naming_style.underscored_camel_case.capitalization = camel_case
+dotnet_naming_style.underscored_camel_case.required_prefix = _
+
 # pascal_case - Define the Pascal_case style
 dotnet_naming_style.pascal_case.capitalization = pascal_case
+
 # first_upper - The first character must start with an upper-case character
 dotnet_naming_style.first_upper.capitalization = first_word_upper
+
 # prefix_interface_interface_with_i - Interfaces must be PascalCase and the first character of an interface must be an 'I'
 dotnet_naming_style.prefix_interface_interface_with_i.capitalization = pascal_case
 dotnet_naming_style.prefix_interface_interface_with_i.required_prefix = I
 
 # Naming Rules
+
 # Constant fields must be PascalCase
 dotnet_naming_rule.constant_fields_must_be_pascal_case.severity = warning
 dotnet_naming_rule.constant_fields_must_be_pascal_case.symbols = constant_fields
 dotnet_naming_rule.constant_fields_must_be_pascal_case.style = pascal_case
+
 # Public, internal and protected readonly fields must be PascalCase
 dotnet_naming_rule.non_private_readonly_fields_must_be_pascal_case.severity = warning
 dotnet_naming_rule.non_private_readonly_fields_must_be_pascal_case.symbols = non_private_readonly_fields
 dotnet_naming_rule.non_private_readonly_fields_must_be_pascal_case.style = pascal_case
-# Static readonly fields must be PascalCase
-dotnet_naming_rule.static_readonly_fields_must_be_pascal_case.severity = warning
-dotnet_naming_rule.static_readonly_fields_must_be_pascal_case.symbols = static_readonly_fields
-dotnet_naming_rule.static_readonly_fields_must_be_pascal_case.style = pascal_case
-# Private readonly fields must be camelCase
-dotnet_naming_rule.private_readonly_fields_must_be_camel_case.severity = warning
-dotnet_naming_rule.private_readonly_fields_must_be_camel_case.symbols = private_readonly_fields
-dotnet_naming_rule.private_readonly_fields_must_be_camel_case.style = camel_case
+
 # Public and internal fields must be PascalCase
 dotnet_naming_rule.public_internal_fields_must_be_pascal_case.severity = warning
 dotnet_naming_rule.public_internal_fields_must_be_pascal_case.symbols = public_internal_fields
 dotnet_naming_rule.public_internal_fields_must_be_pascal_case.style = pascal_case
-# Private and protected fields must be camelCase
-dotnet_naming_rule.private_protected_fields_must_be_camel_case.severity = warning
-dotnet_naming_rule.private_protected_fields_must_be_camel_case.symbols = private_protected_fields
-dotnet_naming_rule.private_protected_fields_must_be_camel_case.style = camel_case
+
+# Protected fields must be camelCase
+dotnet_naming_rule.protected_fields_must_be_camel_case.severity = warning
+dotnet_naming_rule.protected_fields_must_be_camel_case.symbols = protected_fields
+dotnet_naming_rule.protected_fields_must_be_camel_case.style = camel_case
+
+# Private fields must be _camelCase
+dotnet_naming_rule.private_fields_must_be_underscored_camel_case.severity = warning
+dotnet_naming_rule.private_fields_must_be_underscored_camel_case.symbols = private_fields
+dotnet_naming_rule.private_fields_must_be_underscored_camel_case.style = underscored_camel_case
+
 # Public members must be capitalized
 dotnet_naming_rule.public_members_must_be_capitalized.severity = warning
 dotnet_naming_rule.public_members_must_be_capitalized.symbols = public_symbols
 dotnet_naming_rule.public_members_must_be_capitalized.style = first_upper
+
 # Parameters must be camelCase
 dotnet_naming_rule.parameters_must_be_camel_case.severity = warning
 dotnet_naming_rule.parameters_must_be_camel_case.symbols = parameters
 dotnet_naming_rule.parameters_must_be_camel_case.style = camel_case
+
 # Class, struct, enum and delegates must be PascalCase
 dotnet_naming_rule.non_interface_types_must_be_pascal_case.severity = warning
 dotnet_naming_rule.non_interface_types_must_be_pascal_case.symbols = non_interface_types
 dotnet_naming_rule.non_interface_types_must_be_pascal_case.style = pascal_case
+
 # Interfaces must be PascalCase and start with an 'I'
 dotnet_naming_rule.interface_types_must_be_prefixed_with_i.severity = warning
 dotnet_naming_rule.interface_types_must_be_prefixed_with_i.symbols = interface_types
 dotnet_naming_rule.interface_types_must_be_prefixed_with_i.style = prefix_interface_interface_with_i
+
+# Local variables must be camelCase
+dotnet_naming_rule.local_variables_must_be_camel_case.severity = warning
+dotnet_naming_rule.local_variables_must_be_camel_case.symbols = local_variables
+dotnet_naming_rule.local_variables_must_be_camel_case.style = camel_case
+
+####################
+# Configure severity
+####################
+
+# IDE0130: Namespace does not match folder structure
+dotnet_diagnostic.IDE0130.severity = suggestion
+
+# IDE0060: Remove unused parameter
+dotnet_diagnostic.IDE0060.severity = suggestion
+
+# CA1805: Do not initialize unnecessarily
+dotnet_diagnostic.CA1805.severity = warning

SFML.CodeStyle.props

@@ -0,0 +1,13 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+  <!-- This file contains code style configurations for projects. -->
+
+  <PropertyGroup>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <AnalysisModeUsage>all</AnalysisModeUsage>
+    <AnalysisModeStyle>all</AnalysisModeStyle>
+    <AnalysisModeNaming>all</AnalysisModeNaming>
+  </PropertyGroup>
+
+</Project>

SFML.Module.props

@@ -3,6 +3,7 @@
   <!-- This file contains the data shared by all SFML Modules. -->
 
   <Import Project="SFML.NuGet.props" />
+  <Import Project="SFML.CodeStyle.props" />
 
   <PropertyGroup>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>

SFML.sln

@@ -1,17 +1,22 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.26124.0
+# Visual Studio Version 17
+VisualStudioVersion = 17.11.35208.52
 MinimumVisualStudioVersion = 15.0.26124.0
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SFML.Audio", "src\SFML.Audio\SFML.Audio.csproj", "{A1E4E9AA-7468-4FCF-8091-A9A96E818E50}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SFML.Audio", "src\SFML.Audio\SFML.Audio.csproj", "{A1E4E9AA-7468-4FCF-8091-A9A96E818E50}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SFML.Graphics", "src\SFML.Graphics\SFML.Graphics.csproj", "{0C118BA2-904B-4AB1-ADC6-5C22DEFCEFA9}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SFML.Graphics", "src\SFML.Graphics\SFML.Graphics.csproj", "{0C118BA2-904B-4AB1-ADC6-5C22DEFCEFA9}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SFML.Net", "src\SFML.Net\SFML.Net.csproj", "{E5467355-AB84-41E9-A80D-3044A45904B0}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SFML.Net", "src\SFML.Net\SFML.Net.csproj", "{E5467355-AB84-41E9-A80D-3044A45904B0}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SFML.System", "src\SFML.System\SFML.System.csproj", "{FCD90AB3-EAF7-429A-876A-4DB80D6CC6D8}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SFML.System", "src\SFML.System\SFML.System.csproj", "{FCD90AB3-EAF7-429A-876A-4DB80D6CC6D8}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SFML.Window", "src\SFML.Window\SFML.Window.csproj", "{88DD6B5D-3013-4737-A77C-EC2563FCED38}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SFML.Window", "src\SFML.Window\SFML.Window.csproj", "{88DD6B5D-3013-4737-A77C-EC2563FCED38}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{4BBA7B74-E003-4D9B-826A-43BD6BA48111}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -22,9 +27,6 @@ Global
 		Release|x64 = Release|x64
 		Release|x86 = Release|x86
 	EndGlobalSection
-	GlobalSection(SolutionProperties) = preSolution
-		HideSolutionNode = FALSE
-	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{A1E4E9AA-7468-4FCF-8091-A9A96E818E50}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{A1E4E9AA-7468-4FCF-8091-A9A96E818E50}.Debug|Any CPU.Build.0 = Debug|Any CPU
@@ -87,4 +89,10 @@ Global
 		{88DD6B5D-3013-4737-A77C-EC2563FCED38}.Release|x86.ActiveCfg = Release|x86
 		{88DD6B5D-3013-4737-A77C-EC2563FCED38}.Release|x86.Build.0 = Release|x86
 	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {384AFDD8-7EEF-462A-B496-B5F71D0EEF1D}
+	EndGlobalSection
 EndGlobal

code_style.md

@@ -1,5 +1,5 @@
 # Code style
 
-## VS Code references
+Visual Studio and VS Code use the rules defined in [.editorconfig](./.editorconfig) for code style and formatting.
 
-VS Code uses Omnisharp.json instead `.editorconfig` for setting up formatting style. References to setup can be found [here](https://github.com/OmniSharp/omnisharp-roslyn/wiki/Configuration-Options).
+For VS Code, you may need to install [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) and [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) for the configuration to function correctly.

examples/Examples.sln

@@ -29,6 +29,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SFML.Window", "..\src\SFML.
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "netcore", "netcore\netcore.csproj", "{93B8425A-AC40-4486-96AF-20027B738C09}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{A64BFAB3-DD36-4ABE-AABB-8A594327CCDD}"
+	ProjectSection(SolutionItems) = preProject
+		..\.editorconfig = ..\.editorconfig
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU