[BUG] Analyzers and code fixes not working in C# Dev Kit?

[DaRosenberg]

Describe the Issue

Not sure if this is exposing a bug or just a missing feature for now. Can you clarify whether analyzers and code fixes should be working yet or not?

Steps To Reproduce

Works:

• Analyzers are run during build, and issues surfaced as problems (errors and warnings)

Does NOT work:

• Analyzers do not run automatically (neither for solution nor for open documents)
• No command to run analyzers imperatively either
• Detected issues are highlighted in source (squigglies) but no fixes appear
• No settings to enable analyzers or control analysis behavior

Expected Behavior

I expect analyzers functionality to be on par with Visual Studio, or at least on par with the previous OmniSharp-powered C# extension.

Environment Information

• OS: macOS Ventura
• VS Code: 1.78.2
• Extension: C# Dev Kit v0.1.8

[timheuer]

Hi Daniel Rosenberg (@DaRosenberg) they should be working for you. Can you share any screenshots? Also can you confirm you are on the pre-release version of the C# extension as well?

[CyrusNajmabadi]

Can we port this to Roslyn? I can't get to these issues in the MS org.

…

On Wed, Jun 7, 2023, 16:28 Arun Chander ***@***.***> wrote: Assigned #61 <#61> to @CyrusNajmabadi <https://github.com/CyrusNajmabadi>. — Reply to this email directly, view it on GitHub <#61 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABC2MYYVXOKJ643SW2Y5SJ3XKEFCJANCNFSM6AAAAAAY6OUDDY> . You are receiving this because you were assigned.Message ID: ***@***.***>

[karl-sjogren]

I'm seeing the same problem, also on macOS Ventura (on an Intel Mac). This is in a .NET 7.0 project running with SDK 7.0.302.

With "C# Dev Kit" and prerelease of "C#".

And if I disable "C# Dev Kit" and go back to the release version of "C#".

If I just disable "C# Dev Kit" and stay on the prerelease of "C#" I'm still seeing the problem.

I also see this after loading a new project which isn't there with "C# Dev Kit" (though maybe i shouldn't be, I don't know).

I have the following analyzer packages in my solution (using Directory.Build.props).

<ItemGroup>
  <PackageReference Include="Roslynator.Analyzers" Version="4.3.0">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
  <PackageReference Include="Roslynator.Formatting.Analyzers" Version="4.3.0">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
  <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.6.0">
    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    <PrivateAssets>all</PrivateAssets>
  </PackageReference>
  <PackageReference Include="Microsoft.CodeAnalysis.CSharp.CodeStyle" Version="4.6.0">
    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    <PrivateAssets>all</PrivateAssets>
  </PackageReference>
  <PackageReference Include="Karls.Analyzers" Version="0.3.0">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
</ItemGroup>

And then I'm enabling the analyzers through .editorconfig.

[karl-sjogren]

I checked this out on a windows machine as well and I have the same problem there with the above setup. I did however manage to get the analyzers working for a bit when I created a new .cs file though without any code fixes. If I close VS Code and open the same solution again though the new file doesn't have any warnings reported.

[DaRosenberg]

Tim Heuer (@timheuer) Yes, I am on the pre-release of the C# extension, v2.0.206 Pre-Release.

I'm happy to share some more details.

Like Karl-Johan Sjögren (@karl-sjogren) my solution is also on .NET 7. Solution contains 62 projects, all of which get loaded. Here is VS Code with newly opened workspace and solution, and left sitting for a few minutes. As shown, errors and warnings are empty, no analysis seems to run:

There are no warnings or errors in any C# related output pane either.

After a solution rebuild, some CA warnings are spit out by MSBuild and parsed into VS Code error list:

And they are surfaced as squigglies but no fix:

Here's how analyzers are enabled in my projects:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <Nullable>enable</Nullable>
    <EnableNETAnalyzers>true</EnableNETAnalyzers>
    <AnalysisMode>AllEnabledByDefault</AnalysisMode>
  </PropertyGroup>

