Visual Studio Code snippets

Configuring snippets

Snippets in Visual Studio Code are provided by the Cake extension for Visual Studio Code.

For instructions how to install an extension in Visual Studio Code see Extension Marketplace documentation.

Supported runners

Runner Supported Remarks
Cake .NET Tool Available for all .cake files.
Cake Frosting
Cake runner for .NET Framework Available for all .cake files.
Cake runner for .NET Core Available for all .cake files.

Available snippets

  • cake-addin
    • Provides a basic addin pre-processor directive, where the package name and version can be changed
    • Default Value: #addin "nuget:?package=Cake.Foo&version=1.2.3"
  • cake-addin-full
    • Provides a more complete addin pre-processor directive, where source, package name and version can be changed
    • Default Value: #addin "nuget:https://www.nuget.org/api/v2?package=Cake.Foo&version=1.2.3"
  • cake-argument
    • Provides code for basic input argument parsing, where variable name, argument name and default value can be changed
    • Default Value: var target = Argument("target", "Default");
  • cake-load
    • Provides a basic load pre-processor directive, where the path to the .cake file can be changed
    • Default Value: #load "scripts/utilities.cake"
  • cake-load-nuget
    • Provides a more complex load pre-processor directive, where source, package name and version can be changed
    • Default Value: #load "nuget:https://www.nuget.org/api/v2?package=Cake.Foo&version=1.2.3"
  • cake-reference
    • Provides a basic reference pre-processor directive, where path to the assembly can be changed
    • Default Value: #reference "bin/myassembly.dll"
  • cake-sample
    • Provides a complete sample build Cake script including setup and teardown actions, a single task, and argument parsing
  • cake-tool
    • Provides a basic tool pre-processor directive, where the package name and version can be changed
    • Default Value: #tool "nuget:?package=Cake.Foo&version=1.2.3"
  • cake-tool-full
    • Provides a more complete tool pre-processor directive, where source, package name and version can be changed
    • Default Value: #tool "nuget:https://www.nuget.org/api/v2?package=Cake.Foo&version=1.2.3"
  • task
    • Provides a basic task definition, where the name of the task can be changed
    • Default Value: Task("name");
  • task (With Action)
    • Provides a more complex task definition, including an .Does body, where the name of the task can be changed