Yarn.MSBuild

Status

This project is now archived. It supported Yarn v1, but will not be updated to support Yarn v2 and beyond. See https://yarnpkg.com for recommended instructions on installing and using Yarn.

About this project

An MSBuild task for running the Yarn package manager.

See Yarn's Official Website for more information about using Yarn.

Installation

Package Manager Console in Visual Studio

PM> Install-Package Yarn.MSBuild

.NET Core Command Line

dotnet add package Yarn.MSBuild

In csproj

<ItemGroup>
  <PackageReference Include="Yarn.MSBuild" Version="*" />
</ItemGroup>

With Visual Studio 2017 and .NET Core SDK 2.1 or newer, you can use this package as an "SDK" element.

See Microsoft's documentation for details on project SDKs.

<Project>
  <Sdk Name="Microsoft.NET.Sdk.Web" />
  <!-- An exact version is required -->
  <Sdk Name="Yarn.MSBuild" Version="1.22.0" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>
</Project>

Usage

This package installs yarn so you can use it from MSBuild without needing to install yarn globally.

YarnBuildCommand

If you set the YarnBuildCommand property, the command will run automatically in the "YarnBuild" target when you compile the application.

Example:

<Project Sdk="Microsoft.NET.Sdk.Web">
  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <YarnBuildCommand>run webpack</YarnBuildCommand>
    <YarnBuildCommand Condition="'$(Configuration)' == 'Release'">run webpack --env.prod</YarnBuildCommand>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Yarn.MSBuild" Version="**" />
  </ItemGroup>

</Project>

{
  "scripts": {
    "webpack": "webpack"
  },
  "dependencies": {
    "react": "^16.0.0"
  },
  "devDependencies": {
    "webpack": "^4.0.0"
  }
}

You can also chain of this target to run additional commands.

  <Target Name="YarnInstall" BeforeTargets="YarnBuild">
    <Yarn Command="install" Condition=" ! Exists('node_modules/')" />
  </Target>

Changing the directory where YarnBuild runs

You can set the YarnWorkingDir property to change the folder in which YarnBuildCommand executes.

For example, if you wanted to run yarn run webpack in wwwroot/ instead:

<Project Sdk="Microsoft.NET.Sdk.Web">
  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <YarnWorkingDir>$(MSBuildProjectDirectory)/wwwroot/</YarnWorkingDir>
    <YarnBuildCommand>run webpack</YarnBuildCommand>
    <YarnBuildCommand Condition="'$(Configuration)' == 'Release'">run webpack --env.prod</YarnBuildCommand>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Yarn.MSBuild" Version="*" />
  </ItemGroup>

</Project>

Running yarn from a custom target

This package makes the Yarn task available for execution from your targets.

<Project>
  <Target Name="RunMyYarnCommands">
    <!-- defaults to "install" in the current directory using the bundled version of yarn. -->
    <Yarn />

    <!-- Specify the command -->
    <Yarn Command="run myscript" />

    <!-- Allow failures -->
    <Yarn Command="upgrade" IgnoreExitCode="true" />

    <!-- Change the directory where yarn is executed -->
    <Yarn Command="run test" WorkingDirectory="wwwroot/" />

    <!-- Set where NodeJS is installed -->
    <Yarn Command="run cmd" NodeJSExecutablePath="/opt/node8/bin/nodejs" />
  </Target>
</Project>

Additional options

Yarn inherits all properties available on ToolTask which allows further fine-tuning, such as controlling the logging-level of stderr and stdout and the process environment.

The Yarn task supports the following parameters

[Optional]
string Command                            The arguments to pass to yarn.

[Optional]
string ExecutablePath                     Where to find yarn (*nix) or yarn.cmd (Windows)

[Optional]
string NodeJsExecutablePath               Where to find node(js) (*nix) or node.cmd (Windows).
                                          If not provided, node is expected to be in the PATH environment variable.

[Optional]
string WorkingDirectory                   The directory in which to execute the yarn command

[Optional]
bool IgnoreExitCode                       Don't create and error if the exit code is non-zero

[Optional]
bool IgnoreStandardErrorWarningFormat     Don't create MSBuild errors or warnings when Yarn output logs lines starting with 'warning' and 'error'

Task outputs:

[Output]
int ExitCode                              Returns the exit code of the yarn process

About

This is not an official Yarn project. See LICENSE.txt and the Third Party Notice for more details.

natemcmaster/Yarn.MSBuild