Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including grunt-msbuild with all npm packages installed. Try it out:

grunt-msbuild lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("grunt-msbuild/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

grunt-msbuild v1.1.0

grunt-msbuild

Build projects with MSBuild and XBuild using Grunt

Getting Started

This plugin requires Grunt ~0.4.0. In other words it should work on 0.4.0 or higher.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-msbuild --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-msbuild');

The "msbuild" task

Overview

In your project's Gruntfile, add a section named msbuild to the data object passed into grunt.initConfig().

grunt.initConfig({
    msbuild: {
        dev: {
            src: ['ConsoleApplication5.csproj'],
            options: {
                projectConfiguration: 'Debug',
                targets: ['Clean', 'Rebuild'],               
                maxCpuCount: 4,
                buildParameters: {
                    WarningLevel: 2
                },
                nodeReuse:true,
                customArgs:[ '/noautoresponse', '/detailedsummary'],
                verbosity: 'quiet',
                msbuildPath: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\MSBuild\\Current\\Bin\\amd64\\MSBuild.exe',
                inferMsbuildPath:false
            }
        }
    }
});

Options

NameDescriptionDefault
projectConfigurationConfiguration to pickRelease
targetsTargets to runBuild
maxCpuCountNumber of cores to use1
nodeReuseIf msbuild should hang aroundtrue
consoleLoggerParametersCustomize Console Logger
buildParametersAdditional properties
customArgsAdditional args, see MSBuild Command-Line Reference
verbosityVerbosity level (quiet, minimal, normal, detailed or diagnostic)normal
msbuildPathPath to MSBuild.exe. Required if inferMsbuildPath is not set to true.
inferMsbuildPathIf the msbuildpath should be inferred using vswhere. Overrides the given msbuildPath value.false

For more information, see MSBuild Command-Line Reference.

MSBuild version selection

If inferMsbuildPath is set to true, grunt-masbuild will try to infer the msbuildpath using vswhere.exe. Otherwise, you should set msbuildPath option. msbuildPath is used to target your msbuild version.

Example values for msbuildPath:

C:\\Program Files (x86)\\MSBuild\\MSBuild\\<VERSION>\\Bin\\amd64\\MSBuild.exe

C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\<YOUR_EDITION>\\MSBuild\\15.0\\Bin\\amd64\\MSBuild.exe

C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\<YOUR_EDITION>\\MSBuild\\Current\\Bin\\amd64\\MSBuild.exe

msbuild  (This will work if msbuild is available on the path for example)

Contributing

All contributions welcome :) Add to the VS integration tests for any new or changed functionality if possible.

Issues and installing previous versions

If you have any problems with the latest release please log an issue at https://github.com/stevewillcock/grunt-msbuild/issues.

If you need to roll back to an earlier version you can use the following syntax to install a specific version

npm install grunt-msbuild@0.1.12

Also see https://www.npmjs.org/doc/json.html#dependencies for details of how to specify a particular package version in your package.json file

Release Notes

VersionNotes
1.0This version replaces the version option with msbuildPath to support MSBuild versions moving forward from Visual Studio 2019.
0.2.0This version replaces exec() with spawn() to improve memory usage and also to support coloured console output. This has been tested internally.
0.1.12Support for MSBuild 12 added
0.1.11...

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free