Skip to content

Commit 1f0e48a

Browse files
committed
Merge remote-tracking branch 'dotnet/main' into activeExps
2 parents 1a58310 + 05dc80b commit 1f0e48a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+478
-242
lines changed

.config/branch-merge.json

Lines changed: 0 additions & 14 deletions
This file was deleted.

.github/workflows/branch-merge.yml

Lines changed: 0 additions & 18 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,25 @@
33
- Diagnostics related feature requests and improvements [#5951](https://github.com/dotnet/vscode-csharp/issues/5951)
44
- Debug from .csproj and .sln [#5876](https://github.com/dotnet/vscode-csharp/issues/5876)
55

6+
# 2.75.x
7+
8+
# 2.74.x
9+
* Bump xamlTools to 17.14.36010.33 (PR: [#8178](https://github.com/dotnet/vscode-csharp/pull/8178))
10+
* Bump razor to 10.0.0-preview.25210.3 (PR: [#8171](https://github.com/dotnet/vscode-csharp/pull/8171))
11+
* Allow graceful handling of ArgumentException when trying to apply changes to SourceText in LspTextChangesLoader (PR: [#11727](https://github.com/dotnet/razor/pull/11727))
12+
* Tweak a log message (PR: [#11705](https://github.com/dotnet/razor/pull/11705))
13+
* Improve performance and memory usage of TagHelperBinder (PR: [#11671](https://github.com/dotnet/razor/pull/11671))
14+
615
# 2.73.x
16+
* Bump Roslyn to 5.0.0-1.25204.1 (PR: [#8138](https://github.com/dotnet/vscode-csharp/pull/8138))
17+
* Ensure that newline is inserted after file scoped namespace declarations (PR: [#77821](https://github.com/dotnet/roslyn/pull/77821))
18+
* Allow modification of source generated documents (PR: [#77587](https://github.com/dotnet/roslyn/pull/77587))
19+
* Simplify the code for getting source generator diagnostics into the diagnostics service. (PR: [#77898](https://github.com/dotnet/roslyn/pull/77898))
20+
* Make GlobalOptionService initialization synchronous. (PR: [#77823](https://github.com/dotnet/roslyn/pull/77823))
21+
* Change keys for import caching (PR: [#77627](https://github.com/dotnet/roslyn/pull/77627))
22+
* Don't show duplicate toast if C# Dev Kit fails to activate (PR: [#8135](https://github.com/dotnet/vscode-csharp/pull/8135))
23+
* Bump xamlTools to 17.14.36004.3 (PR: [#8134](https://github.com/dotnet/vscode-csharp/pull/8134))
24+
* Acquire aspnetcore runtime when using Dev Kit to avoid double acquisition (PR: [#8132](https://github.com/dotnet/vscode-csharp/pull/8132))
725

826
# 2.72.x
927
* Revert xamlTools to 17.14.35913.250 (PR: [#8121](https://github.com/dotnet/vscode-csharp/pull/8121))
@@ -18,18 +36,18 @@
1836
* Cleanup and make semantic token processing and testing code more consistent (PR: [#77684](https://github.com/dotnet/roslyn/pull/77684))
1937
* Fix generation of attribute with array constant (PR: [#77661](https://github.com/dotnet/roslyn/pull/77661))
2038
* Bump Razor to (PR: [#8096](https://github.com/dotnet/vscode-csharp/pull/8096))
21-
* Some code actions ordering and cleanup (#11659) (PR: [#11659](https://github.com/dotnet/razor/pull/11659))
22-
* Emit pragmas for empty @ expressions in MVC (#11653) (PR: [#11653](https://github.com/dotnet/razor/pull/11653))
23-
* Couple of small code actions tweaks (#11630) (PR: [#11630](https://github.com/dotnet/razor/pull/11630))
24-
* Fix text area formatting in the new formatting engine (#11624) (PR: [#11624](https://github.com/dotnet/razor/pull/11624))
39+
* Some code actions ordering and cleanup (PR: [#11659](https://github.com/dotnet/razor/pull/11659))
40+
* Emit pragmas for empty @ expressions in MVC (PR: [#11653](https://github.com/dotnet/razor/pull/11653))
41+
* Couple of small code actions tweaks (PR: [#11630](https://github.com/dotnet/razor/pull/11630))
42+
* Fix text area formatting in the new formatting engine (PR: [#11624](https://github.com/dotnet/razor/pull/11624))
2543

2644
# 2.71.x
2745
* Bump xamlTools to 17.14.35920.284 (PR: [#8083](https://github.com/dotnet/vscode-csharp/pull/8083))
2846
* Localization (PR: [#8084](https://github.com/dotnet/vscode-csharp/pull/8084))
29-
* Update wording on Razor Report Issue(PR: [#8081](https://github.com/dotnet/vscode-csharp/pull/8081))
30-
* Use the new SDK install experience when available.(PR: [#8080](https://github.com/dotnet/vscode-csharp/pull/8080))
31-
* Only enable Generate Assets command when the extension is activated.(PR: [#8079](https://github.com/dotnet/vscode-csharp/pull/8079))
32-
* Expose `sendRequestWithProgress` as experimental API(PR: [#8074](https://github.com/dotnet/vscode-csharp/pull/8074))
47+
* Update wording on Razor Report Issue (PR: [#8081](https://github.com/dotnet/vscode-csharp/pull/8081))
48+
* Use the new SDK install experience when available. (PR: [#8080](https://github.com/dotnet/vscode-csharp/pull/8080))
49+
* Only enable Generate Assets command when the extension is activated. (PR: [#8079](https://github.com/dotnet/vscode-csharp/pull/8079))
50+
* Expose `sendRequestWithProgress` as experimental API (PR: [#8074](https://github.com/dotnet/vscode-csharp/pull/8074))
3351

3452
# 2.70.x
3553
* Bump razor to 9.0.0-preview.25161.2 (PR: [#8058](https://github.com/dotnet/vscode-csharp/pull/8058))

SUPPORT.md

Lines changed: 74 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,47 +15,91 @@ For help and questions about using this project, please see the [README](https:/
1515
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.
1616
![csharp.reportIssue command](./docs/report_issue.png)
1717

18-
#### Collecting general logs
18+
#### Collecting General Logs
1919

20-
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.
20+
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.
2121

22-
1. Find the `C#` output window (`View` -> `Output`) and set the log level to `Trace`
23-
![c# output window showing trace option](./docs/csharp_trace.png)
24-
2. Reproduce the issue
25-
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.
26-
4. Once the logs are collected, reset the window log level to `Info`
22+
1. **Set the Log Level to Trace**:
23+
- Open the `C#` output window (`View` -> `Output`).
24+
- Set the log level to `Trace`.
25+
26+
![c# output window showing trace option](./docs/csharp_trace.png)
2727

28-
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.
28+
2. **Reproduce the Issue**:
29+
- Perform the actions that reproduce the issue.
30+
31+
3. **Copy the Logs**:
32+
- In the `C#` output window, select all the logs (e.g., `Ctrl+A`) and copy them.
33+
- Paste the logs into the issue template under the "C# Log" section.
34+
- If necessary, redact sensitive information (e.g., file paths, project names).
35+
36+
4. **Reset the Log Level**:
37+
- After collecting the logs, reset the log level to `Info`.
38+
39+
**Note**: If the issue occurs during extension startup, you can set `Trace` as the default log level, restart VSCode, and the trace logs will be captured automatically.
2940

3041
##### C# LSP Trace Logs
31-
Sometimes we need to know exactly what requests were sent to the Roslyn language server. To capture these logs:
42+
- To capture detailed requests sent to the Roslyn language server:
43+
1. Set the `C#` output window log level to `Trace` (as described above).
44+
2. Open the `C# LSP Trace Logs` output window.
45+
3. Reproduce the issue.
46+
4. Copy the contents of the `C# LSP Trace Logs` output window.
47+
48+
49+
##### Other Ways to Set the Log Level
50+
1. When launching VSCode from the CLI, pass the `--log ms-dotnettools.csharp:trace` parameter.
51+
2. Invoke the `Developer: Set Log Level` command from the VSCode command palette, find the `C#` entry, and set the level.
52+
53+
#### Collecting Razor Logs
54+
For issues with Razor, the Razor Log output window can contain useful information.
55+
56+
1. **Set the Log Level to Trace**:
57+
- Open the `Razor Logs` output window (`View` -> `Output`).
58+
- Set the log level to `Trace`.
59+
60+
![razor log output window showing trace option](./docs/razor_logs.png)
3261

33-
1. Set the log level to `Trace` for the `C#` output window as described above.
34-
2. Find the `C# LSP Trace Logs` output window
35-
3. Reproduce the issue
36-
4. Copy the contents of the `C# LSP Trace Logs` output window.
62+
2. **Reproduce the Issue**:
63+
- Perform the actions that reproduce the issue.
3764

38-
##### Other ways to set the log level
39-
1. When launching VSCode from the CLI, pass the `--log ms-dotnettools.csharp:trace` parameter.
40-
2. Invoke the `Developer: Set Log Level` command from the VSCode command palette, find the `C#` entry and set the level.
65+
3. **Copy the Logs**:
66+
- Select all contents of the window (e.g., `Ctrl+A`) and paste them into the GitHub issue when requested.
4167

42-
#### Project loading problems
68+
4. **Reset the Log Level**:
69+
- Once the logs are collected, reset the log level to `Info`.
4370

44-
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.
71+
#### Project Loading Problems
4572

46-
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:
73+
Missing language features are often caused by a failure to load the project(s) or solution. To diagnose and resolve these issues, follow these steps:
4774

48-
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.
75+
1. **Provide General Logs**:
76+
- Include the information from the issue template and the general logs (see the "Collecting General Logs" section above). These logs are essential for troubleshooting.
4977

50-
![language status bar opened showing file active project context](./docs/language_status.png)
51-
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.
78+
2. **Check the Active Project Context**:
79+
- Verify that the file is associated with the correct project in the language server.
80+
- This information is displayed in the bottom-right corner of the VSCode window in the language status section.
81+
- You can pin this item using the pin icon to keep it visible at all times.
82+
83+
![language status bar showing file active project context](./docs/language_status.png)
84+
85+
3. **Verify the Solution Explorer (C# Dev Kit)**:
86+
- If you are using C# Dev Kit, check the Solution Explorer to ensure the project is displayed with the expected references.
87+
- If the references or structure are not as expected, include the contents of the `Projects` output window in your issue report.
5288

5389
#### Colorization problems
90+
If you encounter issues with document classification (e.g., incorrect syntax highlighting or colorization), please provide the following information to help us diagnose the problem:
91+
92+
1. **Theme in Use**:
93+
- Specify the name of the theme you are currently using in VSCode (e.g., "Dark+", "Light+", or a custom theme).
94+
95+
2. **Tokens and Scope Information**:
96+
- The `Developer: Inspect Editor Tokens and Scopes` command shows information about the problematic word or section:
97+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS).
98+
2. Search for and select `Developer: Inspect Editor Tokens and Scopes` (`editor.action.inspectTMScopes`).
99+
3. Click on the word or section with incorrect colorization to display the token and scope information.
100+
- Take a screenshot of the output and include it in your issue report.
54101

55-
For issues related to classification (colorizing the document), please provide the following
56-
1. Which theme is currently being used
57-
2. A screenshot of the `Developer: Inspect Editor Tokens and Scopes` (`editor.action.inspectTMScopes`) command output on the incorrect word
58-
![inspect tokens and scopes output](./docs/inspect_tokens.png)
102+
![Inspect Tokens and Scopes Output](./docs/inspect_tokens.png)
59103

60104
#### Diagnostics problems
61105

@@ -64,16 +108,14 @@ For issues with diagnostics, please provide values of the background analysis sc
64108

65109
#### Language server crashing
66110

67-
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.
68-
![vscode setting for crash dump path](./docs/crash_dump.png)
69-
70-
When the server crashes, this should create a crash dump for it.
111+
If the language server crashes, general logs are often helpful for diagnosing the issue. However, in some cases, logs alone may not provide enough information and we may need a crash dump. Follow these steps to collect a crash dump:
112+
- Set the `dotnet.server.crashDumpPath` setting in VSCode to a user-writable folder where crash dumps can be saved.
113+
- Reproduce the issue
114+
- When the server crashes, a dump in the specified folder will be created.
71115

72116
> [!WARNING]
73117
> The dump can contain detailed information on the project - generally we will provide an email so that it can be shared privately
74118
75-
76-
77119
## Microsoft Support Policy
78120

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

docs/razor_logs.png

33.9 KB
Loading

0 commit comments

Comments
 (0)