Adding and Applying EditorConfig (#226)

* Adding editorconfig * apply formatting rules * adding documentationfiles * Enabled XML comments for Ardalis.Specification project. Co-authored-by: Fati Iseni <[email protected]>
ardalis · Jan 18, 2022 · 027962e · 027962e
1 parent 8e9da2a
commit 027962e
Show file tree

Hide file tree

Showing 214 changed files with 5,808 additions and 5,703 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,126 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+###############################
+# Core EditorConfig Options   #
+###############################
+# All files
+[*]
+indent_style = space
+# Code files
+[*.{cs,csx,vb,vbx}]
+indent_size =2
+insert_final_newline = true
+charset = utf-8-bom
+###############################
+# .NET Coding Conventions     #
+###############################
+[*.{cs,vb}]
+# Organize usings
+dotnet_sort_system_directives_first = true
+# this. preferences
+dotnet_style_qualification_for_field = false:silent
+dotnet_style_qualification_for_property = false:silent
+dotnet_style_qualification_for_method = false:silent
+dotnet_style_qualification_for_event = false:silent
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true:silent
+dotnet_style_predefined_type_for_member_access = true:silent
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
+dotnet_style_readonly_field = true:suggestion
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+# Namespace preferences
+csharp_style_namespace_declarations = file_scoped:warning
+###############################
+# Naming Conventions          #
+###############################
+# Style Definitions
+dotnet_naming_style.pascal_case_style.capitalization             = pascal_case
+# Use PascalCase for constant fields  
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds            = field
+dotnet_naming_symbols.constant_fields.applicable_accessibilities  = *
+dotnet_naming_symbols.constant_fields.required_modifiers          = const
+tab_width=2
+###############################
+# C# Coding Conventions       #
+###############################
+[*.cs]
+# var preferences
+csharp_style_var_for_built_in_types = true:silent
+csharp_style_var_when_type_is_apparent = true:silent
+csharp_style_var_elsewhere = true:silent
+# Expression-bodied members
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+# Pattern matching preferences
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+# Null-checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+# Expression-level preferences
+csharp_prefer_braces = true:silent
+csharp_style_deconstructed_variable_declaration = true:suggestion
+csharp_prefer_simple_default_expression = true:suggestion
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+###############################
+# C# Formatting Rules         #
+###############################
+# New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+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 preferences
+csharp_indent_case_contents = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = flush_left
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+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 preferences
+csharp_preserve_single_line_statements = true
+csharp_preserve_single_line_blocks = true
+###############################
+# VB Coding Conventions       #
+###############################
+[*.vb]
+# Modifier preferences
+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:suggestion
diff --git a/Ardalis.Specification.sln b/Ardalis.Specification.sln
@@ -28,6 +28,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docker", "Docker", "{A74A4C
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_Solution Items", "_Solution Items", "{C443291A-7311-455F-9AC6-995EB29DD6D2}"
 	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
 		README.md = README.md
 	EndProjectSection
 EndProject

diff --git a/.../src/Ardalis.Specification.EntityFramework6/Ardalis.Specification.EntityFramework6.csproj b/.../src/Ardalis.Specification.EntityFramework6/Ardalis.Specification.EntityFramework6.csproj
@@ -23,6 +23,7 @@
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+    <DocumentationFile>bin\$(Configuration)\Ardalis.Specification.EntityFramework6.xml</DocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/...Framework6/src/Ardalis.Specification.EntityFramework6/Evaluators/AsNoTrackingEvaluator.cs b/...Framework6/src/Ardalis.Specification.EntityFramework6/Evaluators/AsNoTrackingEvaluator.cs
@@ -3,21 +3,21 @@
 
 namespace Ardalis.Specification.EntityFramework6
 {
-    public class AsNoTrackingEvaluator : IEvaluator
-    {
-        private AsNoTrackingEvaluator() { }
-        public static AsNoTrackingEvaluator Instance { get; } = new AsNoTrackingEvaluator();
+  public class AsNoTrackingEvaluator : IEvaluator
+  {
+    private AsNoTrackingEvaluator() { }
+    public static AsNoTrackingEvaluator Instance { get; } = new AsNoTrackingEvaluator();
 
-        public bool IsCriteriaEvaluator { get; } = true;
+    public bool IsCriteriaEvaluator { get; } = true;
 
-        public IQueryable<T> GetQuery<T>(IQueryable<T> query, ISpecification<T> specification) where T : class
-        {
-            if (specification.AsNoTracking)
-            {
-                query = query.AsNoTracking();
-            }
+    public IQueryable<T> GetQuery<T>(IQueryable<T> query, ISpecification<T> specification) where T : class
+    {
+      if (specification.AsNoTracking)
+      {
+        query = query.AsNoTracking();
+      }
 
-            return query;
-        }
+      return query;
     }
-}
+  }
+}
diff --git a/...ntityFramework6/src/Ardalis.Specification.EntityFramework6/Evaluators/IncludeEvaluator.cs b/...ntityFramework6/src/Ardalis.Specification.EntityFramework6/Evaluators/IncludeEvaluator.cs
@@ -1,35 +1,35 @@
-using System.Linq;
-using System.Data.Entity;
+using System.Data.Entity;
+using System.Linq;
 
 namespace Ardalis.Specification.EntityFramework6
 {
-    public class IncludeEvaluator : IEvaluator
-    {
-        private IncludeEvaluator() { }
-        public static IncludeEvaluator Instance { get; } = new IncludeEvaluator();
-
-        public bool IsCriteriaEvaluator { get; } = false;
+  public class IncludeEvaluator : IEvaluator
+  {
+    private IncludeEvaluator() { }
+    public static IncludeEvaluator Instance { get; } = new IncludeEvaluator();
 
-        public IQueryable<T> GetQuery<T>(IQueryable<T> query, ISpecification<T> specification) where T : class
-        {
-            foreach (var includeString in specification.IncludeStrings)
-            {
-                query = query.Include(includeString);
-            }
+    public bool IsCriteriaEvaluator { get; } = false;
 
-            foreach (var includeInfo in specification.IncludeExpressions)
-            {
-                if (includeInfo.Type == IncludeTypeEnum.Include)
-                {
-                    query = query.Include(includeInfo);
-                }
-                else if (includeInfo.Type == IncludeTypeEnum.ThenInclude)
-                {
-                    query = query.ThenInclude(includeInfo);
-                }
-            }
+    public IQueryable<T> GetQuery<T>(IQueryable<T> query, ISpecification<T> specification) where T : class
+    {
+      foreach (var includeString in specification.IncludeStrings)
+      {
+        query = query.Include(includeString);
+      }
 
-            return query;
+      foreach (var includeInfo in specification.IncludeExpressions)
+      {
+        if (includeInfo.Type == IncludeTypeEnum.Include)
+        {
+          query = query.Include(includeInfo);
+        }
+        else if (includeInfo.Type == IncludeTypeEnum.ThenInclude)
+        {
+          query = query.ThenInclude(includeInfo);
         }
+      }
+
+      return query;
     }
-}
+  }
+}