Edit

Share via

MSBuild reference for the JavaScript Project System

  • Article

This article provides reference information for the MSBuild properties and items that you can use to configure projects based on the JavaScript Project System (JSPS), which use the .esproj format.

Note

The properties described in this article extend the properties MSBuild provides by default. For a list of common MSBuild properties, see Common MSBuild properties.

ShouldRun properties

The following MSBuild properties are documented in this section:

ShouldRunNpmInstall

The ShouldRunNpmInstall property specifies whether to run or not run npm install on Build and Restore commands. The default value for the property is true if unset.

<PropertyGroup>
  <ShouldRunNpmInstall>false</ShouldRunNpmInstall>
</PropertyGroup>

Two common scenarios where not running npm install is desirable are:

  1. When a non-npm package manager (such as yarn or pnpm) is used. In this scenario, the best solution is to create a target that runs before BeforeRestore to manually run the installation.
  2. When a global package installation mechanism exists in the solution that makes running individual installations unnecessary.

ShouldRunBuildScript

The ShouldRunBuildScript property specifies whether or not to run npm run build on Build commands. The default value for the property is true if unset.

<PropertyGroup>
  <ShouldRunNpmBuildScript>false</ShouldRunNpmBuildScript>
</PropertyGroup>

For projects containing only JavaScript that do not require building, set this property to false. Newly created React, Vue, and Angular projects usually fall in this category. In this scenario, build is used for production and not for debugging. Note that the Build and Publish commands are separate in JSPS projects, and Publish still runs even if this property is set.

Command Properties

Command properties are properties intended to map common package.json scripts to MSBuild targets. Default values are supported for all of these properties, as described in this section.

Set these properties when using package managers other than npm, or scripting engines such as gulp.

The following MSBuild properties are described in this section:

BuildCommand

The BuildCommand property specifies the behavior for the build target. If the associated package.json contains a build or compile script, the default BuildCommand value is already set to run them.

To modify the command, include npm run when using npm.

<PropertyGroup>
  <BuildCommand>npm run build</BuildCommand>
</PropertyGroup>

StartupCommand

The StartupCommand property specifies the behavior for the dotnet run target. If the associated package.json contains a start, server, or dev script, the default StartupCommand value is already set to run these scripts.

If you modify the command, include npm run when using npm.

<PropertyGroup>
  <StartupCommand>npm run serve</StartupCommand>
</PropertyGroup>

TestCommand

The TestCommand property specifies the behavior for the test target. If the associated package.json contains a test script, the default TestCommand value is already set to run this script.

If you modify the command, include npm run when using npm.

<PropertyGroup>
  <TestCommand>ng test</TestCommand>
</PropertyGroup>

CleanCommand

The CleanCommand property specifies the behavior for the clean target. If the associated package.json contains a clean script, the default CleanCommand value is already set to run this script.

If you modify the command, include npm run when using npm.

<PropertyGroup>
  <CleanCommand>npm run clean</CleanCommand>
</PropertyGroup>

PublishCommand

The PublishCommand property specifies the behavior for the publish target. If the associated package.json contains a publish script, the default PublishCommand value is already set to run this script. In npm, it is common to have pre- and post- publish scripts, which will also run.

If you modify the command, include npm run when using npm.

<PropertyGroup>
  <PublishCommand>npm run publish</PublishCommand>
</PropertyGroup>

See also