Address UI feedback.

Author: carlossanlop

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/GenAPIDiffConfigurationBinder.cs

@@ -21,7 +21,6 @@ internal class GenAPIDiffConfigurationBinder : BinderBase<DiffConfiguration>
     private readonly Option<string[]?> _optionAttributesToExclude;
     private readonly Option<string[]?> _optionApisToExclude;
     private readonly Option<bool> _optionAddPartialModifier;
-    private readonly Option<bool> _optionHideImplicitDefaultConstructors;
     private readonly Option<bool> _optionAttachDebugger;
 
     internal GenAPIDiffConfigurationBinder(Option<string> optionBeforeAssembliesFolderPath,
@@ -36,7 +35,6 @@ internal GenAPIDiffConfigurationBinder(Option<string> optionBeforeAssembliesFold
                                            Option<string[]?> optionAttributesToExclude,
                                            Option<string[]?> optionApisToExclude,
                                            Option<bool> optionAddPartialModifier,
-                                           Option<bool> optionHideImplicitDefaultConstructors,
                                            Option<bool> optionAttachDebugger)
     {
         _optionBeforeAssembliesFolderPath = optionBeforeAssembliesFolderPath;
@@ -51,7 +49,6 @@ internal GenAPIDiffConfigurationBinder(Option<string> optionBeforeAssembliesFold
         _optionAttributesToExclude = optionAttributesToExclude;
         _optionApisToExclude = optionApisToExclude;
         _optionAddPartialModifier = optionAddPartialModifier;
-        _optionHideImplicitDefaultConstructors = optionHideImplicitDefaultConstructors;
         _optionAttachDebugger = optionAttachDebugger;
     }
 
@@ -69,7 +66,6 @@ protected override DiffConfiguration GetBoundValue(BindingContext bindingContext
             AttributesToExclude: bindingContext.ParseResult.GetValueForOption(_optionAttributesToExclude),
             ApisToExclude: bindingContext.ParseResult.GetValueForOption(_optionApisToExclude),
             AddPartialModifier: bindingContext.ParseResult.GetValueForOption(_optionAddPartialModifier),
-            HideImplicitDefaultConstructors: bindingContext.ParseResult.GetValueForOption(_optionHideImplicitDefaultConstructors),
             AttachDebugger: bindingContext.ParseResult.GetValueForOption(_optionAttachDebugger)
         );
 }

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff.Tool/Program.cs

@@ -19,28 +19,28 @@ public static async Task Main(string[] args)
 
         Option<string> optionBeforeAssembliesFolderPath = new(["--before", "-b"])
         {
-            Description = "The path to the folder containing the old (before) assemblies.",
+            Description = "The path to the folder containing the old (before) assemblies to be included in the diff.",
             Arity = ArgumentArity.ExactlyOne,
             IsRequired = true
         };
 
         Option<string> optionBeforeRefAssembliesFolderPath = new(["--refbefore", "-rb"])
         {
-            Description = "The path to the folder containing the old (before) reference assemblies.",
+            Description = "The path to the folder containing the references required by old (before) assemblies, not to be included in the diff.",
             Arity = ArgumentArity.ExactlyOne,
             IsRequired = false
         };
 
         Option<string> optionAfterAssembliesFolderPath = new(["--after", "-a"])
         {
-            Description = "The path to the folder containing the new (after) assemblies.",
+            Description = "The path to the folder containing the new (after) assemblies to be included in the diff.",
             Arity = ArgumentArity.ExactlyOne,
-            IsRequired = false
+            IsRequired = true
         };
 
         Option<string> optionAfterRefAssembliesFolderPath = new(["--refafter", "-ra"])
         {
-            Description = "The path to the folder containing the new (after) reference assemblies.",
+            Description = "The path to the folder containing references required by the new (after) reference assemblies, not to be included in the diff.",
             Arity = ArgumentArity.ExactlyOne,
             IsRequired = false
         };
@@ -66,16 +66,16 @@ public static async Task Main(string[] args)
             IsRequired = true
         };
 
-        Option<string> optionTableOfContentsTitle = new(["--tableOfContentsTitle", "-tc"])
+        Option<string> optionTableOfContentsTitle = new(["--tableOfContentsTitle", "-tc"], () => "api_diff")
         {
-            Description = "The title of the markdown table of contents file that is placed in the output folder.",
-            Arity = ArgumentArity.ExactlyOne,
+            Description = $"The optional title of the markdown table of contents file that is placed in the output folder.",
+            Arity = ArgumentArity.ZeroOrMore,
             IsRequired = true
         };
 
         Option<string[]?> optionAssembliesToExclude = new(["--assembliesToExclude", "-eas"], () => null)
         {
-            Description = "Assemblies to exclude from the diff.",
+            Description = "Assemblies from both before and after to exclude from the diff.",
             Arity = ArgumentArity.ZeroOrMore,
             IsRequired = false,
         };
