YarnRunner Class

Summary

A wrapper around the Yarn package manager
Assembly
Cake.Yarn.dll
Namespace
Cake.Yarn
Interfaces
Base Types
graph BT Type-->Base0["Tool<YarnRunnerSettings>"] Type-.->Interface0["IYarnRunnerCommands"] click Interface0 "/api/Cake.Yarn/IYarnRunnerCommands" Type-.->Interface1["IYarnRunnerConfiguration"] click Interface1 "/api/Cake.Yarn/IYarnRunnerConfiguration" Type["YarnRunner"] class Type type-node

Syntax

public class YarnRunner : Tool<YarnRunnerSettings>, IYarnRunnerCommands, IYarnRunnerConfiguration

Constructors

Name Summary
YarnRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the YarnRunner class.

Methods

Name Value Summary
Add(Action<YarnAddSettings>) IYarnRunnerCommands
execute 'yarn add' with options
Audit(Action<YarnAuditSettings>) IYarnRunnerCommands
execute 'yarn audit' with options
Cache(string, Action<YarnCacheSettings>) IYarnRunnerCommands
execute 'yarn cache' with arguments
FromPath(DirectoryPath) IYarnRunnerCommands
Sets the working directory for yarn commands
GetToolExecutableNames() IEnumerable<string>
Gets the name of the tool executable
GetToolName() string
Gets the name of the tool
GetWorkingDirectory(YarnRunnerSettings) DirectoryPath
Gets the working directory from the YarnRunnerSettings Defaults to the currently set working directory.
Install(Action<YarnInstallSettings>) IYarnRunnerCommands
execute 'yarn install' with options
Pack(Action<YarnPackSettings>) IYarnRunnerCommands
execute 'yarn pack' with options
Publish(Action<YarnPublishSettings>) IYarnRunnerCommands
execute 'yarn publish' with options
Remove(Action<YarnRemoveSettings>) IYarnRunnerCommands
execute 'yarn remove' with options
RunScript(string, Action<YarnRunSettings>) IYarnRunnerCommands
execute 'yarn run' with arguments
Version(Action<YarnVersionSettings>) IYarnRunnerCommands
execute 'yarn version' with options

Extension Methods

Name Value Summary
Dump<YarnRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<YarnRunner>(YarnRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<YarnRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<YarnRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<YarnRunner>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<YarnRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin