Merge pull request #2189 from SixLabors/js/remove-obsolete-code

Remove obsolete code

Author: JimBobSquarePants

.editorconfig

@@ -1,5 +1,5 @@
-# Version: 2.1.0 (Using https://semver.org/)
-# Updated: 2021-03-03
+# Version: 4.1.1 (Using https://semver.org/)
+# Updated: 2022-05-23
 # See https://github.com/RehanSaeed/EditorConfig/releases for release notes.
 # See https://github.com/RehanSaeed/EditorConfig for updates to this file.
 # See http://EditorConfig.org for more information about .editorconfig files.
@@ -49,11 +49,11 @@ indent_size = 2
 indent_size = 2
 
 # Markdown Files
-[*.md]
+[*.{md,mdx}]
 trim_trailing_whitespace = false
 
 # Web Files
-[*.{htm,html,js,jsm,ts,tsx,css,sass,scss,less,svg,vue}]
+[*.{htm,html,js,jsm,ts,tsx,cjs,cts,ctsx,mjs,mts,mtsx,css,sass,scss,less,pcss,svg,vue}]
 indent_size = 2
 
 # Batch Files
@@ -75,7 +75,7 @@ indent_style = tab
 
 [*.{cs,csx,cake,vb,vbx}]
 # Default Severity for all .NET Code Style rules below
-dotnet_analyzer_diagnostic.category-style.severity = warning
+dotnet_analyzer_diagnostic.severity = warning
 
 ##########################################
 # Language Rules
@@ -128,14 +128,15 @@ file_header_template = Copyright (c) Six Labors.\nLicensed under the Six Labors
 # dotnet_diagnostic.SA1636.severity = none
 
 # Undocumented
-dotnet_style_operator_placement_when_wrapping = end_of_line
+dotnet_style_operator_placement_when_wrapping = end_of_line:warning
+csharp_style_prefer_null_check_over_type_check = true:warning
 
 # C# Style Rules
 # https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/language-rules#c-style-rules
 [*.{cs,csx,cake}]
 # 'var' preferences
-csharp_style_var_for_built_in_types = never
-csharp_style_var_when_type_is_apparent = true:warning
+csharp_style_var_for_built_in_types = false:warning
+csharp_style_var_when_type_is_apparent = false:warning
 csharp_style_var_elsewhere = false:warning
 # Expression-bodied members
 csharp_style_expression_bodied_methods = true:warning
@@ -200,12 +201,15 @@ dotnet_diagnostic.IDE0059.severity = suggestion
 # Organize using directives
 dotnet_sort_system_directives_first = true
 dotnet_separate_import_directive_groups = false
+# Dotnet namespace options
+dotnet_style_namespace_match_folder = true:suggestion
+dotnet_diagnostic.IDE0130.severity = suggestion
 
 # C# formatting rules
 # https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/formatting-rules#c-formatting-rules
 [*.{cs,csx,cake}]
 # Newline options
-# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#new-line-options
+# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/formatting-rules#new-line-options
 csharp_new_line_before_open_brace = all
 csharp_new_line_before_else = true
 csharp_new_line_before_catch = true
@@ -214,15 +218,15 @@ 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/visualstudio/ide/editorconfig-formatting-conventions#indentation-options
+# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/formatting-rules#indentation-options
 csharp_indent_case_contents = true
 csharp_indent_switch_labels = true
 csharp_indent_labels = no_change
 csharp_indent_block_contents = true
 csharp_indent_braces = false
 csharp_indent_case_contents_when_block = false
 # Spacing options
-# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#spacing-options
+# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/formatting-rules#spacing-options
 csharp_space_after_cast = false
 csharp_space_after_keywords_in_control_flow_statements = true
 csharp_space_between_parentheses = false
@@ -246,7 +250,7 @@ csharp_space_before_open_square_brackets = false
 csharp_space_between_empty_square_brackets = false
 csharp_space_between_square_brackets = false
 # Wrap options