@@ -99,11 +99,6 @@ public static async Task Main(string[] args)
             Description = "Add the 'partial' modifier to types."
         };
 
-        Option<bool> optionHideImplicitDefaultConstructors = new(["--hideImplicitDefaultConstructors", "-hidc"], () => false)
-        {
-            Description = "Hide implicit default constructors from types."
-        };
-
         Option<bool> optionAttachDebugger = new(["--attachDebugger", "-d"], () => false)
         {
             Description = "Stops the tool at startup, prints the process ID and waits for a debugger to attach."
@@ -122,7 +117,6 @@ public static async Task Main(string[] args)
         rootCommand.Add(optionAttributesToExclude);
         rootCommand.Add(optionApisToExclude);
         rootCommand.Add(optionAddPartialModifier);
-        rootCommand.Add(optionHideImplicitDefaultConstructors);
         rootCommand.Add(optionAttachDebugger);
 
         GenAPIDiffConfigurationBinder c = new(optionBeforeAssembliesFolderPath,
@@ -137,7 +131,6 @@ public static async Task Main(string[] args)
                                               optionAttributesToExclude,
                                               optionApisToExclude,
                                               optionAddPartialModifier,
-                                              optionHideImplicitDefaultConstructors,
                                               optionAttachDebugger);
 
         rootCommand.SetHandler(async (DiffConfiguration diffConfig) => await HandleCommandAsync(diffConfig).ConfigureAwait(false), c);
@@ -166,7 +159,6 @@ private static Task HandleCommandAsync(DiffConfiguration diffConfig)
         log.LogMessage($" - 'After' friendly name:              {diffConfig.AfterFriendlyName}");
         log.LogMessage($" - Table of contents title:            {diffConfig.TableOfContentsTitle}");
         log.LogMessage($" - Add partial modifier to types:      {diffConfig.AddPartialModifier}");
-        log.LogMessage($" - Hide implicit default constructors: {diffConfig.HideImplicitDefaultConstructors}");
         log.LogMessage($" - Attach debugger:                    {diffConfig.AttachDebugger}");
         log.LogMessage("");
 
@@ -188,7 +180,6 @@ private static Task HandleCommandAsync(DiffConfiguration diffConfig)
                                                                    diffConfig.AttributesToExclude,
                                                                    diffConfig.ApisToExclude,
                                                                    diffConfig.AddPartialModifier,
-                                                                   diffConfig.HideImplicitDefaultConstructors,
                                                                    writeToDisk: true,
                                                                    diagnosticOptions: null // TODO: If needed, add CLI option to pass specific diagnostic options
                                                                    );

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/DiffConfiguration.cs

@@ -19,6 +19,5 @@ public record DiffConfiguration(
     string[]? AttributesToExclude,
     string[]? ApisToExclude,
     bool AddPartialModifier,
-    bool HideImplicitDefaultConstructors,
     bool AttachDebugger
 );

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/DiffGeneratorFactory.cs

@@ -46,7 +46,6 @@ public static class DiffGeneratorFactory
     /// <param name="attributesToExclude">An optional list of attributes to avoid showing in the diff. If <see langword="null"/>, the default list of attributes to exclude <see cref="DiffGeneratorFactory.DefaultAttributesToExclude"/> is used. If an empty list, no attributes are excluded.</param>
     /// <param name="apisToExclude">An optional list of APIs to avoid showing in the diff.</param>
     /// <param name="addPartialModifier">Indicates whether to add the partial modifier to types.</param>
-    /// <param name="hideImplicitDefaultConstructors">Indicates whether to hide implicit default constructors.</param>
     /// <param name="writeToDisk">If <see langword="true"/>, when calling <see cref="IDiffGenerator.RunAsync"/>, the generated markdown files get written to disk, and no item is added to the <see cref="IDiffGenerator.RunAsync"/> dictionary. If <see langword="false"/>, when calling <see cref="IDiffGenerator.RunAsync"/>, the generated markdown files get added to the <see cref="IDiffGenerator.RunAsync"/> dictionary (with the file path as the dictionary key) and none of them is written to disk. This is meant for testing purposes.</param>
     /// <param name="diagnosticOptions">An optional list of diagnostic options to use when generating the diff.</param>
     /// <returns>A new instance of <see cref="IDiffGenerator"/> that writes the diff to disk.</returns>
