This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Yarn.
Summary
A wrapper around the Yarn package manager
- Assembly
- Cake
.Yarn .dll - Namespace
- Cake
.Yarn - Interfaces
- Base Types
-
- Tool
<YarnRunnerSettings>
- Tool
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, IYarnRunnerConfigurationConstructors
| Name | Summary |
|---|---|
| YarnRunner |
Initializes a new instance of the YarnRunner class.
|
Methods
| Name | Value | Summary |
|---|---|---|
| Add |
IYarnRunnerCommands |
execute 'yarn add' with options
|
| Audit |
IYarnRunnerCommands |
execute 'yarn audit' with options
|
| Cache |
IYarnRunnerCommands |
execute 'yarn cache' with arguments
|
| FromPath |
IYarnRunnerCommands |
Sets the working directory for yarn commands
|
| Get |
IEnumerable |
Gets the name of the tool executable
|
| GetToolName |
string |
Gets the name of the tool
|
| GetWorkingDirectory |
DirectoryPath |
Gets the working directory from the YarnRunnerSettings
Defaults to the currently set working directory.
|
| Install |
IYarnRunnerCommands |
execute 'yarn install' with options
|
| Pack |
IYarnRunnerCommands |
execute 'yarn pack' with options
|
| Publish |
IYarnRunnerCommands |
execute 'yarn publish' with options
|
| Remove |
IYarnRunnerCommands |
execute 'yarn remove' with options
|
| RunScript |
IYarnRunnerCommands |
execute 'yarn run' with arguments
|
| Version |
IYarnRunnerCommands |
execute 'yarn version' with options
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|