Add initial StyleCop config

jeremy-visionaid · jeremy-visionaid · commit 35e939559571 · 2025-11-24T21:55:41.000+13:00
diff --git a/.editorconfig b/.editorconfig
@@ -250,6 +250,9 @@ dotnet_diagnostic.SA1121.severity = none
 # SA1124: Do not use regions
 dotnet_diagnostic.SA1124.severity = suggestion
 
+# SA1201: Elements must appear in the correct order
+dotnet_diagnostic.SA1201.severity = suggestion
+
 # SA1202: Elements should be ordered by access
 dotnet_diagnostic.SA1202.severity = none
 
@@ -277,6 +280,9 @@ dotnet_diagnostic.SA1513.severity = none
 # SA1600: Elements should be documented
 dotnet_diagnostic.SA1600.severity = none
 
+# SA1633: The file header is missing or not located at the top of the file
+dotnet_diagnostic.SA1633.severity = none
+
 # S1104: Fields should not have public accessibility
 dotnet_diagnostic.S1104.severity = none
 
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -16,6 +16,7 @@
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
     <PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.183" />
     <PackageVersion Include="MSTest" Version="4.0.2" />
+    <PackageVersion Include="StyleCop.Analyzers.Unstable" Version="1.2.0.556" />
     <PackageVersion Include="System.Collections.Immutable" Version="8.0.0" />
     <PackageVersion Include="System.Memory" Version="4.6.0" />
     <PackageVersion Include="System.Text.Encoding.CodePages" Version="8.0.0" />
diff --git a/Directory.csproj.props b/Directory.csproj.props
@@ -39,4 +39,13 @@
     <!-- Workaround for https://github.com/dotnet/roslyn/issues/41640 -->
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
+
+  <!-- StyleCop -->
+  <ItemGroup>
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" Visible="false" />
+    <PackageReference Include="StyleCop.Analyzers.Unstable">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
 </Project>
diff --git a/OpenMcdf.Ole.Tests/OlePropertiesExtensionsTests.cs b/OpenMcdf.Ole.Tests/OlePropertiesExtensionsTests.cs
@@ -3,9 +3,6 @@
 
 namespace OpenMcdf.Ole.Tests;
 
-/// <summary>
-/// Summary description for UnitTest1.
-/// </summary>
 [TestClass]
 public class OlePropertiesExtensionsTests
 {
diff --git a/OpenMcdf.Ole/.editorconfig b/OpenMcdf.Ole/.editorconfig
@@ -0,0 +1,13 @@
+# C# files
+[*.cs]
+
+dotnet_analyzer_diagnostic.category-StyleCop.CSharp.DocumentationRules.severity = none
+
+# SA1108: Block statements should not contain embedded comments
+dotnet_diagnostic.SA1108.severity = none
+
+# SA1204: Static members should appear before non-static members
+dotnet_diagnostic.SA1204.severity = none
+
+# SA1515: Single-line comment should be preceded by blank line
+dotnet_diagnostic.SA1515.severity = none
diff --git a/OpenMcdf.Ole/TypedPropertyValue.cs b/OpenMcdf.Ole/TypedPropertyValue.cs
@@ -3,6 +3,8 @@
 internal abstract class TypedPropertyValue<T> : ITypedPropertyValue
 {
     private readonly VTPropertyType vtType;
+
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "TODO")]
     protected object? propertyValue;
 
     public PropertyType PropertyType => PropertyType.TypedPropertyValue;
diff --git a/OpenMcdf.Tests/TestData.cs b/OpenMcdf.Tests/TestData.cs
@@ -5,6 +5,8 @@ public static class TestData
     /// <summary>
     /// Fill with bytes equal to their position modulo 256.
     /// </summary>
