Skip to content

Latest commit

 

History

History
79 lines (48 loc) · 4.91 KB

SUPPORT.md

File metadata and controls

79 lines (48 loc) · 4.91 KB
Raw

Support

How to get help

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new Issue.

This repository tracks issues related to the C# extension. Any issues related to the C# editing experience, Roslyn language server and other basic C# functionality should be filed here (regardless of if you're using C# Dev Kit or not).

For C# Dev Kit only features such as the Solution Explorer, Test Window, etc, please see https://github.com/microsoft/vscode-dotnettools/blob/main/SUPPORT.md

For help and questions about using this project, please see the README.

How to file an issue

We highly recommend using the C# extension's built-in command, CSharp: Report an issue (csharp.reportIssue) to create a pre-filled issue template. This will include helpful details such as local dotnet installations, installed extensions, and other information. csharp.reportIssue command

Collecting general logs

The template has a section to include the C# output window logs. These logs are not automatically included as they may contain personal information (such as full file paths and project names), but they are key to resolving problems.

  1. Find the C# output window (View -> Output) and set the log level to Trace c# output window showing trace option
  2. Reproduce the issue
  3. In the C# output window, select all (e.g. cntrl+a) and copy paste into the issue template under the 'C# Log' section. If you need to redact file paths and other information, please do so at this time.
  4. Once the logs are collected, reset the window log level to Info

If the issue only reproduces on extension startup, you can set Trace as the default (see screenshot above), reload the window, and trace logs will be captured on startup.

C# LSP Trace Logs

Sometimes we need to know exactly what requests were sent to the Roslyn language server. To capture these logs:

  1. Set the log level to Trace for the C# output window as described above.
  2. Find the C# LSP Trace Logs output window
  3. Reproduce the issue
  4. Copy the contents of the C# LSP Trace Logs output window.
Other ways to set the log level
  1. When launching VSCode from the CLI, pass the --log ms-dotnettools.csharp:trace parameter.
  2. Invoke the Developer: Set Log Level command from the VSCode command palette, find the C# entry and set the level.

Project loading problems

A common cause of missing language features is a failure to load the project(s) or solution. There can be a number of reasons why this happens, and some additional information is generally necessary to figure out what is going wrong.

First, providing the information from the issue template and the general logs (see above section) is almost always necessary. After that there are a couple things to check:

  1. Is the file found in the correct project by the language server? This information is displayed in the bottom right corner of the VSCode window in the language status section. This item can be pinned using the pin icon so that it is always displayed.

    language status bar opened showing file active project context

  2. If using C# Dev Kit, check that the Solution Explorer displays the project with the expected references. If not as expected, please also provide the contents of the Projects output window in the issue.

Colorization problems

For issues related to classification (colorizing the document), please provide the following

  1. Which theme is currently being used
  2. A screenshot of the Developer: Inspect Editor Tokens and Scopes (editor.action.inspectTMScopes) command output on the incorrect word inspect tokens and scopes output

Diagnostics problems

For issues with diagnostics, please provide values of the background analysis scope options, dotnet.backgroundAnalysis.analyzerDiagnosticsScope and dotnet.backgroundAnalysis.compilerDiagnosticsScope background analysis settings

Language server crashing

As before, the general log collection is usually useful. However we're not always able to diagnose just from the logs. In that case a crash dump is useful. This can be collected by setting the dotnet.server.crashDumpPath VSCode setting to a user-writeable folder. vscode setting for crash dump path

When the server crashes, this should create a crash dump for it.

Warning

The dump can contain detailed information on the project - generally we will provide an email so that it can be shared privately

Microsoft Support Policy

Support for this project is limited to the resources listed above.