From c52be56fc815d664a402b3c3b2b51c1df5c524b1 Mon Sep 17 00:00:00 2001 From: filzrev <103790468+filzrev@users.noreply.github.com> Date: Wed, 27 Nov 2024 16:40:05 +0900 Subject: [PATCH] feat: add `noRestore` option to `docfx metadata` command --- docs/reference/docfx-cli-reference/docfx-metadata.md | 4 ++++ src/docfx/Models/MetadataCommand.cs | 1 + src/docfx/Models/MetadataCommandOptions.cs | 4 ++++ 3 files changed, 9 insertions(+) diff --git a/docs/reference/docfx-cli-reference/docfx-metadata.md b/docs/reference/docfx-cli-reference/docfx-metadata.md index fc679ed5142..fcf55620fd2 100644 --- a/docs/reference/docfx-cli-reference/docfx-metadata.md +++ b/docs/reference/docfx-cli-reference/docfx-metadata.md @@ -77,6 +77,10 @@ Run `docfx metadata --help` or `docfx -h` to get a list of all available options Disable the default API filter (default filter only generate public or protected APIs). +- **--noRestore** + + Do not run `dotnet restore` before building the projects. + - **--namespaceLayout** Determines the namespace layout in table of contents. diff --git a/src/docfx/Models/MetadataCommand.cs b/src/docfx/Models/MetadataCommand.cs index 516990ca0be..d41552f48e6 100644 --- a/src/docfx/Models/MetadataCommand.cs +++ b/src/docfx/Models/MetadataCommand.cs @@ -27,6 +27,7 @@ private static void MergeOptionsToConfig(MetadataCommandOptions options, DocfxCo item.ShouldSkipMarkup |= options.ShouldSkipMarkup; item.DisableGitFeatures |= options.DisableGitFeatures; item.DisableDefaultFilter |= options.DisableDefaultFilter; + item.NoRestore |= options.NoRestore; item.CategoryLayout = options.CategoryLayout ?? item.CategoryLayout; item.NamespaceLayout = options.NamespaceLayout ?? item.NamespaceLayout; item.MemberLayout = options.MemberLayout ?? item.MemberLayout; diff --git a/src/docfx/Models/MetadataCommandOptions.cs b/src/docfx/Models/MetadataCommandOptions.cs index 2b4ef828c68..9b4ad66ef71 100644 --- a/src/docfx/Models/MetadataCommandOptions.cs +++ b/src/docfx/Models/MetadataCommandOptions.cs @@ -45,6 +45,10 @@ internal class MetadataCommandOptions : LogOptions [CommandOption("--disableDefaultFilter")] public bool DisableDefaultFilter { get; set; } + [Description("Do not run `dotnet restore` before building the projects")] + [CommandOption("--noRestore")] + public bool NoRestore { get; set; } + [Description("Determines the category layout in table of contents.")] [CommandOption("--categoryLayout")] public CategoryLayout? CategoryLayout { get; set; }