Skip to content

Commit a9d0b56

Browse files
authored
Merge pull request #5239 from OmniSharp/dev/jorobich/update-test-plan
Call out requirements in test plan
2 parents d58c038 + 46e95d9 commit a9d0b56

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

test-plan.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Validating C# Extension for VS Code
22

3+
### Requirements
4+
- [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) or newer when `omnisharp.useModernNet` is set to `true` (the default value).
5+
- A Full Framework runtime and MSBuild tooling when `omnisharp.useModernNet` is set to `false`.
6+
- Windows: .NET Framework along with [MSBuild Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022)
7+
- MacOS/Linux: [Mono with MSBuild](https://www.mono-project.com/download/stable/)
8+
9+
See [OmniSharp Options](https://github.com/OmniSharp/omnisharp-vscode/blob/master/test-plan.md#omnisharpusemodernnet-all-platforms) for more details.
10+
311
#### Opening projects
412
When you open a directory in VS Code, the C# extension should look for a .csproj, .sln, or .slnf file in that directory and use "OmniSharp" to load it. If a .cs file is present and no .csproj, .sln, or .slnf file are present, Omnisharp should start but the intellisense should only appear when a change is made to the file.
513
If you look in "Output > Omnisharp Log" a bunch of information should be printed about what copy of MSBuild was used and what projects were load
@@ -469,10 +477,10 @@ Changing this option should result in a notification message at the bottom right
469477
#### OmniSharp Options
470478

471479
### omnisharp.useModernNet (all platforms)
472-
This option is defaulted to `false`.
480+
This option is defaulted to `true`.
473481

474-
When this option is set to `true` a .NET 6 build of OmniSharp is downloaded and used for language services. This setting should only be used when working with newer SDK style projects and would be expected to fail when trying to load a Full Framework projects (such as Unity projects).
475-
* if the option is not set, the OmniSharp log should indicate that the registered MSBuild instance is either the Standalone MSBuild, a Visual Studio MSBuild instance, or a Mono MSBuild isntance.
482+
When this option is set to `false` a .NET Framework build of OmniSharp is downloaded and used for language services. This setting should only be used when working with older Full Framework projects (such as Unity) and would be expected to fail when trying to load .NET SDK-style projects (.NET Core, .NET).
483+
* if the option is not set, the OmniSharp log should indicate that the registered MSBuild instance is either the Standalone MSBuild, a Visual Studio MSBuild instance, or a Mono MSBuild instance.
476484
* if the option is set, the OmniSharp log should inlcude text like the following "OmniSharp server started with .NET 6.0.100" and "Registered MSBuild instance: .NET Core SDK 6.0.100 17.0.0 - "/usr/local/share/dotnet/sdk/6.0.100/". All language services should continue to work as expected when an SDK-style project is open.
477485

478486
#### omnisharp.path

0 commit comments

Comments
 (0)