Merge RoslynAnalyzers into Roslyn

.editorconfig

@@ -154,7 +154,7 @@ dotnet_diagnostic.IDE0055.severity = warning
 # https://github.com/dotnet/roslyn-analyzers/issues/7436 - False positives from valid GetDeclaredSymbol calls
 dotnet_diagnostic.RS1039.severity = none
 
-# These xUnit analyzers were disabled temporarily to let us move to the 
+# These xUnit analyzers were disabled temporarily to let us move to the
 # new xUnit and get past several component governance issues. The
 # following issue tracks enabling them
 #

.github/CODEOWNERS

@@ -1,5 +1,6 @@
 # Automatically request reviews when a pull request changes any owned files
-# More information: https://github.com/blog/2392-introducing-code-owners 
+
+# More information: https://github.com/blog/2392-introducing-code-owners
 
 *.yml @dotnet/roslyn-infrastructure
 .github/ @dotnet/roslyn-infrastructure
@@ -15,15 +16,20 @@ scripts/ @dotnet/roslyn-infrastructure
 src/Analyzers/ @dotnet/roslyn-ide
 src/CodeStyle/ @dotnet/roslyn-ide
 src/Compilers/ @dotnet/roslyn-compiler
+
 # Both IDE and Compiler traits are in this file, so we don't want to ping each other for changes to just this file.
+
 # Technically this means that if someone changes _just_ this file no reviewers will be tagged, but this isn't likely
+
 # to happen.
+
 src/Compilers/Test/Core/Traits/Traits.cs
 src/EditorFeatures/ @dotnet/roslyn-ide
 src/Features/ @dotnet/roslyn-ide
 src/Interactive/ @dotnet/roslyn-interactive
 src/LanguageServer/ @dotnet/roslyn-ide
 src/NuGet/ @dotnet/roslyn-infrastructure
+src/RoslynAnalyzers/ @dotnet/roslyn-ide
 src/Scripting/ @dotnet/roslyn-interactive
 src/Setup/ @dotnet/roslyn-infrastructure
 src/Tools/AnalyzerRunner @dotnet/roslyn-ide

docs/roslyn-analyzers/README.md