And some of them have their severity tweaked in .editorconfig:

#### .NET Analyzer Rules ####

# Suppress CA1031: Do not catch general exception types
# There are several legitimate use cases for catching general exception types, frequently
# ocurring throughout this application.
dotnet_diagnostic.CA1031.severity = none

# CA1820: Test for empty strings using string length
dotnet_diagnostic.CA1820.severity = silent

# CA1303: Read exception messages from resource dictionaries
# There are no current plans to localize this application, and even if we did, we would
# probably not localize exception messages.
dotnet_diagnostic.CA1303.severity = none

# CA1062: Validate arguments of public methods
# Silence this warning until we have enabled explicit nullability in our codebase.
dotnet_diagnostic.CA1062.severity = none

# CA1812: Avoid uninstantiated internal classes
# This application contains many internal classes that are added to a DI container by
# extension methods in the containing assembly.
dotnet_diagnostic.CA1812.severity = none

# CA1308: Normalize strings to uppercase
# This application has more legitimate than illegitimate use cases of converting strings and
# characters to lowercase, e.g. when it's for display purposes rather than for comparison
# purposes.
dotnet_diagnostic.CA1308.severity = silent

# CA1508: Avoid dead conditional code
# This analyzer is simply buggy and riddled with false positives
#dotnet_diagnostic.CA1508.severity = none

# A bunch of frivolous or much too opinionated analyzers
#dotnet_diagnostic.CA1024.severity = none
#dotnet_diagnostic.CA1506.severity = none
#dotnet_diagnostic.CA1502.severity = none
#dotnet_diagnostic.CA1002.severity = none

# CA1814: Prefer jagged arrays over multidimensional
dotnet_diagnostic.CA1814.severity = none

# CA2201: Do not raise reserved exception types
dotnet_diagnostic.CA2201.severity = none

# CA1716: Do not use reserved words in namespaces
dotnet_diagnostic.CA1716.severity = none

# CA1014: Mark assemblies with CLSCompliant
dotnet_diagnostic.CA1014.severity = none

# CA2254: Template should be a static expression
dotnet_diagnostic.CA2254.severity = none

# CA1848: Use the LoggerMessage delegates
dotnet_diagnostic.CA1848.severity = none

# CA2007: Consider using ConfigureAwait on the awaited task
# Disabled because of https://github.com/dotnet/roslyn-analyzers/issues/5712
# For now we're going to have to remember to call ConfigureAwait() where appropriate.
dotnet_diagnostic.CA2007.severity = silent

# CA1000: Do not declare static members on generic types
# This warning is far too opinionated, stating that the C# syntax "can be confusing" but it's completely logical.
dotnet_diagnostic.CA1000.severity = none

# CA2234: Pass system uri objects instead of strings
# This is simply not practical in many cases, e.g. when an HttpClient instance already has a base URI.
dotnet_diagnostic.CA2234.severity = none

# CS8524: The switch expression does not handle some values of its input type (it is not exhaustive) involving an unnamed enum value.
# This warning is meant to protect against cases where you switch on an enum variable that could theoretically have been assigned
# an int value not matching an enum member, which we never do. There is another better warning for when a switch expression doesn't
# cover all defined enum members.
dotnet_diagnostic.CS8524.severity = none

# IDE0270: Null check can be simplified/use coalesce expression
# This warning is too opinionated. In many cases a separate null check is more appropriate than a coalesce expression.
dotnet_diagnostic.IDE0270.severity = silent

# CA1851: Possible multiple enumerations of IEnumerable collection
# At some point we should migrate from using IEnumerable<T> to using IReadOnlyCollection<T> in most places to prevent lazy enumeration
# and convey clearer intent. This will be an impactful enough change (from a mere code churn perspective - not functionally) that it
# should be done as its own PR.
dotnet_diagnostic.CA1851.severity = silent

# CA1852: Seal internal types
# This warning is too opinionated. Sealing all types that can technically be sealed results in more verbose and more rigid code, for very little performance gain.
dotnet_diagnostic.CA1852.severity = silent

