Summary
Contains settings used by
DotNetRestorer.
- Namespace
- Cake
.Common .Tools .DotNet .Restore - Base Types
-
- object
- ToolSettings
- DotNetSettings
graph BT
Type-->Base0["DotNetSettings"]
click Base0 "/api/Cake.Common.Tools.DotNet/DotNetSettings"
Base0-->Base1["ToolSettings"]
click Base1 "/api/Cake.Core.Tooling/ToolSettings"
Base1-->Base2["object"]
Type["DotNetRestoreSettings"]
class Type type-node
Syntax
public class DotNetRestoreSettings : DotNetSettingsProperties
| Name | Value | Summary |
|---|---|---|
| Argument |
Func |
Gets or sets the argument customization.
Argument customization is a way that lets you add, replace or reuse arguments passed to a tool.
This allows you to support new tool arguments, customize arguments or address potential argument issues.
Inherited from ToolSettings
|
| ConfigFile | FilePath |
Gets or sets the NuGet configuration file to use.
|
| DiagnosticOutput | bool |
Gets or sets a value indicating whether to not enable diagnostic output.
Inherited from DotNetSettings
|
| DisableParallel | bool |
Gets or sets a value indicating whether to disable restoring multiple projects in parallel.
|
| EnvironmentVariables | IDictionary |
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
Inherited from ToolSettings
|
| Force | bool |
Gets or sets a value indicating whether to force all dependencies to be resolved even if the last restore was successful.
This is equivalent to deleting the project.assets.json file.
Note: This flag was introduced with the .NET Core 2.x release.
|
| ForceEvaluate | bool |
Gets or sets a value indicating whether to force restore to reevaluate all dependencies even if a lock file already exists.
|
| HandleExitCode | Func |
Gets or sets whether the exit code from the tool process causes an exception to be thrown.
If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code. If the delegate returns true then no exception is thrown. This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional on the exit code value. Inherited from ToolSettings
|
| IgnoreFailedSources | bool |
Gets or sets a value indicating whether to only warning failed sources if there are packages meeting version requirement.
|
| Interactive | bool |
Gets or sets a value indicating whether to stop and wait for user input or action (for example to complete authentication).
|
| LockedMode | bool |
Gets or sets a value indicating whether to not allow updating project lock file.
|
| LockFilePath | FilePath |
Gets or sets a value indicating output location where project lock file is written.
|
| MSBuildSettings | Dot |
Gets or sets additional arguments to be passed to MSBuild.
|
| NoCache | bool |
Gets or sets a value indicating whether to do not cache packages and http requests.
|
| NoDependencies | bool |
Gets or sets a value indicating whether to ignore project to project references and restore only the root project.
|
| NoWorkingDirectory | bool |
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
Inherited from ToolSettings
|
| PackagesDirectory | DirectoryPath |
Gets or sets the directory to install packages in.
|
| PostAction | Action |
Gets or sets a delegate which is executed after the process was started.
Inherited from ToolSettings
|
| PublishReadyToRun | bool? |
Gets or sets a value indicating whether to compile your application assemblies as ReadyToRun (R2R) format.
|
| RollForward | DotNetRollForward? |
Gets or sets the dotnet roll forward policy.
Inherited from DotNetSettings
|
| Runtime | string |
Gets or sets the target runtime to restore packages for.
|
| SetupProcessSettings | Action |
Gets or sets a delegate to configure the process settings.
Inherited from ToolSettings
|
| Sources | ICollection |
Gets or sets the specified NuGet package sources to use during the restore.
|
| ToolPath | FilePath |
Gets or sets the tool path.
Inherited from ToolSettings
|
| ToolTimeout | TimeSpan? |
Gets or sets optional timeout for tool execution.
Inherited from ToolSettings
|
| UseLockFile | bool |
Gets or sets a value indicating whether to enable project lock file to be generated and used with restore.
|
| Verbosity | DotNetVerbosity? |
Gets or sets the verbosity of logging to use.
Inherited from DotNetSettings
|
| WorkingDirectory | DirectoryPath |
Gets or sets the working directory for the tool process.
Inherited from ToolSettings
|
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 |
Throws an exception if the specified parameter's value is null.
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 |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|
| With |
T |
Sets the tool argument customization delegate.
|
| With |
T |
Sets or adds tool environment variable.
|
| WithExpectedExitCode |
T |
Sets expected exit code using
WithHandleExitCode<T>(T, Func<int, bool>).
|
| WithHandleExitCode |
T |
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
|
| With |
T |
Sets whether the tool should use a working directory or not.
|
| WithPostAction |
T |
Sets a delegate which is executed after the tool process was started.
|
| With |
T |
Sets a delegate to configure the process settings.
|
| WithToolPath |
T |
Sets the tool path.
|
| WithToolSettings |
T |
Provides fluent null guarded tool settings action.
|
| WithToolTimeout |
T |
Sets the tool timeout.
|
| WithWorkingDirectory |
T |
Sets the tool working directory.
|