@@ -64,7 +63,6 @@ public static IDiffGenerator Create(ILog log,
                                         string[]? attributesToExclude,
                                         string[]? apisToExclude,
                                         bool addPartialModifier,
-                                        bool hideImplicitDefaultConstructors,
                                         bool writeToDisk,
                                         IEnumerable<KeyValuePair<string, ReportDiagnostic>>? diagnosticOptions = null)
     {
@@ -81,7 +79,6 @@ public static IDiffGenerator Create(ILog log,
                                            attributesToExclude,
                                            apisToExclude,
                                            addPartialModifier,
-                                           hideImplicitDefaultConstructors,
                                            writeToDisk,
                                            diagnosticOptions);
     }
@@ -97,7 +94,6 @@ public static IDiffGenerator Create(ILog log,
     /// <param name="attributesToExclude">An optional list of attributes to avoid showing in the diff. If <see langword="null"/>, the default list of attributes to exclude <see cref="DiffGeneratorFactory.DefaultAttributesToExclude"/> is used. If an empty list, no attributes are excluded.</param>
     /// <param name="apisToExclude">An optional list of APIs to avoid showing in the diff.</param>
     /// <param name="addPartialModifier">Indicates whether to add the partial modifier to types.</param>
-    /// <param name="hideImplicitDefaultConstructors">Indicates whether to hide implicit default constructors.</param>
     /// <param name="diagnosticOptions">An optional list of diagnostic options to use when generating the diff.</param>
     /// <returns>A new instance of <see cref="IDiffGenerator"/> that writes the diff to memory.</returns>
     public static IDiffGenerator Create(ILog log,
@@ -108,7 +104,6 @@ public static IDiffGenerator Create(ILog log,
                                         string[]? attributesToExclude,
                                         string[]? apisToExclude,
                                         bool addPartialModifier,
-                                        bool hideImplicitDefaultConstructors,
                                         IEnumerable<KeyValuePair<string, ReportDiagnostic>>? diagnosticOptions = null)
     {
         return new MemoryOutputDiffGenerator(log,
@@ -119,7 +114,6 @@ public static IDiffGenerator Create(ILog log,
                                              attributesToExclude,
                                              apisToExclude,
                                              addPartialModifier,
-                                             hideImplicitDefaultConstructors,
                                              diagnosticOptions);
     }
 }

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/FileOutputDiffGenerator.cs

@@ -26,7 +26,6 @@ internal sealed class FileOutputDiffGenerator : IDiffGenerator
     private readonly string[] _attributesToExclude;
     private readonly string[] _apisToExclude;
     private readonly bool _addPartialModifier;
-    private readonly bool _hideImplicitDefaultConstructors;
     private readonly bool _writeToDisk;
     private readonly IEnumerable<KeyValuePair<string, ReportDiagnostic>>? _diagnosticOptions;
     private readonly Dictionary<string, string> _results;
@@ -47,7 +46,6 @@ internal sealed class FileOutputDiffGenerator : IDiffGenerator
     /// <param name="attributesToExclude">An optional list of attributes to avoid showing in the diff. If <see langword="null"/>, the default list of attributes to exclude <see cref="DiffGeneratorFactory.DefaultAttributesToExclude"/> is used. If an empty list, no attributes are excluded.</param>
     /// <param name="apisToExclude">An optional list of APIs to avoid showing in the diff.</param>
     /// <param name="addPartialModifier">A value indicating whether to add the partial modifier to types.</param>
-    /// <param name="hideImplicitDefaultConstructors">A value indicating whether to hide implicit default constructors.</param>
     /// <param name="writeToDisk">If <see langword="true"/>, when calling <see cref="RunAsync"/>, the generated markdown files get written to disk, and no item is added to the <see cref="RunAsync"/> dictionary. If <see langword="false"/>, when calling <see cref="RunAsync"/>, the generated markdown files get added to the <see cref="RunAsync"/> dictionary (with the file path as the dictionary key) and none of them is written to disk. This is meant for testing purposes.</param>
     /// <param name="diagnosticOptions">An optional set of diagnostic options.</param>
     internal FileOutputDiffGenerator(ILog log,
@@ -63,7 +61,6 @@ internal FileOutputDiffGenerator(ILog log,
                                     string[]? attributesToExclude,
                                     string[]? apisToExclude,
                                     bool addPartialModifier,
-                                    bool hideImplicitDefaultConstructors,
                                     bool writeToDisk,
                                     IEnumerable<KeyValuePair<string, ReportDiagnostic>>? diagnosticOptions = null)
 
@@ -81,7 +78,6 @@ internal FileOutputDiffGenerator(ILog log,
         _attributesToExclude = attributesToExclude ?? DiffGeneratorFactory.DefaultAttributesToExclude;
         _apisToExclude = apisToExclude ?? [];
         _addPartialModifier = addPartialModifier;
-        _hideImplicitDefaultConstructors = hideImplicitDefaultConstructors;
         _writeToDisk = writeToDisk;
         _diagnosticOptions = diagnosticOptions ?? DiffGeneratorFactory.DefaultDiagnosticOptions;
         _results = [];
@@ -120,7 +116,6 @@ public async Task RunAsync()
                                                   _attributesToExclude,
                                                   _apisToExclude,
                                                   _addPartialModifier,
-                                                  _hideImplicitDefaultConstructors,
                                                   _diagnosticOptions);
 
         await generator.RunAsync().ConfigureAwait(false);

src/Compatibility/ApiDiff/Microsoft.DotNet.ApiDiff/MemoryOutputDiffGenerator.cs

@@ -31,7 +31,6 @@ public class MemoryOutputDiffGenerator : IDiffGenerator
     private readonly ConcurrentDictionary<string, IAssemblySymbol> _beforeAssemblySymbols;
     private readonly ConcurrentDictionary<string, IAssemblySymbol> _afterAssemblySymbols;
     private readonly bool _addPartialModifier;
-    private readonly bool _hideImplicitDefaultConstructors;
     private readonly ISymbolFilter _attributeSymbolFilter;
     private readonly ISymbolFilter _symbolFilter;
     private readonly SyntaxTriviaList _twoSpacesTrivia;
@@ -53,7 +52,6 @@ public class MemoryOutputDiffGenerator : IDiffGenerator
     /// <param name="attributesToExclude">An optional list of attributes to avoid showing in the diff. If <see langword="null"/>, the default list of attributes to exclude <see cref="DiffGeneratorFactory.DefaultAttributesToExclude"/> is used. If an empty list, no attributes are excluded.</param>
     /// <param name="apisToExclude">An optional list of APIs to avoid showing in the diff.</param>
     /// <param name="addPartialModifier">A boolean indicating whether to add the partial modifier to types.</param>
-    /// <param name="hideImplicitDefaultConstructors">A boolean indicating whether to hide implicit default constructors.</param>
     /// <param name="diagnosticOptions">An optional dictionary of diagnostic options.</param>
     internal MemoryOutputDiffGenerator(
         ILog log,
@@ -64,7 +62,6 @@ internal MemoryOutputDiffGenerator(
         string[]? attributesToExclude,
         string[]? apisToExclude,
         bool addPartialModifier,
-        bool hideImplicitDefaultConstructors,
         IEnumerable<KeyValuePair<string, ReportDiagnostic>>? diagnosticOptions = null)
     {
         _log = log;
@@ -73,7 +70,6 @@ internal MemoryOutputDiffGenerator(
         _beforeAssemblySymbols = new ConcurrentDictionary<string, IAssemblySymbol>(beforeAssemblySymbols);
         _afterAssemblySymbols = new ConcurrentDictionary<string, IAssemblySymbol>(afterAssemblySymbols);
         _addPartialModifier = addPartialModifier;
-        _hideImplicitDefaultConstructors = hideImplicitDefaultConstructors;
         _diagnosticOptions = diagnosticOptions ?? DiffGeneratorFactory.DefaultDiagnosticOptions;
         _attributeSymbolFilter = SymbolFilterFactory.GetFilterFromList(attributesToExclude ?? DiffGeneratorFactory.DefaultAttributesToExclude, includeExplicitInterfaceImplementationSymbols: true);
         _symbolFilter = SymbolFilterFactory.GetFilterFromList(apisToExclude ?? [], includeExplicitInterfaceImplementationSymbols: true);
@@ -174,7 +170,7 @@ private async Task<string> ProcessAfterAssemblyAsync(IAssemblySymbol afterAssemb
     {
         CSharpAssemblyDocumentGeneratorOptions options = new(loader, _symbolFilter, _attributeSymbolFilter)
         {
-            HideImplicitDefaultConstructors = _hideImplicitDefaultConstructors,
+            HideImplicitDefaultConstructors = false,
             ShouldFormat = true,
             ShouldReduce = false,
             MetadataReferences = loader.MetadataReferences,