added ExcludeGenerator to exclude DocItem from the documentation gene…

…ration based on regex (closes #160)

README.md

@@ -61,6 +61,7 @@ dotnet tool
   - [HandleLineBreak](#MarkdownConfiguration_HandleLineBreak)
   - [TableOfContentsModes](#MarkdownConfiguration_TableOfContentsModes)
   - [Url format](#MarkdownConfiguration_UrlFormat)
+  - [Exclude](#MarkdownConfiguration_Exclude)
 - [Samples](#Samples)
 - [Dependencies](#Dependencies)
 
@@ -329,8 +330,9 @@ The list of plugin files to load to create the documentation. See [Plugins](#Ove
 
 `Name` or `Type Assembly` of the `IDocItemGenerator` implementations to use to generate the `DocItem` of the documentation.
 The default implementations provided are:
+- `Exclude` or `DefaultDocumentation.Markdown.DocItemGenerators.ExcludeGenerator DefaultDocumentation.Markdown` remove `DocItem` from the documentation generation based on [MarkdownConfiguration.Exclude](#MarkdownConfiguration_Exclude).
 - `Overloads` or `DefaultDocumentation.Markdown.DocItemGenerators.OverloadsGenerator DefaultDocumentation.Markdown` adds pages to group constructor and method overloads the same way microsoft documentation do it.
-The default value is `Overloads`.
+The default value is `Exclude|Overloads`.
 
 <a name='Configuration_UrlFactories'></a>
 ## UrlFactories
@@ -563,6 +565,15 @@ Three arguments will be passed to the format:
 
 The default value is `[{0}]({1} '{2}')`.
 
+<a name='MarkdownConfiguration_Exclude'></a>
+## Exclude
+- configuration file: `"Markdown.Exclude": [ "", ... ]`
+
+Contains a collection of regex used by the `DefaultDocumentation.Markdown.DocItemGenerators.ExcludeGenerator DefaultDocumentation.Markdown` [DocItemGenerator](#Configuration_DocItemGenerators),
+any `DocItem` whose id will match one of them will be excluded from the documentation generation.
+
+The default value is `null`.
+
 <a name='Samples'></a>
 # Samples
 - [DefaultDocumentation api](https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/index.md)

documentation/NEXT_RELEASENOTES.txt

@@ -9,6 +9,7 @@
 - it is now possible to change the format of url link procuded in the markdown via Markdown.UrlFormat configuration (closes #107)
 - added IDocItemGenerator to customize pages generated
 - added OverloadsGenerator to put constructor and method overloads in the same page (closes #139)
+- added ExcludeGenerator to exclude DocItem from the documentation generation based on regex (closes #160)
 
 ## Bug fixes
 

source/DefaultDocumentation.Common/Generator.cs

@@ -60,7 +60,7 @@ private Generator(Target loggerTarget, IRawSettings settings)
         AddSetting(settings => settings.ExternLinksFilePaths, value => !(value ?? []).Any(), value => value.ToArray());
         // context settings
         AddSetting(settings => settings.Plugins, value => !(value ?? []).Any(), value => value.ToArray());
-        AddSetting(settings => settings.DocItemGenerators, value => !(value ?? []).Any(), ["Overloads"]);
+        AddSetting(settings => settings.DocItemGenerators, value => !(value ?? []).Any(), ["Exclude", "Overloads"]);
         AddSetting(settings => settings.FileNameFactory, string.IsNullOrEmpty, "FullName");
         AddSetting(settings => settings.UrlFactories, value => !(value ?? []).Any(), value => value.ToArray(), ["DocItem", "DotnetApi"]);
         AddSetting(settings => settings.Sections, value => !(value ?? []).Any(), value => value.ToArray(), ["Header", "Default"]);

source/DefaultDocumentation.Common/Internal/GeneralContext.cs

@@ -103,14 +103,10 @@ .. GetImplementations<IDocItemGenerator>(availableTypes, docItemGenerator => doc
 
     #region IDocItemsContext
 
-    ISettings IDocItemsContext.Settings => Settings;
-
     IDictionary<string, DocItem> IDocItemsContext.Items => _items;
 
     ICollection<DocItem> IDocItemsContext.ItemsWithOwnPage => _itemsWithOwnPage;
 
-    T? IDocItemsContext.GetSetting<T>(string name) where T : default => GetSetting<T>(name);
-
     T? IDocItemsContext.GetSetting<T>(Type? type, string name) where T : default => GetContext(type).GetSetting<T>(name);
 
     #endregion

source/DefaultDocumentation.Markdown/DocItemGenerators/ExcludeGenerator.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Linq;
+using System.Text.RegularExpressions;
+using DefaultDocumentation.Api;
+using DefaultDocumentation.Models;
+
+namespace DefaultDocumentation.Markdown.DocItemGenerators;
+
+/// <summary>
+/// Implementation of the <see cref="IDocItemGenerator"/> to remove <see cref="DocItem"/> from the documentation generation based on <see href="https://github.com/Doraku/DefaultDocumentation#MarkdownConfiguration_Exclude">Markdown.Exclude</see>.
+/// </summary>
+public sealed class ExcludeGenerator : IDocItemGenerator
+{
+    /// <summary>
+    /// The name of this implementation used at the configuration level.
+    /// </summary>
+    public const string ConfigName = "Exclude";
+
+    /// <inheritdoc/>
+    public string Name => ConfigName;
+
+    /// <inheritdoc/>
+    public void Generate(IDocItemsContext context)
+    {
+        context.ThrowIfNull();
+
+        void Remove(DocItem item)
+        {
+            context.Items.Remove(item.Id);
+            context.ItemsWithOwnPage.Remove(item);
+
+            foreach (DocItem child in context.Items.Values.Where(child => child.Parent == item).ToArray())
+            {
+                Remove(child);
+            }
+        }
+
+        foreach (DocItem item in (context.GetSetting<string[]>("Markdown.Exclude") ?? [])
+            .SelectMany(regex => context.Items.Values.Where(item => Regex.IsMatch(item.Id, regex)))
+            .ToArray())
+        {
+            Remove(item);
+        }
+    }
+}