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

| Name | Description | Default |------------------------ |-------------------------- | ------- | projectConfiguration | Configuration to pick | Release | targets | Targets to run | Build | maxCpuCount | Number of cores to use | 1 | nodeReuse | If msbuild should hang around | true | consoleLoggerParameters | Customize Console Logger | buildParameters | Additional properties | customArgs | Additional args, see MSBuild Command-Line Reference | verbosity | Verbosity level (quiet, minimal, normal, detailed or diagnostic) | normal | msbuildPath | Path to MSBuild.exe. Required if inferMsbuildPath is not set to true. | inferMsbuildPath | If 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 [email protected]

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

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