Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/Fallout.Common/Tools/DotNet/DotNet.Generated.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public partial class DotNetTasks : ToolTasks, IRequirePathTool
/// <inheritdoc cref="DotNetTasks.DotNetRun(Fallout.Common.Tools.DotNet.DotNetRunSettings)"/>
public static IEnumerable<(DotNetRunSettings Settings, IReadOnlyCollection<Output> Output)> DotNetRun(CombinatorialConfigure<DotNetRunSettings> configurator, int degreeOfParallelism = 1, bool completeOnFailure = false) => configurator.Invoke(DotNetRun, degreeOfParallelism, completeOnFailure);
/// <summary><p>The <c>dotnet restore</c> command uses NuGet to restore dependencies as well as project-specific tools that are specified in the project file. By default, the restoration of dependencies and tools are performed in parallel.</p><p>Starting with .NET Core 2.0, you don't have to run <a href="https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-restore"><c>dotnet restore</c></a> because it's run implicitly by all commands, such as <c>dotnet build</c> and <c>dotnet run</c>, that require a restore to occur. It's still a valid command in certain scenarios where doing an explicit restore makes sense, such as <a href="https://docs.microsoft.com/en-us/vsts/build-release/apps/aspnet/build-aspnet-core">continuous integration builds in Visual Studio Team Services</a> or in build systems that need to explicitly control the time at which the restore occurs.</p><p>In order to restore the dependencies, NuGet needs the feeds where the packages are located. Feeds are usually provided via the <em>NuGet.config</em> configuration file. A default configuration file is provided when the CLI tools are installed. You specify additional feeds by creating your own <em>NuGet.config</em> file in the project directory. You also specify additional feeds per invocation at a command prompt.</p><p>For dependencies, you specify where the restored packages are placed during the restore operation using the <c>--packages</c> argument. If not specified, the default NuGet package cache is used, which is found in the <c>.nuget/packages</c> directory in the user's home directory on all operating systems (for example, <em>/home/user1</em> on Linux or <em>C:\Users\user1</em> on Windows).</p><p>For project-specific tooling, <c>dotnet restore</c> first restores the package in which the tool is packed, and then proceeds to restore the tool's dependencies as specified in its project file.</p><p>The behavior of the <c>dotnet restore</c> command is affected by some of the settings in the <em>Nuget.Config</em> file, if present. For example, setting the <c>globalPackagesFolder</c> in <em>NuGet.Config</em> places the restored NuGet packages in the specified folder. This is an alternative to specifying the <c>--packages</c> option on the <c>dotnet restore</c> command. For more information, see the <a href="https://docs.microsoft.com/nuget/schema/nuget-config-file">NuGet.Config reference</a>.</p><p>For more details, visit the <a href="https://docs.microsoft.com/en-us/dotnet/core/tools/">official website</a>.</p></summary>
/// <remarks><p>This is a <a href="https://github.com/Fallout-build/Fallout">CLI wrapper with fluent API</a> that allows to modify the following arguments:</p><ul><li><c>&lt;projectFile&gt;</c> via <see cref="DotNetRestoreSettings.ProjectFile"/></li><li><c>--configfile</c> via <see cref="DotNetRestoreSettings.ConfigFile"/></li><li><c>--disable-parallel</c> via <see cref="DotNetRestoreSettings.DisableParallel"/></li><li><c>--force</c> via <see cref="DotNetRestoreSettings.Force"/></li><li><c>--force-evaluate</c> via <see cref="DotNetRestoreSettings.ForceEvaluate"/></li><li><c>--ignore-failed-sources</c> via <see cref="DotNetRestoreSettings.IgnoreFailedSources"/></li><li><c>--lock-file-path</c> via <see cref="DotNetRestoreSettings.LockFilePath"/></li><li><c>--locked-mode</c> via <see cref="DotNetRestoreSettings.LockedMode"/></li><li><c>--no-cache</c> via <see cref="DotNetRestoreSettings.NoCache"/></li><li><c>--no-dependencies</c> via <see cref="DotNetRestoreSettings.NoDependencies"/></li><li><c>--packages</c> via <see cref="DotNetRestoreSettings.PackageDirectory"/></li><li><c>--property</c> via <see cref="DotNetRestoreSettings.Properties"/></li><li><c>--runtime</c> via <see cref="DotNetRestoreSettings.Runtime"/></li><li><c>--source</c> via <see cref="DotNetRestoreSettings.Sources"/></li><li><c>--use-lock-file</c> via <see cref="DotNetRestoreSettings.UseLockFile"/></li><li><c>--verbosity</c> via <see cref="DotNetRestoreSettings.Verbosity"/></li></ul></remarks>
/// <remarks><p>This is a <a href="https://github.com/Fallout-build/Fallout">CLI wrapper with fluent API</a> that allows to modify the following arguments:</p><ul><li><c>&lt;projectFile&gt;</c> via <see cref="DotNetRestoreSettings.ProjectFile"/></li><li><c>--artifacts-path</c> via <see cref="DotNetRestoreSettings.ArtifactsPath"/></li><li><c>--configfile</c> via <see cref="DotNetRestoreSettings.ConfigFile"/></li><li><c>--disable-parallel</c> via <see cref="DotNetRestoreSettings.DisableParallel"/></li><li><c>--force</c> via <see cref="DotNetRestoreSettings.Force"/></li><li><c>--force-evaluate</c> via <see cref="DotNetRestoreSettings.ForceEvaluate"/></li><li><c>--ignore-failed-sources</c> via <see cref="DotNetRestoreSettings.IgnoreFailedSources"/></li><li><c>--lock-file-path</c> via <see cref="DotNetRestoreSettings.LockFilePath"/></li><li><c>--locked-mode</c> via <see cref="DotNetRestoreSettings.LockedMode"/></li><li><c>--no-cache</c> via <see cref="DotNetRestoreSettings.NoCache"/></li><li><c>--no-dependencies</c> via <see cref="DotNetRestoreSettings.NoDependencies"/></li><li><c>--packages</c> via <see cref="DotNetRestoreSettings.PackageDirectory"/></li><li><c>--property</c> via <see cref="DotNetRestoreSettings.Properties"/></li><li><c>--runtime</c> via <see cref="DotNetRestoreSettings.Runtime"/></li><li><c>--source</c> via <see cref="DotNetRestoreSettings.Sources"/></li><li><c>--use-lock-file</c> via <see cref="DotNetRestoreSettings.UseLockFile"/></li><li><c>--verbosity</c> via <see cref="DotNetRestoreSettings.Verbosity"/></li></ul></remarks>
public static IReadOnlyCollection<Output> DotNetRestore(DotNetRestoreSettings options = null) => new DotNetTasks().Run<DotNetRestoreSettings>(options);
/// <inheritdoc cref="DotNetTasks.DotNetRestore(Fallout.Common.Tools.DotNet.DotNetRestoreSettings)"/>
public static IReadOnlyCollection<Output> DotNetRestore(Configure<DotNetRestoreSettings> configurator) => new DotNetTasks().Run<DotNetRestoreSettings>(configurator.Invoke(new DotNetRestoreSettings()));
Expand Down Expand Up @@ -356,6 +356,8 @@ public partial class DotNetRestoreSettings : ToolOptions
[Argument(Format = "--configfile {value}")] public string ConfigFile => Get<string>(() => ConfigFile);
/// <summary>Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>.</summary>
[Argument(Format = "--verbosity {value}")] public DotNetVerbosity Verbosity => Get<DotNetVerbosity>(() => Verbosity);
/// <summary>All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see <a href="https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output">Artifacts Output Layout</a>. Available since .NET 8 SDK.</summary>
[Argument(Format = "--artifacts-path {value}")] public string ArtifactsPath => Get<string>(() => ArtifactsPath);
/// <summary>Disables restoring multiple projects in parallel.</summary>
[Argument(Format = "--disable-parallel")] public bool? DisableParallel => Get<bool?>(() => DisableParallel);
/// <summary>Forces all dependencies to be resolved even if the last restore was successful. This is equivalent to deleting the <em>project.assets.json</em> file.</summary>
Expand Down Expand Up @@ -2370,6 +2372,14 @@ public static partial class DotNetRestoreSettingsExtensions
[Builder(Type = typeof(DotNetRestoreSettings), Property = nameof(DotNetRestoreSettings.Verbosity))]
public static T ResetVerbosity<T>(this T o) where T : DotNetRestoreSettings => o.Modify(b => b.Remove(() => o.Verbosity));
#endregion
#region ArtifactsPath
/// <inheritdoc cref="DotNetRestoreSettings.ArtifactsPath"/>
[Builder(Type = typeof(DotNetRestoreSettings), Property = nameof(DotNetRestoreSettings.ArtifactsPath))]
public static T SetArtifactsPath<T>(this T o, string v) where T : DotNetRestoreSettings => o.Modify(b => b.Set(() => o.ArtifactsPath, v));
/// <inheritdoc cref="DotNetRestoreSettings.ArtifactsPath"/>
[Builder(Type = typeof(DotNetRestoreSettings), Property = nameof(DotNetRestoreSettings.ArtifactsPath))]
public static T ResetArtifactsPath<T>(this T o) where T : DotNetRestoreSettings => o.Modify(b => b.Remove(() => o.ArtifactsPath));
#endregion
#region DisableParallel
/// <inheritdoc cref="DotNetRestoreSettings.DisableParallel"/>
[Builder(Type = typeof(DotNetRestoreSettings), Property = nameof(DotNetRestoreSettings.DisableParallel))]
Expand Down
6 changes: 6 additions & 0 deletions src/Fallout.Common/Tools/DotNet/DotNet.json
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,12 @@
"type": "DotNetVerbosity",
"format": "--verbosity {value}",
"help": "Sets the verbosity level of the command. Allowed values are <c>q[uiet]</c>, <c>m[inimal]</c>, <c>n[ormal]</c>, <c>d[etailed]</c>, and <c>diag[nostic]</c>."
},
{
"name": "ArtifactsPath",
"type": "string",
"format": "--artifacts-path {value}",
"help": "All build output files from the executed command will go in subfolders under the specified path, separated by project. For more information see <a href=\"https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output\">Artifacts Output Layout</a>. Available since .NET 8 SDK."
}
]
}
Expand Down
Loading