+    /// <param name="length">The number of bytes to include in the array.</param>
+    /// <returns>A byte array where each element is set to its index value modulo 256.</returns>
     public static byte[] CreateByteArray(int length)
     {
         byte[] expectedBuffer = new byte[length];
diff --git a/OpenMcdf.slnx b/OpenMcdf.slnx
@@ -11,6 +11,7 @@
     <File Path="global.json" />
     <File Path="License.txt" />
     <File Path="README.md" />
+    <File Path="stylecop.json" />
   </Folder>
   <Project Path="OpenMcdf.Benchmarks/OpenMcdf.Benchmarks.csproj" />
   <Project Path="OpenMcdf.Ole.Tests/OpenMcdf.Ole.Tests.csproj" />
diff --git a/OpenMcdf/DirectoryTree.cs b/OpenMcdf/DirectoryTree.cs
@@ -172,7 +172,7 @@ public void Remove(DirectoryEntry entry)
             {
                 uint newRightChildParentId = entry.LeftSiblingId;
                 DirectoryEntry newRightChildParent;
-                for (; ; )
+                while (true)
                 {
                     newRightChildParent = directories.GetDictionaryEntry(newRightChildParentId);
                     newRightChildParentId = newRightChildParent.RightSiblingId;
diff --git a/OpenMcdf/EntryInfo.cs b/OpenMcdf/EntryInfo.cs
@@ -1,8 +1,18 @@
 ﻿namespace OpenMcdf;
 
+/// <summary>
+/// Specifies the type of entry for a <see cref="EntryInfo"/>.
+/// </summary>
 public enum EntryType
 {
+    /// <summary>
+    /// A storage entry, which may contain other entries.
+    /// </summary>
     Storage,
+
+    /// <summary>
+    /// A stream entry containing binary data.
+    /// </summary>
     Stream,
 }
 
diff --git a/OpenMcdf/FatChainEnumerator.cs b/OpenMcdf/FatChainEnumerator.cs
@@ -108,7 +108,7 @@ public bool MoveNext()
     /// <summary>
     /// Moves to the specified index within the FAT sector chain.
     /// </summary>
-    /// <param name="index"></param>
+    /// <param name="index">The index to move to.</param>
     /// <returns>true if the enumerator was successfully advanced to the given index.</returns>
     public bool MoveTo(uint index)
     {
diff --git a/OpenMcdf/MiniFatChainEnumerator.cs b/OpenMcdf/MiniFatChainEnumerator.cs
@@ -105,7 +105,7 @@ public bool MoveNext()
     /// <summary>
     /// Moves to the specified index within the mini FAT sector chain.
     /// </summary>
-    /// <param name="index"></param>
+    /// <param name="index">The index to move to.</param>
     /// <returns>true if the enumerator was successfully advanced to the given index.</returns>
     public bool MoveTo(uint index)
     {
diff --git a/OpenMcdf/RootStorage.cs b/OpenMcdf/RootStorage.cs
@@ -7,6 +7,9 @@ namespace OpenMcdf;
 /// </summary>
 public enum Version : ushort
 {
+    /// <summary>
+    /// Unknown version.
+    /// </summary>
     Unknown = 0,
 
     /// <summary>
diff --git a/StructuredStorage/.editorconfig b/StructuredStorage/.editorconfig
@@ -0,0 +1,4 @@
+# C# files
+[*.cs]
+
+dotnet_analyzer_diagnostic.category-StyleCop.CSharp.DocumentationRules.severity = none
diff --git a/StructuredStorageExplorer/.editorconfig b/StructuredStorageExplorer/.editorconfig
@@ -0,0 +1,7 @@
+# C# files
+[*.cs]
+
+dotnet_analyzer_diagnostic.category-StyleCop.CSharp.DocumentationRules.severity = none
+
+# SA1204: Static members should appear before non-static members
+dotnet_diagnostic.SA1204.severity = none
diff --git a/stylecop.json b/stylecop.json
@@ -0,0 +1,18 @@
+{
+  "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
+  "settings": {
+    "documentationRules": {
+      "companyName": "OpenMcdf",
+      "copyrightText": "Copyright © 2010-2025, Federico Blaseotto, Jeremy Powell",
+      "documentInterfaces": false,
+      "documentExposedElements": true,
+      "documentInternalElements": false,
+      "documentPrivateElements": false,
+      "documentPrivateFields": false,
+      "xmlHeader": false
+    },
+    "layoutRules": {
+      "allowDoWhileOnClosingBrace": true
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,6 @@`
`3`	`3`
`4`	`4`	`namespace OpenMcdf.Ole.Tests;`
`5`	`5`
`6`		`-/// <summary>`
`7`		`-/// Summary description for UnitTest1.`
`8`		`-/// </summary>`
`9`	`6`	`[TestClass]`
`10`	`7`	`public class OlePropertiesExtensionsTests`
`11`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`internal abstract class TypedPropertyValue<T> : ITypedPropertyValue`
`4`	`4`	`{`
`5`	`5`	`private readonly VTPropertyType vtType;`
	`6`	`+`
	`7`	`+ [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "TODO")]`
`6`	`8`	`protected object? propertyValue;`
`7`	`9`
`8`	`10`	`public PropertyType PropertyType => PropertyType.TypedPropertyValue;`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@ public static class TestData`
`5`	`5`	`/// <summary>`
`6`	`6`	`/// Fill with bytes equal to their position modulo 256.`
`7`	`7`	`/// </summary>`
	`8`	`+ /// <param name="length">The number of bytes to include in the array.</param>`
	`9`	`+ /// <returns>A byte array where each element is set to its index value modulo 256.</returns>`
`8`	`10`	`public static byte[] CreateByteArray(int length)`
`9`	`11`	`{`
`10`	`12`	`byte[] expectedBuffer = new byte[length];`
Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ public void Remove(DirectoryEntry entry)`
`172`	`172`	`{`
`173`	`173`	`uint newRightChildParentId = entry.LeftSiblingId;`
`174`	`174`	`DirectoryEntry newRightChildParent;`
`175`		`- for (; ; )`
	`175`	`+ while (true)`
`176`	`176`	`{`
`177`	`177`	`newRightChildParent = directories.GetDictionaryEntry(newRightChildParentId);`
`178`	`178`	`newRightChildParentId = newRightChildParent.RightSiblingId;`