-# https://docs.microsoft.com/visualstudio/ide/editorconfig-formatting-conventions#wrap-options
+# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/formatting-rules#wrap-options
 csharp_preserve_single_line_statements = false
 csharp_preserve_single_line_blocks = true
 
@@ -448,4 +452,4 @@ dotnet_naming_rule.parameters_rule.severity             = warning
 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 # OTHER DEALINGS IN THE SOFTWARE.
-##########################################
+##########################################

shared-infrastructure

@@ -21,6 +21,10 @@
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <CodeAnalysisRuleSet>..\ImageSharp.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+
   <ItemGroup>
     <!-- DynamicProxyGenAssembly2 is needed so Moq can use our internals -->
     <InternalsVisibleTo Include="DynamicProxyGenAssembly2" Key="0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7" />

src/Directory.Build.props

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="ImageSharp" ToolsVersion="17.0">
+  <Include Path="..\shared-infrastructure\sixlabors.ruleset" Action="Default" />
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+    <Rule Id="SA1011" Action="None" />
+  </Rules>
+</RuleSet>

src/ImageSharp.ruleset

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.IO;
 using System.Text;
 using System.Threading;
@@ -34,11 +35,11 @@ public static IImageEncoder DetectEncoder(this Image source, string filePath)
             IImageFormat format = source.GetConfiguration().ImageFormatsManager.FindFormatByFileExtension(ext);
             if (format is null)
             {
-                var sb = new StringBuilder();
-                sb.AppendLine($"No encoder was found for extension '{ext}'. Registered encoders include:");
+                StringBuilder sb = new();
+                sb.AppendLine(CultureInfo.InvariantCulture, $"No encoder was found for extension '{ext}'. Registered encoders include:");
                 foreach (IImageFormat fmt in source.GetConfiguration().ImageFormats)
                 {
-                    sb.AppendFormat(" - {0} : {1}{2}", fmt.Name, string.Join(", ", fmt.FileExtensions), Environment.NewLine);
+                    sb.AppendFormat(CultureInfo.InvariantCulture, " - {0} : {1}{2}", fmt.Name, string.Join(", ", fmt.FileExtensions), Environment.NewLine);
                 }
 
                 throw new NotSupportedException(sb.ToString());
@@ -48,11 +49,11 @@ public static IImageEncoder DetectEncoder(this Image source, string filePath)
 
             if (encoder is null)
             {
-                var sb = new StringBuilder();
-                sb.AppendLine($"No encoder was found for extension '{ext}' using image format '{format.Name}'. Registered encoders include:");
+                StringBuilder sb = new();
+                sb.AppendLine(CultureInfo.InvariantCulture, $"No encoder was found for extension '{ext}' using image format '{format.Name}'. Registered encoders include:");
                 foreach (KeyValuePair<IImageFormat, IImageEncoder> enc in source.GetConfiguration().ImageFormatsManager.ImageEncoders)
                 {
-                    sb.AppendFormat(" - {0} : {1}{2}", enc.Key, enc.Value.GetType().Name, Environment.NewLine);
+                    sb.AppendFormat(CultureInfo.InvariantCulture, " - {0} : {1}{2}", enc.Key, enc.Value.GetType().Name, Environment.NewLine);
                 }
 
                 throw new NotSupportedException(sb.ToString());
@@ -116,6 +117,7 @@ private static Configuration GetConfiguration(IConfigurationProvider source)
         /// Certain Image Processors may invalidate the returned <see cref="IMemoryGroup{T}"/> and all it's buffers,
         /// therefore it's not recommended to mutate the image while holding a reference to it's <see cref="IMemoryGroup{T}"/>.
         /// </remarks>
+        /// <exception cref="ArgumentNullException">Thrown when the <paramref name="source"/> in <see langword="null"/>.</exception>
         public static IMemoryGroup<TPixel> GetPixelMemoryGroup<TPixel>(this ImageFrame<TPixel> source)
             where TPixel : unmanaged, IPixel<TPixel>
             => source?.PixelBuffer.FastMemoryGroup.View ?? throw new ArgumentNullException(nameof(source));
@@ -131,13 +133,14 @@ public static IMemoryGroup<TPixel> GetPixelMemoryGroup<TPixel>(this ImageFrame<T
         /// Certain Image Processors may invalidate the returned <see cref="IMemoryGroup{T}"/> and all it's buffers,
         /// therefore it's not recommended to mutate the image while holding a reference to it's <see cref="IMemoryGroup{T}"/>.
         /// </remarks>
+        /// <exception cref="ArgumentNullException">Thrown when the <paramref name="source"/> in <see langword="null"/>.</exception>
         public static IMemoryGroup<TPixel> GetPixelMemoryGroup<TPixel>(this Image<TPixel> source)
             where TPixel : unmanaged, IPixel<TPixel>
             => source?.Frames.RootFrame.GetPixelMemoryGroup() ?? throw new ArgumentNullException(nameof(source));
 
         /// <summary>
         /// Gets the representation of the pixels as a <see cref="Span{T}"/> of contiguous memory
-        /// at row <paramref name="rowIndex"/> beginning from the the first pixel on that row.
+        /// at row <paramref name="rowIndex"/> beginning from the first pixel on that row.
         /// </summary>
         /// <typeparam name="TPixel">The type of the pixel.</typeparam>
         /// <param name="source">The source.</param>
@@ -154,8 +157,8 @@ public static Memory<TPixel> DangerousGetPixelRowMemory<TPixel>(this ImageFrame<
         }
 
         /// <summary>
-        /// Gets the representation of the pixels as <see cref="Span{T}"/> of of contiguous memory
-        /// at row <paramref name="rowIndex"/> beginning from the the first pixel on that row.
+        /// Gets the representation of the pixels as <see cref="Span{T}"/> of contiguous memory
+        /// at row <paramref name="rowIndex"/> beginning from the first pixel on that row.
         /// </summary>
         /// <typeparam name="TPixel">The type of the pixel.</typeparam>
         /// <param name="source">The source.</param>

src/ImageSharp/Advanced/AdvancedImageExtensions.cs

@@ -1,14 +1,17 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
+using System;
+
 namespace SixLabors.ImageSharp.Advanced
 {
     /// <summary>
     /// This is necessary to avoid being excluded from compilation in environments that do AOT builds, such as Unity's IL2CPP and Xamarin.
     /// The only thing that matters is the class name.
     /// There is no need to use or inherit from the PreserveAttribute class in each environment.
     /// </summary>
-    internal sealed class PreserveAttribute : System.Attribute
+    [AttributeUsage(AttributeTargets.Method)]
+    internal sealed class PreserveAttribute : Attribute
     {
     }
 }

src/ImageSharp/Advanced/PreserveAttribute.cs

@@ -151,7 +151,7 @@ public static Color FromPixel<TPixel>(TPixel pixel)
         [MethodImpl(InliningOptions.ShortMethod)]
         public static Color ParseHex(string hex)
         {
-            var rgba = Rgba32.ParseHex(hex);
+            Rgba32 rgba = Rgba32.ParseHex(hex);
 
             return new Color(rgba);
         }
@@ -193,6 +193,7 @@ public static bool TryParseHex(string hex, out Color result)
         /// <returns>
         /// The <see cref="Color"/>.
         /// </returns>
+        /// <exception cref="ArgumentException">Input string is not in the correct format.</exception>
         public static Color Parse(string input)
         {
             Guard.NotNull(input, nameof(input));
@@ -241,7 +242,7 @@ public static bool TryParse(string input, out Color result)
         /// <returns>The color having it's alpha channel altered.</returns>
         public Color WithAlpha(float alpha)
         {
-            var v = (Vector4)this;
+            Vector4 v = (Vector4)this;
             v.W = alpha;
             return new Color(v);
         }
@@ -290,12 +291,12 @@ public TPixel ToPixel<TPixel>()
         /// <param name="source">The source color span.</param>
         /// <param name="destination">The destination pixel span.</param>
         [MethodImpl(InliningOptions.ShortMethod)]
-        public static void ToPixel<TPixel>(
-            Configuration configuration,
-            ReadOnlySpan<Color> source,
-            Span<TPixel> destination)
+#pragma warning disable RCS1163 // Unused parameter.
+        public static void ToPixel<TPixel>(Configuration configuration, ReadOnlySpan<Color> source, Span<TPixel> destination)
+#pragma warning restore RCS1163 // Unused parameter.
             where TPixel : unmanaged, IPixel<TPixel>
         {
+            // TODO: Investigate bulk operations utilizing configuration parameter here.
             Guard.DestinationShouldNotBeTooShort(source, destination, nameof(destination));
             for (int i = 0; i < source.Length; i++)
             {

src/ImageSharp/Color/Color.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Six Labors.
+// Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
 using System;
@@ -19,29 +19,6 @@ namespace SixLabors.ImageSharp.ColorSpaces
         /// </summary>
         public static readonly CieXyz DefaultWhitePoint = Illuminants.D50;
 
-        /// <summary>
-        /// Gets the lightness dimension.
-        /// <remarks>A value usually ranging between 0 (black), 100 (diffuse white) or higher (specular white).</remarks>
-        /// </summary>
-        public readonly float L;
-
-        /// <summary>
-        /// Gets the a color component.
-        /// <remarks>A value usually ranging from -100 to 100. Negative is green, positive magenta.</remarks>
-        /// </summary>
-        public readonly float A;
-
-        /// <summary>
-        /// Gets the b color component.
-        /// <remarks>A value usually ranging from -100 to 100. Negative is blue, positive is yellow</remarks>
-        /// </summary>
-        public readonly float B;
-
-        /// <summary>
-        /// Gets the reference white point of this color
-        /// </summary>
-        public readonly CieXyz WhitePoint;
-
         /// <summary>
         /// Initializes a new instance of the <see cref="CieLab"/> struct.
         /// </summary>
@@ -95,6 +72,29 @@ public CieLab(Vector3 vector, CieXyz whitePoint)
             this.WhitePoint = whitePoint;
         }
 
+        /// <summary>
+        /// Gets the lightness dimension.
+        /// <remarks>A value usually ranging between 0 (black), 100 (diffuse white) or higher (specular white).</remarks>
+        /// </summary>
+        public readonly float L { get; }
+
+        /// <summary>
+        /// Gets the a color component.
+        /// <remarks>A value usually ranging from -100 to 100. Negative is green, positive magenta.</remarks>
+        /// </summary>
+        public readonly float A { get; }
+
+        /// <summary>
+        /// Gets the b color component.
+        /// <remarks>A value usually ranging from -100 to 100. Negative is blue, positive is yellow</remarks>
+        /// </summary>
+        public readonly float B { get; }
+
+        /// <summary>
+        /// Gets the reference white point of this color
+        /// </summary>
+        public readonly CieXyz WhitePoint { get; }
+
         /// <summary>
         /// Compares two <see cref="CieLab"/> objects for equality.
         /// </summary>
@@ -128,12 +128,10 @@ public CieLab(Vector3 vector, CieXyz whitePoint)
 
         /// <inheritdoc/>
         [MethodImpl(InliningOptions.ShortMethod)]
-        public bool Equals(CieLab other)
-        {
-            return this.L.Equals(other.L)
-                && this.A.Equals(other.A)
-                && this.B.Equals(other.B)
-                && this.WhitePoint.Equals(other.WhitePoint);
-        }
+        public bool Equals(CieLab other) =>
+            this.L.Equals(other.L)
+            && this.A.Equals(other.A)
+            && this.B.Equals(other.B)
+            && this.WhitePoint.Equals(other.WhitePoint);
     }
 }