@@ -0,0 +1,37 @@
+# Roslyn Analyzers
+
+## Microsoft.CodeAnalysis.Analyzers
+
+*Latest stable version:* <sub>[![NuGet](https://img.shields.io/nuget/v/Microsoft.CodeAnalysis.Analyzers.svg)](https://www.nuget.org/packages/Microsoft.CodeAnalysis.Analyzers)</sub>
+
+*Latest pre-release version:* [here](https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet7/NuGet/Microsoft.CodeAnalysis.Analyzers/versions)
+
+This package contains rules for correct usage of APIs from the [Microsoft.CodeAnalysis](https://www.nuget.org/packages/Microsoft.CodeAnalysis) NuGet package, i.e. .NET Compiler Platform ("Roslyn") APIs. These are primarily aimed towards helping authors of diagnostic analyzers and code fix providers to invoke the Microsoft.CodeAnalysis APIs in a recommended manner. [More info about rules in this package](../../src/RoslynAnalyzers/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.md)
+
+## Roslyn.Diagnostics.Analyzers
+
+*Latest stable version:* <sub>[![NuGet](https://img.shields.io/nuget/v/Roslyn.Diagnostics.Analyzers.svg)](https://www.nuget.org/packages/Roslyn.Diagnostics.Analyzers)</sub>
+
+*Latest pre-release version:* [here](https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet7/NuGet/Roslyn.Diagnostics.Analyzers/versions)
+
+This package contains rules that are very specific to the .NET Compiler Platform ("Roslyn") project, i.e. [dotnet/roslyn](https://github.com/dotnet/roslyn) repo. This analyzer package is *not intended for general consumption* outside the Roslyn repo. [More info about rules in this package](../../src/RoslynAnalyzers/Roslyn.Diagnostics.Analyzers/Roslyn.Diagnostics.Analyzers.md)
+
+## Microsoft.CodeAnalysis.BannedApiAnalyzers
+
+*Latest stable version:* <sub>[![NuGet](https://img.shields.io/nuget/v/Microsoft.CodeAnalysis.BannedApiAnalyzers.svg)](https://www.nuget.org/packages/Microsoft.CodeAnalysis.BannedApiAnalyzers)</sub>
+
+*Latest pre-release version:* [here](https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet7/NuGet/Microsoft.CodeAnalysis.BannedApiAnalyzers/versions)
+
+This package contains customizable rules for identifying references to banned APIs. [More info about rules in this package](../../src/RoslynAnalyzers/Microsoft.CodeAnalysis.BannedApiAnalyzers/Microsoft.CodeAnalysis.BannedApiAnalyzers.md)
+
+For instructions on using this analyzer, see [Instructions](../../src/RoslynAnalyzers/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md).
+
+## Microsoft.CodeAnalysis.PublicApiAnalyzers
+
+*Latest stable version:* <sub>[![NuGet](https://img.shields.io/nuget/v/Microsoft.CodeAnalysis.PublicApiAnalyzers.svg)](https://www.nuget.org/packages/Microsoft.CodeAnalysis.PublicApiAnalyzers)</sub>
+
+*Latest pre-release version:* [here](https://dev.azure.com/dnceng/public/_artifacts/feed/dotnet7/NuGet/Microsoft.CodeAnalysis.PublicApiAnalyzers/versions)
+
+This package contains rules to help library authors monitoring change to their public APIs. [More info about rules in this package](../../src/RoslynAnalyzers/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.md)
+
+For instructions on using this analyzer, see [Instructions](../../src/RoslynAnalyzers/PublicApiAnalyzers/PublicApiAnalyzers.Help.md).

docs/roslyn-analyzers/rules/RS1022.md

@@ -0,0 +1,22 @@
+## RS1022: Do not use types from Workspaces assembly in an analyzer
+
+Diagnostic analyzer types should not use types from Workspaces assemblies. Workspaces assemblies are only available when the analyzer executes in Visual Studio IDE live analysis, but are not available during command line build. Referencing types from Workspaces assemblies will lead to runtime exception during analyzer execution in command line build.
+
+|Item|Value|
+|-|-|
+|Category|MicrosoftCodeAnalysisCorrectness|
+|Enabled|True|
+|Severity|Warning|
+|CodeFix|False|
+---
+
+> **Warning**
+>
+> The analysis performed by RS1022 is slow and relies on implementation details of the JIT compiler for correctness.
+> Authors of compiler extensions are encouraged to use the stricter (and faster) analyzer RS1038 instead of this rule.
+>
+> RS1038 is enabled by default. To enable RS1022 instead, the following configuration may be added to **.globalconfig**:
+>
+> ```ini
+> roslyn_correctness.assembly_reference_validation = relaxed
+> ```

docs/roslyn-analyzers/rules/RS1038.md

@@ -0,0 +1,46 @@
+## RS1038: Compiler extensions should be implemented in assemblies with compiler-provided references
+
+Types which implement compiler extension points should not be declared in assemblies that contain references to assemblies which are not provided by all compilation scenarios. Doing so may cause the feature to behave unpredictably.
+
+|Item|Value|
+|-|-|
+|Category|MicrosoftCodeAnalysisCorrectness|
+|Enabled|True|
+|Severity|Warning|
+|CodeFix|False|
+---
+
+This rule helps ensure compiler extensions (e.g. analyzers and source generators) will load correctly in all compilation
+scenarios. Depending on the manner in which the compiler is invoked, some assemblies may not be present during a build,
+and attempting to reference them will result in exceptions that prevent the compiler extension from loading. RS1038 is
+the most strict and best performing validation for this scenario.
+
+RS1038 is enabled by default unless relaxed validation has been manually enabled in **.globalconfig** as described in
+[RS1022](RS1022.md).
+
+### Rules for compiler feature references
+
+* Compiler features supporting C# code should only reference the NuGet packages **Microsoft.CodeAnalysis.Common** and/or **Microsoft.CodeAnalysis.CSharp**
+* Compiler features supporting Visual Basic code should only reference **Microsoft.CodeAnalysis.Common** and/or **Microsoft.CodeAnalysis.VisualBasic**
+* Compiler features supporting both C# and Visual Basic should only reference **Microsoft.CodeAnalysis.Common**
+* Compiler features should not be implemented in assemblies containing a reference to **Microsoft.CodeAnalysis.Workspaces.Common**
+
+> **Note**
+>
+> This analyzer only checks references to the core Roslyn assemblies. Compiler extensions with other dependencies may
+> face restrictions and/or packaging requirements outside the scope of this analyzer.
+
+### Compiler extension points
+
+The following compiler extension points are examined by this analyzer:
+
+* `DiagnosticAnalyzer`
+* `DiagnosticSuppressor`
+* `ISourceGenerator`
+* `IIncrementalGenerator`
+
+### Other extension points
+
+Some extension points provided by Roslyn are IDE extensions (e.g. code fixes and completion providers). These features
+may ship in the same package as compiler features, but should be implemented in their own assembly since they require a
+reference to non-compiler package **Microsoft.CodeAnalysis.Workspaces.Common**.

docs/roslyn-analyzers/rules/RS1041.md

@@ -0,0 +1,25 @@
+## RS1041: Compiler extensions should be implemented in assemblies targeting netstandard2.0
+
+Types which implement compiler extension points should only be declared in assemblies targeting netstandard2.0. More specific target frameworks are only available in a subset of supported compilation scenarios, so targeting them may cause the feature to behave unpredictably.
+
+|Item|Value|
+|-|-|
+|Category|MicrosoftCodeAnalysisCorrectness|
+|Enabled|True|
+|Severity|Warning|
+|CodeFix|False|
+---
+
+This rule helps ensure compiler extensions (e.g. analyzers and source generators) will load correctly in all compilation
+scenarios. Depending on the manner in which the compiler is invoked, the compiler may execute under .NET Framework or
+.NET, and compiler extensions are expected to work consistently in both cases. By targeting netstandard2.0, compiler
+extensions are known to be compatible with both execution environments.
+
+### Compiler extension points
+
+The following compiler extension points are examined by this analyzer:
+
+* `DiagnosticAnalyzer`
+* `DiagnosticSuppressor`
+* `ISourceGenerator`
+* `IIncrementalGenerator`

eng/Directory.Packages.props

@@ -21,6 +21,8 @@
     <MicrosoftWindowsDesktopAppRuntimePackagesVersion>8.0.10</MicrosoftWindowsDesktopAppRuntimePackagesVersion>
     <_xunitVersion>2.9.2</_xunitVersion>
     <SqliteVersion>2.1.0</SqliteVersion>
+    <!-- HumanizerVersion is referenced from the Text.Analyzers.Package.csproj -->
+    <HumanizerVersion>2.14.1</HumanizerVersion>
   </PropertyGroup>
 
   <!--
@@ -116,7 +118,7 @@
     <PackageVersion Include="Nerdbank.Streams" Version="2.11.79" />
     <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageVersion Include="StreamJsonRpc" Version="2.21.10" />
-    
+
     <!--
       VS Debugger
     -->
@@ -225,8 +227,12 @@
     <PackageVersion Include="SQLitePCLRaw.bundle_green" Version="$(SqliteVersion)" />
     <PackageVersion Include="SQLitePCLRaw.lib.e_sqlite3" Version="$(SqliteVersion)" />
     <PackageVersion Include="SQLitePCLRaw.provider.dynamic_cdecl" Version="$(SqliteVersion)" />
+    <PackageVersion Include="SQLitePCLRaw.lib.e_sqlite3.linux" Version="$(SqliteVersion)" />
+    <PackageVersion Include="SQLitePCLRaw.lib.e_sqlite3.osx" Version="$(SqliteVersion)" />
+    <PackageVersion Include="SQLitePCLRaw.lib.e_sqlite3.v110_xp" Version="$(SqliteVersion)" />
+    <PackageVersion Include="SQLitePCLRaw.provider.e_sqlite3.net45" Version="$(SqliteVersion)" />
 
-    <PackageVersion Include="Humanizer.Core" Version="2.14.1" />
+    <PackageVersion Include="Humanizer.Core" Version="$(HumanizerVersion)" />
     <PackageVersion Include="ICSharpCode.Decompiler" Version="8.2.0.7535" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Elfie" Version="1.0.0" />
 
@@ -237,10 +243,15 @@
     <PackageVersion Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.13.0" />
     <PackageVersion Include="BasicUndo" Version="0.9.3" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Analyzer.Testing.XUnit" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.CodeFix.Testing" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.CodeFix.Testing.XUnit" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.CodeRefactoring.Testing" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.CodeRefactoring.Testing.XUnit" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.Test.Resources.Proprietary" Version="2.0.0-pre-20160714" />
     <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Analyzer.Testing.XUnit" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.CodeFix.Testing" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.CodeFix.Testing.XUnit" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.CodeRefactoring.Testing" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
     <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.CodeRefactoring.Testing.XUnit" Version="$(MicrosoftCodeAnalysisTestingVersion)" />
     <PackageVersion Include="Microsoft.DiaSymReader.Converter" Version="1.1.0-beta2-22302-02" />
     <PackageVersion Include="Microsoft.DiaSymReader.Converter.Xml" Version="1.1.0-beta2-22302-02" />
@@ -314,5 +325,15 @@
       the generators we build would load on the command line but not load in IDEs.
     -->
     <PackageVersion Include="Microsoft.CodeAnalysis.Common" Version="4.1.0" />
-  </ItemGroup>
+    <!--
+      The version of Roslyn used in the RoslynAnalyzers varies. These are defaults that
+      will be overridden in the RoslynAnalyzer project files.
+    -->
+    <!--<PackageVersion Include="Microsoft.CodeAnalysis" Version="4.1.0" /> -->
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.1.0" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.1.0" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic" Version="4.1.0" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Workspaces" Version="4.1.0" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.Workspaces.Common" Version="4.1.0" />
+ </ItemGroup>
 </Project>

eng/SourceBuildPrebuiltBaseline.xml

@@ -3,10 +3,10 @@
 
 <UsageData>
   <IgnorePatterns>
-    <!-- These are cases where the component chooses, when built in isolation, to 
+    <!-- These are cases where the component chooses, when built in isolation, to
          remain dependent on stable versions. These versions may not have source build intermediates associated with them.
          They cannot be source build reference packages because they actually provide functionality. In full source build, these versions are
-         overridden by previous repo outputs or come from previously source-built artifacts.  --> 
+         overridden by previous repo outputs or come from previously source-built artifacts.  -->
     <UsagePattern IdentityGlob="Microsoft.CodeAnalysis.Analyzers/*" />
     <UsagePattern IdentityGlob="Microsoft.CodeAnalysis.AnalyzerUtilities/*" />
     <UsagePattern IdentityGlob="Microsoft.CodeAnalysis.CSharp.CodeStyle/*" />
@@ -49,6 +49,15 @@
     <UsagePattern IdentityGlob="System.Text.Json/9.0*" />
     <UsagePattern IdentityGlob="System.Threading.Tasks.Dataflow/9.0*" />
     <UsagePattern IdentityGlob="System.Windows.Extensions/9.0*" />
+
+    <!-- This is the version of Microsoft.CodeAnalysis used by RoslynAnalyzers for tooling executed
+         in repo source-build, as well as unit tests. -->
+    <UsagePattern IdentityGlob="Microsoft.CodeAnalysis*/*3.11.0*" />
+    <UsagePattern IdentityGlob="Microsoft.CodeAnalysis*/*4.0.1*" />
+    <UsagePattern IdentityGlob="Microsoft.CodeAnalysis*/*4.1.0*" />
+    <UsagePattern IdentityGlob="Microsoft.CodeAnalysis*/*4.6.0-1.final*" />
+    <!-- Dependency of Microsoft.CodeAnalysis.Common 4.6.0-1.final -->
+    <UsagePattern IdentityGlob="Microsoft.CodeAnalysis.Analyzers/*3.3.4*" />
   </IgnorePatterns>
   <Usages>
     <Usage Id="Microsoft.Build" Version="17.3.4" IsDirectDependency="true" />

eng/Version.Details.xml

@@ -1,6 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Dependencies>
   <ProductDependencies>
+    <!-- RoslynAnalyzers reference older builds of Roslyn and this is necessary for SourceBuild. -->
+    <Dependency Name="Microsoft.CodeAnalysis" Version="3.11.0">
+      <Uri>https://github.com/dotnet/roslyn</Uri>
+      <Sha>ae1fff344d46976624e68ae17164e0607ab68b10</Sha>
+    </Dependency>
     <!-- Intermediate is necessary for source build. -->
     <Dependency Name="Microsoft.SourceBuild.Intermediate.source-build-externals" Version="9.0.0-alpha.1.24575.1">
       <Uri>https://github.com/dotnet/source-build-externals</Uri>