Skip to content

Commit 82561e4

Browse files
committed
Apply PR feedback
1 parent d2612f6 commit 82561e4

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
- [Roslyn](#roslyn)
88
- [Razor](#razor)
99
- [Configuring Local Language Servers](#configuring-local-language-servers)
10-
- [Roslyn](#roslyn-1)
11-
- [Razor](#razor-1)
10+
- [Finding the `settings.json` file for your workspace](#finding-the-settingsjson-file-for-your-workspace)
11+
- [Configuring Roslyn Language Server](#configuring-roslyn-language-server)
12+
- [Configuring Razor Language Server](#configuring-razor-language-server)
1213
- [Debugging Local Language Servers](#debugging-local-language-servers)
1314
- [Creating VSIX Packages for the Extension](#creating-vsix-packages-for-the-extension)
1415
- [Updating the `Roslyn` Language Server Version](#updating-the-roslyn-language-server-version)
@@ -77,36 +78,43 @@ The server DLL is typically at `$razorRepoRoot/artifacts/bin/rzls/Debug/net8.0`.
7778

7879
### Configuring Local Language Servers
7980

80-
This section provides instructions on how to debug locally built Roslyn and Razor language servers. You can do this by either directly editing the `settings.json` file or through the VSCode settings interface.
81+
This section provides instructions on how to debug locally built Roslyn and Razor language servers. You can do this by either directly editing the `settings.json` file of your workspace or through the VSCode settings interface.
8182

82-
#### Roslyn
83+
#### Finding the `settings.json` file for your workspace
84+
- Open the Command Palette with `Ctrl+Shift+P`
85+
- Type "Preferences: Open Workspace Settings"
86+
- Select the option that appears.
87+
- In the Workspace Settings tab, in the upper right corner, you'll see an icon that looks like a document with an arrow, which is the "Open Settings (JSON)" button.
88+
- Click on this button to open the `settings.json` file.
89+
90+
#### Configuring Roslyn Language Server
8391

84-
1. Navigate to `C:\Users\YourUsername\AppData\Roaming\Code\User\settings.json` and add the following lines:
92+
In your workspace `settings.json` file, add the following lines:
8593

8694
```json
8795
"dotnet.server.waitForDebugger": true,
8896
"dotnet.server.path": "$roslynRepoRoot\\artifacts\\bin\\Microsoft.CodeAnalysis.LanguageServer\\Debug\\net7.0\\Microsoft.CodeAnalysis.LanguageServer.dll"
8997
```
9098

91-
Replace `$roslynRepoRoot` and `YourUsername` with your actual values.
99+
Replace `$roslynRepoRoot` with your actual values.
92100

93101
Or, in VSCode settings (`Ctrl+,`):
94102

95103
1. Search for `dotnet server`.
96104
2. Set `dotnet.server.path` to the path of your Roslyn DLL.
97105
3. Enable `dotnet.server.waitForDebugger`.
98106

99-
#### Razor
107+
#### Configuring Razor Language Server
100108

101-
1. Navigate to `C:\Users\YourUsername\AppData\Roaming\Code\User\settings.json` and add the following lines:
109+
In your workspace settings.json file, add the following lines:
102110

103111
```json
104112
"razor.languageServer.debug": true,
105113
"razor.languageServer.directory": "$razorRepoRoot\\artifacts\\bin\\rzls\\Debug\\net8.0",
106114
"razor.server.trace": "Debug"
107115
```
108116

109-
Replace `$razorRepoRoot` and `YourUsername` with your actual values.
117+
Replace `$razorRepoRoot` with your actual values.
110118

111119
Or, in VSCode settings (`Ctrl+,`):
112120

0 commit comments

Comments
 (0)