Here's my dotnet --info:

.NET SDK:
 Version:   7.0.203
 Commit:    5b005c19f5

Runtime Environment:
 OS Name:     Mac OS X
 OS Version:  13.3
 OS Platform: Darwin
 RID:         osx.13-x64
 Base Path:   /usr/local/share/dotnet/sdk/7.0.203/

Host:
  Version:      7.0.5
  Architecture: x64
  Commit:       8042d61b17

.NET SDKs installed:
  7.0.203 [/usr/local/share/dotnet/sdk]

.NET runtimes installed:
  Microsoft.AspNetCore.App 6.0.14 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]
  Microsoft.AspNetCore.App 7.0.5 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 6.0.14 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]
  Microsoft.NETCore.App 7.0.5 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]

Other architectures found:
  None

Environment variables:
  Not set

global.json file:
  Not found

Hope that help pinpoint the issue. Let me know I you need anything additional.

[ckasabula]

I am seeing the same. Problems view has nothing in it. Switching back to release version of C# extension restores them. Let me know if I can provide anything to help.

[CyrusNajmabadi]

Having trouble repro'ing this:

Continuing to investigate.

[CyrusNajmabadi]

I have the following analyzer packages in my solution (using Directory.Build.props).

Hrmm. Still worksf or me as well with those packages added. Continuing to investigate. If someone could put their repro project on a github repo that would be super helpful since this is working locally.

[karl-sjogren]

https://github.com/karl-sjogren/vscode-dotnettools-repro-61

That is a minimal repro where the analyzer RCS1046 from Roslynator works fine using the omnisharp extension but not using C# Dev Kit. The method Program.WaitABit() should have an "async" suffix according to the analyzer. I've included some screenshots in the repository that shows how it looks for me.

[karl-sjogren]

Hm, I left the code window open for several minutes in the background and when I looked back at it the analyzer had loaded with Dev Kit enabled. I then restarted Code to see if it would work again but after 5 minutes now nothing is showing. I am however seeing this in the output log for the C# extension with the above project.

[Warn - 10:52:54 PM] [LanguageServerHost]Ignoring diagnostics request for untracked document: file:///x:/Github/vscode-dotnettools-repro-61/Program.cs

If I create a new file and copy the code over to it, then analyzers work in that file, until I restart Code and then I get the same warning, bur for my new file..

[Warn - 10:54:44 PM] [LanguageServerHost]Ignoring diagnostics request for untracked document: file:///x:/Github/vscode-dotnettools-repro-61/OtherFile.cs

This is the whole log after restarting Code and opening both files.

Dotnet path: c:\Users\Karl\AppData\Roaming\Code\User\globalStorage\ms-dotnettools.vscode-dotnet-runtime\.dotnet\7.0.5\dotnet.exe
Activating C# + C# Dev Kit + C# IntelliCode...
info: LanguageServerHost[0]
      Starting server...
[Info  - 10:54:41 PM] [LanguageServerProjectSystem]Loaded MSBuild at C:\Program Files\dotnet\sdk\7.0.302
[Info  - 10:54:41 PM] [LanguageServerProjectSystem]Loading x:\Github\vscode-dotnettools-repro-61\vscode-dotnettools-repro-61.sln...
[Info  - 10:54:43 PM] [LanguageServerProjectSystem]Successfully completed load of x:\Github\vscode-dotnettools-repro-61\vscode-dotnettools-repro-61.csproj
[Info  - 10:54:43 PM] [LanguageServerProjectSystem]Completed (re)load of all projects in 00:00:01.3546912
[Warn  - 10:54:44 PM] [LanguageServerHost]Ignoring diagnostics request for untracked document: file:///x:/Github/vscode-dotnettools-repro-61/OtherFile.cs
[Warn  - 10:55:14 PM] [LanguageServerHost]Ignoring diagnostics request for untracked document: file:///x:/Github/vscode-dotnettools-repro-61/Program.cs

I've added OtherFile.cs to the sample repo as well.