# Conflicts:

#	version.json

Author: rjmurillo

Diff for: .config/dotnet-tools.json

@@ -15,6 +15,13 @@
         "dotnet-verify"
       ],
       "rollForward": false
+    },
+    "squigglecop.tool": {
+      "version": "1.0.13",
+      "commands": [
+        "dotnet-squigglecop"
+      ],
+      "rollForward": false
     }
   }
 }

Diff for: .github/workflows/main.yml

@@ -32,7 +32,7 @@ jobs:
   build:
     strategy:
       matrix:
-        os: [windows-2022, ubuntu-22.04]
+        os: [windows-latest, ubuntu-latest]
 
     runs-on: ${{ matrix.os }}
 
@@ -92,6 +92,13 @@ jobs:
         path: |
           **/*.received.*
 
+    - name: Upload SARIF files
+      uses: actions/upload-artifact@v4
+      if: success() || failure()
+      with:
+        name: SARIF files (${{ matrix.os }})
+        path: ./artifacts/obj/**/*.sarif
+
     - name: Upload Test Report
       uses: actions/upload-artifact@v4
       if: success() || failure()

Diff for: .github/workflows/release.yml

@@ -5,13 +5,19 @@ on:
   release:
     types:
       - published # Run the workflow when a new GitHub release is published
+      - edited
+      - prereleased
+      - released
 
 permissions:
   security-events: write  # required for CodeQL
   packages: read
   contents: read
   actions: read
 
+env:
+  PublicRelease: true # We want to generate stable package versions without the git hash in this action
+
 jobs:
   build:
     uses: ./.github/workflows/main.yml

Diff for: CONTRIBUTING.md

