chore: Refactor docfx command related code (#9140)

Author: filzrev

src/Docfx.App/Helpers/Constants.cs

@@ -5,6 +5,5 @@ namespace Docfx;
 
 internal static class Constants
 {
-    public const string ConfigFileName = "docfx.json";
     public const string DefaultTemplateName = "default";
 }

src/Docfx.App/RunBuild.cs

@@ -2,7 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using Docfx.Build.Engine;
-using Docfx.Common;
 using Docfx.Common.Git;
 using Docfx.Exceptions;
 using Docfx.Plugins;
@@ -11,8 +10,14 @@ namespace Docfx;
 
 #pragma warning disable CS0618 // Type or member is obsolete
 
+/// <summary>
+/// Helper class to build document.
+/// </summary>
 internal static class RunBuild
 {
+    /// <summary>
+    /// Build document with specified settings.
+    /// </summary>
     public static string Exec(BuildJsonConfig config, BuildOptions options, string configDirectory, string outputDirectory = null)
     {
         if (config.Templates == null || config.Templates.Count == 0)

src/Docfx.App/RunMerge.cs

@@ -8,8 +8,14 @@
 
 namespace Docfx;
 
+/// <summary>
+/// Helper class to merge document.
+/// </summary>
 internal static class RunMerge
 {
+    /// <summary>
+    /// Merge document with specified settings.
+    /// </summary>
     public static void Exec(MergeJsonConfig config, string configDirectory)
     {
         foreach (var round in config)

src/Docfx.App/RunMetadata.cs

@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Docfx.Dotnet;
+
+namespace Docfx;
+
+/// <summary>
+/// Helper class to generate metadata.
+/// </summary>
+internal static class RunMetadata
+{
+    /// <summary>
+    /// Generate metadata with specified settings.
+    /// </summary>
+    public static void Exec(MetadataJsonConfig config, DotnetApiOptions options, string configDirectory, string outputDirectory = null)
+    {
+        DotnetApiCatalog.Exec(config, options, configDirectory, outputDirectory).GetAwaiter().GetResult();
+    }
+}

src/Docfx.App/RunPdf.cs

@@ -10,8 +10,14 @@ namespace Docfx;
 
 #pragma warning disable CS0618 // Type or member is obsolete
 
+/// <summary>
+/// Helper class to generate pdf document.
+/// </summary>
 internal static class RunPdf
 {
+    /// <summary>
+    /// Generate pdf document with specified settings.
+    /// </summary>
     public static void Exec(PdfJsonConfig config, BuildOptions buildOptions, string configDirectory, string outputDirectory = null)
     {
         EnvironmentContext.SetBaseDirectory(Path.GetFullPath(string.IsNullOrEmpty(configDirectory) ? Directory.GetCurrentDirectory() : configDirectory));

src/Docfx.App/RunServe.cs

@@ -13,8 +13,14 @@
 
 namespace Docfx;
 
+/// <summary>
+/// Helper class to serve document.
+/// </summary>
 internal static class RunServe
 {
+    /// <summary>
+    /// Start document host server with specified settings.
+    /// </summary>
     public static void Exec(string folder, string host, int? port, bool openBrowser, string openFile)
     {
         if (string.IsNullOrEmpty(folder))

src/Docfx.DataContracts.Common/Constants.cs

@@ -9,6 +9,7 @@ namespace Docfx.DataContracts.Common;
 
 public static class Constants
 {
+    public const string ConfigFileName = "docfx.json";
     public const string YamlExtension = ".yml";
     public const string ContentPlaceholder = "*content";
     public const string PrefixSeparator = ".";

src/Docfx.Dotnet/Docfx.Dotnet.csproj

@@ -34,7 +34,7 @@
     <PackageReference Include="Microsoft.CodeAnalysis.Workspaces.Common" />
     <PackageReference Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" />
   </ItemGroup>
-  
+
   <ItemGroup>
     <InternalsAssemblyName Include="Microsoft.CodeAnalysis.Workspaces" />
   </ItemGroup>

src/Docfx.Dotnet/MetadataJsonConfig.cs

@@ -5,6 +5,9 @@
 
 namespace Docfx;
 
+/// <summary>
+/// Specifies the layout of members.
+/// </summary>
 public enum MemberLayout
 {
     /// <summary>
@@ -18,6 +21,9 @@ public enum MemberLayout
     SeparatePages,
 }
 
+/// <summary>
+/// Specifies the layout of namepsaces.
+/// </summary>
 internal enum NamespaceLayout
 {
     /// <summary>

src/docfx/Models/CommandHelper.cs

@@ -10,7 +10,7 @@ internal class CommandHelper
     public static (T, string baseDirectory) GetConfig<T>(string configFile)
     {
         if (string.IsNullOrEmpty(configFile))
-            configFile = "docfx.json";
+            configFile = DataContracts.Common.Constants.ConfigFileName;
 
         configFile = Path.GetFullPath(configFile);
 

src/docfx/Models/InitCommand.cs

@@ -10,7 +10,7 @@ namespace Docfx;
 
 internal class InitCommand : Command<InitCommandOptions>
 {
-    private const string ConfigName = Constants.ConfigFileName;
+    private const string ConfigName = DataContracts.Common.Constants.ConfigFileName;
     private const string DefaultOutputFolder = "docfx_project";
     private const string DefaultMetadataOutputFolder = "api";
 

src/docfx/Models/MetadataCommand.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Diagnostics.CodeAnalysis;
+using Docfx.DataContracts.Common;
 using Docfx.Dotnet;
 using Newtonsoft.Json;
 using Spectre.Console.Cli;
@@ -23,7 +24,7 @@ private static MetadataJsonConfig ParseOptions(MetadataCommandOptions options, o
     {
         MetadataConfig config;
 
-        if (options.Config != null && !string.Equals(Path.GetFileName(options.Config), "docfx.json", StringComparison.OrdinalIgnoreCase))
+        if (options.Config != null && !string.Equals(Path.GetFileName(options.Config), DataContracts.Common.Constants.ConfigFileName, StringComparison.OrdinalIgnoreCase))
         {
             config = new()
             {