Merge pull request #50 from ardalis/ardalis/style

Add .editorconfig
ardalis · Feb 18, 2022 · 757a584 · 757a584
2 parents 4653708 + 115fc65
commit 757a584
Show file tree

Hide file tree

Showing 63 changed files with 2,307 additions and 2,237 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,125 @@
+# 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
+###############################
+# 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
+csharp_style_namespace_declarations = file_scoped:warning
+###############################
+# 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.Extensions.sln b/Ardalis.Extensions.sln
@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.31321.278
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.32112.339
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{06458D58-19B8-4571-86A0-7D933BD254AB}"
 EndProject
@@ -13,6 +13,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ardalis.Extensions.UnitTest
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{E04BB2A8-CD54-448B-90C9-3441ECC92E17}"
 	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
 		.gitignore = .gitignore
 		LICENSE = LICENSE
 		README.md = README.md

diff --git a/src/Ardalis.Extensions/Ardalis.Extensions.csproj b/src/Ardalis.Extensions/Ardalis.Extensions.csproj
@@ -1,34 +1,34 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-  <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
-    <PackageId>Ardalis.Extensions</PackageId>
-    <Title>Ardalis.Extensions</Title>
-    <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
-    <Authors>Steve Smith (@ardalis)</Authors>
-    <Company>Ardalis.com</Company>
-    <PackageProjectUrl>https://github.com/ardalis/Ardalis.Extensions</PackageProjectUrl>
-    <Description>Some useful extension methods.</Description>
-    <Summary>Some useful extension methods.</Summary>
-    <RepositoryUrl>https://github.com/ardalis/Ardalis.Extensions</RepositoryUrl>
-    <PackageTags>extensions extension method methods c# .net dotnet</PackageTags>
-    <PackageReleaseNotes>Added more LINQ and math extensions</PackageReleaseNotes>
-    <Version>0.8.0</Version>
-    <AssemblyName>Ardalis.Extensions</AssemblyName>
-    <PackageIconUrl>https://user-images.githubusercontent.com/782127/33497760-facf6550-d69c-11e7-94e4-b3856da259a9.png</PackageIconUrl>
-    <PublishRepositoryUrl>true</PublishRepositoryUrl>
-    <EmbedUntrackedSources>true</EmbedUntrackedSources>
-    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
-    <LangVersion>8.0</LangVersion>
-    <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>    
-  </PropertyGroup>
-  
-  <ItemGroup>
-    <None Include="LICENSE.txt" Pack="true" PackagePath="$(PackageLicenseFile)" />
-  </ItemGroup>
-  
-  <ItemGroup>
-    <PackageReference Include="Ardalis.GuardClauses" Version="3.2.0" />
-    <PackageReference Include="System.Text.Json" Version="5.0.2" />
-  </ItemGroup>
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <PackageId>Ardalis.Extensions</PackageId>
+        <Title>Ardalis.Extensions</Title>
+        <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
+        <Authors>Steve Smith (@ardalis)</Authors>
+        <Company>Ardalis.com</Company>
+        <PackageProjectUrl>https://github.com/ardalis/Ardalis.Extensions</PackageProjectUrl>
+        <Description>Some useful extension methods.</Description>
+        <Summary>Some useful extension methods.</Summary>
+        <RepositoryUrl>https://github.com/ardalis/Ardalis.Extensions</RepositoryUrl>
+        <PackageTags>extensions extension method methods c# .net dotnet</PackageTags>
+        <PackageReleaseNotes>Added more LINQ and math extensions</PackageReleaseNotes>
+        <Version>0.8.0</Version>
+        <AssemblyName>Ardalis.Extensions</AssemblyName>
+        <PackageIconUrl>https://user-images.githubusercontent.com/782127/33497760-facf6550-d69c-11e7-94e4-b3856da259a9.png</PackageIconUrl>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+        <LangVersion>10.0</LangVersion>
+        <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <None Include="LICENSE.txt" Pack="true" PackagePath="$(PackageLicenseFile)" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Ardalis.GuardClauses" Version="3.2.0" />
+        <PackageReference Include="System.Text.Json" Version="5.0.2" />
+    </ItemGroup>
 </Project>
diff --git a/src/Ardalis.Extensions/Comparisons/IsGreaterThan.cs b/src/Ardalis.Extensions/Comparisons/IsGreaterThan.cs
@@ -1,13 +1,12 @@
-namespace Ardalis.Extensions.Comparisons
+namespace Ardalis.Extensions.Comparisons;
+
+public static partial class CamparableExtensions
 {
-    public static partial class CamparableExtensions
-    {
-        /// <summary>
-        /// Check if a number is greater than another number
-        /// </summary>
-        /// <param name="number">Number to compare.</param>
-        /// <param name="value">Value to compare with a number.</param>
-        /// <returns>True if number is greater than value otherwise false.</returns>
-        public static bool IsGreaterThan(this int number, int value) => number > value;
-    }
-}
+  /// <summary>
+  /// Check if a number is greater than another number
+  /// </summary>
+  /// <param name="number">Number to compare.</param>
+  /// <param name="value">Value to compare with a number.</param>
+  /// <returns>True if number is greater than value otherwise false.</returns>
+  public static bool IsGreaterThan(this int number, int value) => number > value;
+}
diff --git a/src/Ardalis.Extensions/Comparisons/IsLessThan.cs b/src/Ardalis.Extensions/Comparisons/IsLessThan.cs
@@ -1,14 +1,13 @@
-namespace Ardalis.Extensions.Comparisons
+namespace Ardalis.Extensions.Comparisons;
+
+public static partial class CamparableExtensions
 {
-    public static partial class CamparableExtensions
-    {
 
-        /// <summary>
-        /// Check if a number is less than another number
-        /// </summary>
-        /// <param name="number">Number to compare.</param>
-        /// <param name="value">Value to compare with a number.</param>
-        /// <returns>True if number is less than value otherwise false.</returns>
-        public static bool IsLessThan(this int number, int value) => number < value;
-    }
+  /// <summary>
+  /// Check if a number is less than another number
+  /// </summary>
+  /// <param name="number">Number to compare.</param>
+  /// <param name="value">Value to compare with a number.</param>
+  /// <returns>True if number is less than value otherwise false.</returns>
+  public static bool IsLessThan(this int number, int value) => number < value;
 }
