CODEWITHSUNDEEP
visual-studio-codeshared-project
mariob
mariob

Reputation: 683

Is there a way to use shared projects (shproj) in Visual Studio Code?

Hi,

Shared project seemed like a good idea to share code between .NET Core 2.0 web project and .NET 4.7 WinForms project. I have bunch of extensions inside as well as web api client code which is used by both projects.

Everything works well in Visual Studio 2017.

However, on the road I use MacBook computer with Visual Studio Code which does not recognise shproj in any way. I also tried Insider version with new multiple workspace, but that also seem to work only with actual projects (csproj).
I know there is Visual Studio for Mac, but it is huge and far exceeds my on-the-road needs, so I would like to avoid it.

So, my question is - is there a way to utilize Visual Studio Code with projects that use shared projects (shproj)? I would like to run/debug such projects in VSCode.

If not, does it make sense to create feature request somewhere? I mean, shared projects were designed for cross-platform code sharing and VSCode is brilliant cross-platform editor so it makes sense. Or is this not part of VSCode at all, but some extension (like OmniSharp)?

Thanks, Mario

Upvotes: 2

Views: 2743

Answers (1)

TiskSec365
TiskSec365

Reputation: 1319

At least now (2021) it seems to work fine.

TLDR; Create a new project with Visual Studio (2019) and add a "Shared Project" to that Project/Solution. Then open the project folder in Visual Studio Code and add the Shared Project folder to Workspace. In VS Code add a new Class to the Shared Project and adjust the *.projitems file to include the new class in the compile process. Run the project in both VS Code and VS to verify everything works as expected.

Following are the steps that I used. It looks like a lot, but it should only take about 10 minutes to setup this basic sample.

  1. Open Visual Studio (2019)

  2. Create a new "Console App (.NET Core)", give it a name and a location and select "Place solution and project in the same directory".

  3. After creating the project you should have a new solution in "Solution Explorer" containing the new Console Application project.

  4. Right-Click on the solution and select "Add" > "New Project..."

  5. Select and add a new "Shared Project"

  6. Add a new class to your Shared Project. In "Solution Explorer" right-click the shared project and select "Add" > "New Item..." and select the "Class" template.

  7. In your "Console Application" add a reference to your Shared Project by right-clicking on your Console Application project, then select "Add" > "Shared Project Reference..." and select the listed shared project (*.shproj)

  8. Use the new class of the Shared Project in the Console Application project

  9. Run the Console Application to check if it builds and uses the shared class successfully.

  10. Close Visual Studio (2019)

  11. Open Visual Studio Code

  12. Select "File" > "Open Folder" and select the folder where the Console Application is placed.

Note: If VS Code shows a message "Required assets to build and ... are missing" then select "Yes".

  1. Select "File" > "Add Folder to Workspace..." and select the folder where the Shared Project is located.

  2. Select "File" > "Save Workspace As..." and save the file to the project folder of the Console Application.

  3. Open a new integrated Terminal in VS Code (in Menu "Terminal" > "New Terminal") and make sure that the current working directory is the folder of the Console Application. Then type "dotnet clean && dotnet run" to clean, build and run the solution.

Assuming we now want to add a new Class to the Shared Project from Visual Studio Code, we have to do some extra work, that normally Visual Studio (2019) would do for us when adding a new Class.

  1. In VS Code right-click the folder where your shared class is located and add a new File. Give it a name with .cs extension and add the according code to the file to make it a valid class file.

  2. Open the *.projitems file and find the part where your first class file has been added already. It should look like this:

<ItemGroup>
    <Compile Include="$(MSBuildThisFileDirectory)SharedClass1.cs" />
</ItemGroup>
  1. Now add the new class file to this ItemGroup section like this
<ItemGroup>
    <Compile Include="$(MSBuildThisFileDirectory)SharedClass1.cs" />
    <Compile Include="$(MSBuildThisFileDirectory)SharedClass2.cs" />
</ItemGroup>
  1. Use the new class in the Console Application, save all files and type "dotnet run" in the integrated Terminal. Check if everything builds and runs as expected.

If you notice that it builds successfully, but VS Code shows some error like "The type or namespace name 'Class2' does not exist in the namespace 'SharedProject1'", then restart VS Code. After restart it should be able to detect everything as expected.

  1. Close VS Code and Open VS (2019) by double-clicking the *.sln file.

  2. Build and Run the project to verify that all changes are compatible with VS (2019).

Upvotes: 1

Related Questions