Setting up Cake OmniSharp Bakery

Cake-omnisharp-bakery.md

1. Clone Omnisharp Roslyn and build that

git clone https://github.com/cake-build/omnisharp-roslyn

cd omnisharp-roslyn

git checkout feature/cake

.\build.ps1 -Target Quick

2. Clone Omnisharp VS Code and build that

git clone https://github.com/cake-build/omnisharp-vscode

cd omnisharp-vscode

git checkout feature/cake

npm i; npm run compile

3. Prepare test project for usage. Create .vscode/settings.json with following content. I.e. we want Omnisharp VS Code to launch our custom build of Omnisharp Roslyn.

{
  "omnisharp.path": "path\\to\\omnisharp-roslyn\\artifacts\\publish\\OmniSharp.Stdio\\win7-x64\\OmniSharp.exe",
  "omnisharp.loggingLevel": "trace"
}

4. Create tools\packages.config and add following content.

<packages>
    <package id="Cake" version="0.22.2" />
    <package id="Cake.Bakery" version="0.1.0-unstable0113" />
</packages>

5. nuget restore from source https://www.myget.org/F/cake/api/v3/index.json
6. Create your build.cake
7. Open up the omnisharp-vscode project in VS Code. Press F5 to launch. In the newly opened window, open up your test project.
8. Open your build.cake.
9. You should see some output from Omnisharp.

Example project found here: https://github.com/mholo65/cake-omnisharp-bakery-example

Pro-tip: If you like to avoid having to do step 7., you can create a VSIX package from the VSCode extension and simply install that to VS Code. To generate a VSIX package simply append node_modules\.bin\gulp package:online to step 2..

Steps for Mac OS X

1. Clone Omnisharp Roslyn and build that

git clone https://github.com/cake-build/omnisharp-roslyn

cd omnisharp-roslyn

git checkout feature/cake

mkdir -p artifacts/logs
mkdir -p artifacts/scripts
./build.sh --target BuildHosts
./build.sh --target PublishMonoBuilds

2. Clone Omnisharp VS Code and build that

git clone https://github.com/cake-build/omnisharp-vscode

cd omnisharp-vscode

git checkout feature/cake

npm i; npm run compile

3. Prepare test project for usage. Create .vscode/settings.json with following content. I.e. we want Omnisharp VS Code to launch our custom build of Omnisharp Roslyn.

{
    "omnisharp.loggingLevel": "trace",
    "omnisharp.useMono": true,
    "omnisharp.path": "/path/to/omnisharp-roslyn/artifacts/publish/OmniSharp.Stdio/mono/OmniSharp.exe"
}

4. Create tools\packages.config and add following content.

<packages>
    <package id="Cake" version="0.22.2" />
    <package id="Cake.Bakery" version="0.1.0-unstable0113" />
</packages>

5. nuget restore from source https://www.myget.org/F/cake/api/v3/index.json
6. rename Cake.Bakery.0.1.0-unstable0113 directory to cake.bakery.0.1.0-unstable0113 (with lowercase for cake.bakery)
7. Create your build.cake
8. Open up the omnisharp-vscode project in VS Code. Press F5 to launch. In the newly opened window, open up your test project.
9. Open your build.cake.
10. You should see some output from Omnisharp.

Example project found here:
https://github.com/mholo65/cake-omnisharp-bakery-example

Pro-tip:
If you like to avoid having to do step 8., you can create a VSIX package from the VSCode extension and simply install that to VS Code. To generate a VSIX package simply append node_modules\.bin\gulp package:online to step 2..