https://github.com/cake-contrib/cake.yarn

:cake: :jigsaw: :package: A set of aliases for Cake to help with running Yarn (node package manager from Facebook) commands
https://github.com/cake-contrib/cake.yarn

cake cake-addin cake-build cake-yarn milovanovm yarn

Last synced: about 1 month ago
JSON representation

:cake: :jigsaw: :package: A set of aliases for Cake to help with running Yarn (node package manager from Facebook) commands

• Host: GitHub
• URL: https://github.com/cake-contrib/cake.yarn
• Owner: cake-contrib
• License: mit
• Created: 2016-11-04T13:07:36.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-09-11T11:54:42.000Z (over 1 year ago)
• Last Synced: 2024-12-02T13:25:01.907Z (about 2 months ago)
• Topics: cake, cake-addin, cake-build, cake-yarn, milovanovm, yarn
• Language: C#
• Homepage: https://cakebuild.net/extensions/cake-yarn/
• Size: 126 KB
• Stars: 11
• Watchers: 9
• Forks: 23
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cake.Yarn

[![NuGet](https://img.shields.io/nuget/v/Cake.Yarn.svg)](https://www.nuget.org/packages/Cake.Yarn/) [![Build status](https://ci.appveyor.com/api/projects/status/dch44vu64cs7nb98?svg=true)](https://ci.appveyor.com/project/MilovanovM/cake-yarn)

## Usage

```c#

#addin "Cake.Yarn"

Task("Yarn")

    .Does(() =>

    {

        // yarn install

        Yarn.Install();

        // yarn global add gulp

        Yarn.Add(settings => settings.Package("gulp").Globally());

        // yarn add gulp

        Yarn.Add(settings => settings.Package("gulp"));

    });

Task("Yarn-FromPath")

    .Does(() =>

    {

        // Yarn.FromPath(DirectoryPath);

        // yarn install from path

        Yarn.FromPath("./wwwroot").Install();

        // yarn global add gulp (from path ./wwwroot)

        Yarn.FromPath("./wwwroot").Add(settings => settings.Package("gulp").Globally());

        // yarn add gulp (from parent path)

        Yarn.FromPath("../").Add(settings => settings.Package("gulp"));

    });

Task("Yarn-RunScript")

    .Does(() =>

    {

        Yarn.RunScript("test");

    });

Task("Yarn-Pack")

    .Does(() =>

    {

        Yarn.Pack();

    });

Task("Yarn-Version")

    .Does(() =>

    {

        // yarn version

        Yarn.Version();

        // yarn version --new-version 0.1.0

        Yarn.Version(settings => settings.SetVersion("0.1.0"));

    });

```

## Scope

Cake.Yarn currently supports the following yarn commands:

* ```yarn install```

* ```yarn add```

* ```yarn run```

* ```yarn pack```

* ```yarn version```

* ```yarn cache```

* ```yarn remove```

* ```yarn audit```

My primary goal for the project is to support the build workflow I need as a .NET developer, additional features have been contributed

## Documentation

Thanks to the cakebuild.net site, documentation can be found [here](http://cakebuild.net/api/cake.yarn/)

## Tests

Cake.Yarn is covered by a set of unit tests

## I can't do _insert-command-here_

If you have feature requests please submit them as issues, or better yet as pull requests :)

## Discussion

For questions and to discuss ideas & feature requests, use the [GitHub discussions on the Cake GitHub repository](https://github.com/cake-build/cake/discussions), under the [Extension Q&A](https://github.com/cake-build/cake/discussions/categories/extension-q-a) category.

[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions)