xsoheilalizadeh / vscode

VSCode extension

VSCode NUKE extension

Table of Contents

• What is NUKE
• Features
• Commands
• Codelens
• Task Provider
• Snippets
• General Configuration
• Contributing
• License

What is NUKE

• Cross-platform build automation in pure C#
• Extensive wizard for setup of initial build implementation
• Bootstrapping for .NET Core and .NET Framework/Mono
• CLT wrappers for over 30+ of the most popular .NET tools

Features

• Task provider to simply run Nuke targets
• Codelens on build targets to directly run or debug them
• Commands to debug and run targets with or without its dependencies

Commands

Command	Description
Nuke: Run Target	Run a Nuke target
Nuke: Run Target - Skip Dependencies	Run a Nuke target and skip its dependencies
Nuke: Debug Target	Debug a Nuke target
Nuke: Debug Target - Skip Dependencies	Debug a Nuke target and skip its dependencies

Simply debug and run Nuke targets from everywhere in your project.

Codelens

The extension uses codelens to allow running and debugging targets directly from any Nuke build class in the current workspace. Both the 'Run Target' and 'Debug Target' codelenses can be individually configured in the settings:

• nuke.codeLens.runTarget
• nuke.codeLens.debugTarget

The configuration object accepts these properties:

Name	Description	Default
enabled	Defines if the codelens is enabled	true
skipDependencies	Defines if target should run without dependencies	false

Task provider

General Configuration

Name	Description	Default
nuke.buildProjectPattern	Glob pattern to detect Nuke build project	*build/*build*.csproj
nuke.targetRegularExpression	Regular expression pattern to get targets from Nuke build classes	Target\\s+([\\w\\-_]+)\\s*=>\\s*_\\s*=>\\s*_

Snippets

Name	Description
ntarget	Creates an empty Nuke target

Contributing

If you want to contribute, please first get personal with us about your intentions on Slack. This largely increases the chances for pull-requests getting accepted and helps us establishing a clean and meaningful design of new features. At the same time it reduces the chances of duplicated work.

License

Copyright © Sebastian Karasek, Matthias Koch.

This project is provided as-is under the MIT license. For more information see the LICENSE file.