use aspnetcore inspired .editorconfig file

Author: ghidello

.editorconfig

@@ -0,0 +1,6 @@
+{
+	"recommendations": [
+		"EditorConfig.EditorConfig",
+        "GitHub.vscode-github-actions"
+	]
+}

.vscode/extensions.json

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 sotsera
+Copyright (c) 2024 Alessandro Ghidini
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -13,6 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "solution", "solution", "{F2
 		icon.svg = icon.svg
 		LICENSE = LICENSE
 		README.md = README.md
+		Sotsera.Sources.Common.sln.DotSettings = Sotsera.Sources.Common.sln.DotSettings
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{B3030FA3-01FF-42F6-A449-1D8D960AE6D1}"

Sotsera.Sources.Common.sln

@@ -0,0 +1,4 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+  <s:Boolean x:Key="/Default/UserDictionary/Words/=Ghidini/@EntryIndexedValue">True</s:Boolean>
+  <s:Boolean x:Key="/Default/UserDictionary/Words/=Sotsera/@EntryIndexedValue">True</s:Boolean>
+</wpf:ResourceDictionary>

Sotsera.Sources.Common.sln.DotSettings

@@ -1,10 +1,21 @@
-using System.Diagnostics.CodeAnalysis;
+// Copyright (c) Alessandro Ghidini. All rights reserved.
+// SPDX-License-Identifier: MIT.
+
+using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 
 namespace Sotsera.Sources.Common.Extensions;
 
 internal static class ObjectExtensions
 {
+    /// <summary>
+    /// Throws an <see cref="ArgumentNullException"/> if the specified argument is null.
+    /// </summary>
+    /// <typeparam name="T">The type of the argument.</typeparam>
+    /// <param name="argument">The argument to check for null.</param>
+    /// <param name="paramName">The name of the parameter that caused the exception. This is optional and will be automatically set to the name of the argument if not provided.</param>
+    /// <returns>The original argument if it is not null.</returns>
+    /// <exception cref="ArgumentNullException">Thrown if the argument is null.</exception>
     public static T ThrowIfNull<T>([NotNull] this T? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null)
     {
         ArgumentNullException.ThrowIfNull(argument, paramName);

src/Sotsera.Sources.Common/Extensions/ObjectExtensions.cs

@@ -1,21 +1,48 @@
-using System.Collections;
+// Copyright (c) Alessandro Ghidini. All rights reserved.
+// SPDX-License-Identifier: MIT.
+
+using System.Collections;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 
 namespace Sotsera.Sources.Common.Extensions;
 
 internal static class StringExtensions
 {
+    /// <summary>
+    /// Throws an <see cref="ArgumentException"/> if the provided string is null or consists only of white-space characters.
+    /// </summary>
+    /// <param name="argument">The string to check.</param>
+    /// <param name="paramName">The name of the parameter being checked. This is automatically provided by the compiler.</param>
+    /// <returns>The original string if it is not null or white-space.</returns>
+    /// <exception cref="ArgumentException">Thrown if the string is null or white-space.</exception>
     public static string ThrowIfEmpty([NotNull] this string? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null)
     {
         ArgumentException.ThrowIfNullOrWhiteSpace(argument, paramName);
         return argument;
     }
 
+    /// <summary>
+    /// Determines whether the specified string is null or consists only of white-space characters.
+    /// </summary>
+    /// <param name="value">The string to check.</param>
+    /// <returns><c>true</c> if the string is null or white-space; otherwise, <c>false</c>.</returns>
     public static bool IsEmpty([NotNullWhen(false)] this string? value) => string.IsNullOrWhiteSpace(value);
 
+    /// <summary>
+    /// Determines whether the specified string is not null and contains non-white-space characters.
+    /// </summary>
+    /// <param name="value">The string to check.</param>
+    /// <returns><c>true</c> if the string is not null and contains non-white-space characters; otherwise, <c>false</c>.</returns>
     public static bool IsNonEmpty([NotNullWhen(true)] this string? value) => !string.IsNullOrWhiteSpace(value);
 
+    /// <summary>
+    /// Joins an enumeration of strings into a single string, with an optional separator and the option to include or exclude empty values.
+    /// </summary>
+    /// <param name="values">The enumeration of strings to join.</param>
+    /// <param name="separator">The string to use as a separator between each joined string.</param>
+    /// <param name="includeEmptyValues">If <c>true</c>, empty strings are included in the result; otherwise, they are excluded.</param>
+    /// <returns>A single string that consists of the joined strings from the enumeration, separated by the specified separator.</returns>
     public static string JoinStrings(this IEnumerable<string?>? values, string? separator, bool includeEmptyValues = false)
     {
         return values is null or IList { Count: 0 }

src/Sotsera.Sources.Common/Extensions/StringExtensions.cs

@@ -1,4 +1,7 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+  </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="MinVer">
       <PrivateAssets>all</PrivateAssets>

src/Sotsera.Sources.Common/Sotsera.Sources.Common.csproj

@@ -1,4 +1,7 @@
-using Sotsera.Sources.Common.Extensions;
+// Copyright (c) Alessandro Ghidini. All rights reserved.
+// SPDX-License-Identifier: MIT.
+
+using Sotsera.Sources.Common.Extensions;
 
 namespace Sotsera.Sources.Common.Tests.Unit.Extensions;
 
@@ -14,7 +17,6 @@ public void ThrowIfNull_ShouldThrowArgumentNullException_WhenValueIsNull()
         act.Should().Throw<ArgumentNullException>().WithParameterName(nameof(value));
     }
 
-
     [Theory]
     [InlineData("ciao")]
     [InlineData(true)]

test/Sotsera.Sources.Common.Tests.Unit/Extensions/ObjectExtensionsTests.cs

@@ -1,4 +1,7 @@
-using System.Diagnostics.CodeAnalysis;
+// Copyright (c) Alessandro Ghidini. All rights reserved.
+// SPDX-License-Identifier: MIT.
+
+using System.Diagnostics.CodeAnalysis;
 using Sotsera.Sources.Common.Extensions;
 using Xunit.Abstractions;
 
@@ -58,7 +61,6 @@ public void JoinStrings_ShouldReturnTheExpectedValue(EnumerableStringList list,
         list.Values.JoinStrings("; ", includeEmptyValues).Should().Be(expected);
     }
 
-
     private class NullOrWhiteSpaceValueGenerator : TheoryData<string?>
     {
         public NullOrWhiteSpaceValueGenerator()
@@ -96,7 +98,6 @@ public StringEnumerableToBeJoinedValueGenerator()
             Add(new EnumerableStringList(["a", "b"]), false, "a; b");
             Add(new EnumerableStringList(["a", null, "b"]), false, "a; b");
 
-
             Add(new EnumerableStringList(null), true, "");
             Add(new EnumerableStringList(Enumerable.Empty<string>()), true, "");
             Add(new EnumerableStringList(Array.Empty<string>()), true, "");