@@ -4,4 +4,14 @@ We welcome contributions. If you want to contribute to existing issues, check th
 [help wanted](https://github.com/rjmurillo/EffectiveCSharp.Analyzers/labels/help%20wanted) or
 [good first issue](https://github.com/rjmurillo/EffectiveCSharp.Analyzers/labels/good%20first%20issue) items in the backlog.
 
-If you have new ideas or want to complain about bugs, feel free to [create a new issue](https://github.com/rjmurillo/EffectiveCSharp.Analyzers/issues/new).
+If you have new ideas or want to complain about bugs, feel free to [create a new issue](https://github.com/rjmurillo/EffectiveCSharp.Analyzers/issues/new).
+
+## Updating SquiggleCop baselines
+
+To update SquiggleCop baselines, run this command and review and commit the results:
+
+```powershell
+dotnet clean && dotnet build /p:PedanticMode=true /p:SquiggleCop_AutoBaseline=true
+```
+
+`$(PedanticMode)` turns on the CI configuration (e.g. `TreatWarningsAsErrors`) and `$(SquiggleCop_AutoBaseline)`

Diff for: build/perf/baseline.json

@@ -1,5 +1,5 @@
 {
-    "release": "1.0.0",
-    "label": "v.1.0.0",
-    "sha": "e76647befbd50a2af11a4b888287542738b6e934"
+    "release": "0.1.0",
+    "label": "v0.1.0",
+    "sha": "c0c5d965e88f59c3acbd867a74b55eed052df5b1"
   }

Diff for: build/scripts/Set-SquiggleCopBaseline.ps1

@@ -0,0 +1,3 @@
+Get-ChildItem *.csproj -recurse -File | ForEach-Object{ 
+    dotnet clean $_.FullName && dotnet build $_.FullName /p:PedanticMode=true /p:SquiggleCop_AutoBaseline=true 
+}

Diff for: build/targets/codeanalysis/CodeAnalysis.props

@@ -32,6 +32,10 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="SquiggleCop.Tasks">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

Diff for: build/targets/codeanalysis/CodeAnalysis.targets

@@ -1,2 +1,24 @@
 <Project>
+  <PropertyGroup Label="Computed properties">
+    <PedanticMode Condition=" '$(PedanticMode)' == '' ">$([MSBuild]::ValueOrDefault('$(ContinuousIntegrationBuild)', 'false'))</PedanticMode>
+    <TreatWarningsAsErrors>$(PedanticMode)</TreatWarningsAsErrors>
+    <MSBuildTreatWarningsAsErrors>$(PedanticMode)</MSBuildTreatWarningsAsErrors>
+    <SquiggleCop_Enabled>$(PedanticMode)</SquiggleCop_Enabled>
+  </PropertyGroup>
+
+  <Target Name="SetErrorLog" BeforeTargets="CoreCompile">
+    <!--
+      ErrorLog is needed for SquiggleCop.
+
+      The value is set in a Target and not directly as a property because `$(IntermediateOutputPath)` and `$(OutputPath)`
+      are calculated properties and thus shouldn't be relied on during the initial property evaluation phase.
+      See https://github.com/dotnet/sdk/issues/41852.
+
+      We use `$(IntermediateOutputPath)` to ensure the file ends up in the `obj/` folder and not with sources to clearly
+      delineate inputs and outputs.
+    -->
+    <PropertyGroup Condition=" '$(ErrorLog)' == '' ">
+      <ErrorLog>$(IntermediateOutputPath)/$(MSBuildProjectName).sarif,version=2.1</ErrorLog>
+    </PropertyGroup>
+  </Target>
 </Project>

Diff for: build/targets/codeanalysis/Packages.props

@@ -4,7 +4,8 @@
     <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" />
     <PackageVersion Include="Roslynator.Analyzers" Version="4.12.4" />
     <PackageVersion Include="StyleCop.Analyzers" Version="1.2.0-beta.556" />
-    <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.30.0.95878" />    
+    <PackageVersion Include="SonarAnalyzer.CSharp" Version="9.30.0.95878" />
+    <PackageVersion Include="SquiggleCop.Tasks" Version="1.0.8" />
     <PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.10.48" />
     <PackageVersion Include="ExhaustiveMatching.Analyzer" Version="0.5.0" />
   </ItemGroup>

Diff for: build/targets/compiler/Compiler.props

@@ -5,13 +5,6 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
-  <ItemGroup>
-    <PackageReference Include="PolySharp">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
-    </PackageReference>
-  </ItemGroup>
-
   <ItemGroup>
     <AssemblyAttribute Include="System.CLSCompliantAttribute">
       <_Parameter1>false</_Parameter1>

Diff for: build/targets/compiler/Packages.props

@@ -1,5 +1,4 @@
 <Project>
-  <ItemGroup>
-    <PackageVersion Include="PolySharp" Version="1.14.1" />
-</ItemGroup>
+  <ItemGroup>    
+  </ItemGroup>
 </Project>

Diff for: docs/DOCUMENTING-ANALYZERS.md

@@ -40,7 +40,7 @@ private static readonly DiagnosticDescriptor Rule = new(
     category: "Maintainability",
     defaultSeverity: DiagnosticSeverity.Info,
     isEnabledByDefault: true,
-    helpLinkUri: $"https://github.com/rjmurillo/EffectiveCSharp.Analyzers/blob/{ThisAssembly.GitCommitId}/docs/{Id}.md");
+    helpLinkUri: $"https://github.com/rjmurillo/EffectiveCSharp.Analyzers/blob/{ThisAssembly.GitCommitId}/docs/rules/{Id}.md");
 ```
 
 The documentation for the rule is placed in to `docs/rules/ECS0002.md`.

Diff for: docs/RULE-REFERENCE-TEMPLATE.md

@@ -10,6 +10,23 @@ This rule is described in detail in [Effective C#: 50 Specific Ways to Improve y
 
 ## When to suppress warnings
 
+### Suppress a warning
+
+If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.
+
+```csharp
+#pragma warning disable RULEID
+// The code that's violating the rule
+#pragma warning restore RULEID
+```
+
+To disable the rule for a file, folder, or project, set its severity to none in the [configuration file](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files).
+
+```ini
+[*.cs]
+dotnet_diagnostic.RULEID.severity = none
+```
+
 ## Example of a violation
 
 ### Description

Diff for: docs/rules/ECS0002.md

@@ -1,4 +1,4 @@
-# PRC001: Prefer readonly over const
+# ECS0002: Prefer readonly over const
 
 ## Cause
 Using `const` fields for constants that do not need to be available at compile time.

Diff for: docs/rules/ECS0004.md

@@ -0,0 +1,59 @@
+# ECS0004: Replace string.Format with interpolated string
+
+This rule is described in detail in [Effective C#: 50 Specific Ways to Improve your C#](https://www.oreilly.com/library/view/effective-c-50/9780134579290/).
+
+## Cause
+
+Using `string.Format` for formatting strings instead of using interpolated strings.
+
+## Rule description
+
+This rule identifies the usage of `string.Format` method and suggests replacing it with C# interpolated strings. Interpolated strings enhance code readability and reduce the likelihood of runtime errors associated with mismatched format arguments.
+
+## How to fix violations
+
+Replace the usage of `string.Format` with an interpolated string. Interpolated strings are more readable and less error-prone compared to `string.Format`.
+
+## When to suppress warnings
+
+Suppress this warning if you have a specific reason to use `string.Format`, such as when dynamically constructing the format string at runtime or when maintaining compatibility with older code bases that rely on `string.Format`.
+
+## Example of a violation
+
+### Description
+
+Using `string.Format` to format a string.
+
+### Code
+
+```csharp
+class Program
+{
+    void Main()
+    {
+        var str = string.Format("Hello, {0}!", "world");
+    }
+}
+
+## Example of how to fix
+
+### Description
+
+Replacing `string.Format` with an interpolated string.
+
+### Code
+
+```csharp
+class Program
+{
+    void Main()
+    {
+        var world = "world";
+        var str = $"Hello, {world}!";
+    }
+}
+```
+
+## Related rules
+
+[ECS0009: Minimize boxing and unboxing](./ECS0009.md)

Diff for: docs/rules/ECS0005.md

@@ -0,0 +1,72 @@
+# ECS0005: Prefer FormattableString for culture-specific strings
+
+This rule is discussed in detail in [Effective C#: 50 Specific Ways to Improve your C#](https://www.oreilly.com/library/view/effective-c-50/9780134579290/). Guidance about the feature can be found on the [.NET Blog - String Interpolation in C# 10 and .NET 6](https://devblogs.microsoft.com/dotnet/string-interpolation-in-c-10-and-net-6/).
+
+## Cause
+
+The rule is triggered when a `string` is used for an interpolated string that could benefit from culture-specific formatting. 
+
+## Rule description
+
+There are still valid use cases for `string.Format` and `StringBuilder.AppendFormat` where the composite format string isn't known at compile time (e.g., localized resources). However, if the string would otherwise be hardcoded into the C#, interpolated are preferred (from a performance perspective). Using `FormattableString` or `string.Create` instead of `string` for interpolated strings ensures that culture-specific formatting is correctly applied, preventing issues where the default culture may lead to incorrect string representations.
+
+## How to fix violations
+
+Replace the `string` with `FormattableString` where culture-specific formatting is required. For example, use `FormattableString.Invariant(...)` or `FormattableString.ToString(IFormatProvider)` as needed.
+
+## When to suppress warnings
+
+Suppress warnings if the default culture is explicitly intended, or the string does not require culture-specific formatting.
+
+### Suppress a warning
+
+If you want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.
+
+```csharp
+#pragma warning disable ECS0005
+// The code that's violating the rule
+#pragma warning restore ECS0005
+```
+
+To disable the rule for a file, folder, or project, set its severity to none in the [configuration file](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files).
+
+```ini
+[*.cs]
+dotnet_diagnostic.ECS0005.severity = none
+```
+
+## Example of a violation
+
+### Description
+
+Using `string` for an interpolated string that requires culture-specific formatting.
+
+### Code
+
+```csharp
+public string GetMessage()
+{
+    double value = 299792.458;
+    return $"The speed of light is {value:N3} km/s."; // ECS0005 triggers here
+}
+```
+
+## Example of how to fix
+
+### Description
+
+Replace `string` with `FormattableString` to handle culture-specific formatting.
+
+### Code
+
+```csharp
+public string GetMessage()
+{
+    double value = 299792.458;
+    return FormattableString.Invariant($"The speed of light is {value:N3} km/s.");
+}
+```
+
+## Related rules
+
+[ECS0004: Replace string.Format with interpolated string](./ECS0004.md)