diff --git a/src/Ardalis.Extensions/Conversions/ConvertTo.cs b/src/Ardalis.Extensions/Conversions/ConvertTo.cs
@@ -1,26 +1,25 @@
 using System;
 
-namespace Ardalis.Extensions.Conversions
+namespace Ardalis.Extensions.Conversions;
+
+public static partial class ConvertibleExtensions
 {
-    public static partial class ConvertibleExtensions
-    {
-        /// <summary>
-        /// Converts an IConvertable struct to the desired output Type.
-        /// </summary>
-        /// <typeparam name="TOut"></typeparam>
-        /// <typeparam name="TIn"></typeparam>
-        /// <param name="value">A struct object that implements the System.IConvertible interface.</param>
-        /// <returns>An object of specified type, whose value is equivalent to the original object.</returns>
-        /// <exception cref="System.InvalidCastException">
-        /// This conversion is not supported.
-        /// -or- value is null and conversionType is a value type.
-        /// -or- value does not implement the System.IConvertible interface.
-        /// </exception>
-        /// <exception cref="System.FormatException">value is not in a format recognized by conversionType.</exception>
-        /// <exception cref="System.OverflowException">value represents a number that is out of the range of the Type being converted to.</exception>
-        public static TOut ConvertTo<TIn, TOut>(this TIn value) where TIn : struct, IConvertible
-        {
-            return (TOut) Convert.ChangeType(value, typeof(TOut));
-        }
-    }
-}
+  /// <summary>
+  /// Converts an IConvertable struct to the desired output Type.
+  /// </summary>
+  /// <typeparam name="TOut"></typeparam>
+  /// <typeparam name="TIn"></typeparam>
+  /// <param name="value">A struct object that implements the System.IConvertible interface.</param>
+  /// <returns>An object of specified type, whose value is equivalent to the original object.</returns>
+  /// <exception cref="System.InvalidCastException">
+  /// This conversion is not supported.
+  /// -or- value is null and conversionType is a value type.
+  /// -or- value does not implement the System.IConvertible interface.
+  /// </exception>
+  /// <exception cref="System.FormatException">value is not in a format recognized by conversionType.</exception>
+  /// <exception cref="System.OverflowException">value represents a number that is out of the range of the Type being converted to.</exception>
+  public static TOut ConvertTo<TIn, TOut>(this TIn value) where TIn : struct, IConvertible
+  {
+    return (TOut)Convert.ChangeType(value, typeof(TOut));
+  }
+}
diff --git a/src/Ardalis.Extensions/Data/DataExtensions.cs b/src/Ardalis.Extensions/Data/DataExtensions.cs
@@ -2,40 +2,39 @@
 using System.Linq;
 using System.Transactions;
 
-namespace Ardalis.Extensions.Data
+namespace Ardalis.Extensions.Data;
+
+public static partial class DataExtensions
 {
-    public static partial class DataExtensions
-    {
-        // Source: https://stackoverflow.com/a/18553786
-        public static List<T> ToListReadUncommitted<T>(this IQueryable<T> query)
+  // Source: https://stackoverflow.com/a/18553786
+  public static List<T> ToListReadUncommitted<T>(this IQueryable<T> query)
+  {
+    using (var scope = new TransactionScope(
+        TransactionScopeOption.Required,
+        new TransactionOptions()
         {
-            using (var scope = new TransactionScope(
-                TransactionScopeOption.Required,
-                new TransactionOptions()
-                {
-                    IsolationLevel = IsolationLevel.ReadUncommitted
-                }))
-            {
-                List<T> toReturn = query.ToList();
-                scope.Complete();
-                return toReturn;
-            }
-        }
+          IsolationLevel = IsolationLevel.ReadUncommitted
+        }))
+    {
+      List<T> toReturn = query.ToList();
+      scope.Complete();
+      return toReturn;
+    }
+  }
 
-        // Source: https://stackoverflow.com/a/18553786
-        public static int CountReadUncommitted<T>(this IQueryable<T> query)
+  // Source: https://stackoverflow.com/a/18553786
+  public static int CountReadUncommitted<T>(this IQueryable<T> query)
+  {
+    using (var scope = new TransactionScope(
+        TransactionScopeOption.Required,
+        new TransactionOptions()
         {
-            using (var scope = new TransactionScope(
-                TransactionScopeOption.Required,
-                new TransactionOptions()
-                {
-                    IsolationLevel = IsolationLevel.ReadUncommitted
-                }))
-            {
-                int toReturn = query.Count();
-                scope.Complete();
-                return toReturn;
-            }
-        }
+          IsolationLevel = IsolationLevel.ReadUncommitted
+        }))
+    {
+      int toReturn = query.Count();
+      scope.Complete();
+      return toReturn;
     }
-}
+  }
+}