chore: Reduce suggestion analyzer message (#10578)

* chore: suppress CA1512 messages

* chore: suppress CA1514 messages

* chore: suppress CA1816 messages

* chore: suppress CA1822 messages

* chore: suppress CA1827 messages

* chore: suppress CA1845 messages

* chore: suppress CA1860 messages

* chore: suppress CA1861 messages

* chore: suppress CA1866 messages

* chore: suppress CA1869 messages

* chore: suppress CA2016 messages

* chore: suppress CA2211 messages

* chore: suppress CA2263 messages

* chore: suppress IDE0004 messages

* chore: suppress IDE0019 messages

* chore: suppress IDE0044 messages

* chore: suppress IDE0051 messages

* chore: suppress IDE0052 messages

* chore: suppress IDE0058 messages

* chore: suppress IDE0130 messages

* chore: suppress IDE0530 messages

* chore: suppress SYSLIB1045 messages

* chore: suppress xUnit2022 messages

* chore: suppress xUnit2024 messages

* chore: suppress IDE0303 messages

* chore: suppress IDE0036 messages

* chore: suppress xUnit1033 messages

Author: filzrev

.editorconfig

@@ -158,9 +158,11 @@ dotnet_diagnostic.IDE0005.severity = warning    # IDE0005: Remove unnecessary im
 dotnet_diagnostic.IDE0035.severity = suggestion # IDE0035: Remove unreachable code
 dotnet_diagnostic.IDE0051.severity = suggestion # IDE0051: Remove unused private member
 dotnet_diagnostic.IDE0052.severity = suggestion # IDE0052: Remove unread private member
+dotnet_diagnostic.IDE0058.severity = silent     # IDE0058: Remove unnecessary expression value
 dotnet_diagnostic.IDE0080.severity = suggestion # IDE0080: Remove unnecessary suppression operator
 dotnet_diagnostic.IDE0100.severity = suggestion # IDE0100: Remove unnecessary equality operator
 dotnet_diagnostic.IDE0110.severity = suggestion # IDE0110: Remove unnecessary discard
+dotnet_diagnostic.IDE0130.severity = silent     # IDE0130: Namespace does not match folder structure
 dotnet_diagnostic.IDE0240.severity = suggestion # IDE0240: Nullable directive is redundant
 dotnet_diagnostic.IDE0241.severity = suggestion # IDE0241: Nullable directive is unnecessary
 

src/Docfx.App/PdfBuilder.cs

@@ -221,7 +221,7 @@ Task<byte[]> PrintHeaderFooter(Outline toc, int pageNumber, int totalPages, Page
 
             async Task<byte[]> PrintHeaderFooterCore()
             {
-                await pageLimiter.WaitAsync();
+                await pageLimiter.WaitAsync(cancellationToken);
                 var page = pagePool.TryTake(out var pooled) ? pooled : await context.NewPageAsync();
 
                 try

src/Docfx.Build.Common/DisposableDocumentProcessor.cs

@@ -22,6 +22,15 @@ public abstract class DisposableDocumentProcessor : IDocumentProcessor, IDisposa
 
     public void Dispose()
     {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
+
+    protected virtual void Dispose(bool disposing)
+    {
+        if (!disposing)
+            return;
+
         if (BuildSteps != null)
         {
             foreach (var buildStep in BuildSteps)

src/Docfx.Build.RestApi/RestApiDocumentProcessor.cs

@@ -248,7 +248,8 @@ private static void CheckOperationId(SwaggerModel swagger, string fileName)
 
     private static string ChangeFileExtension(string file)
     {
-        return file.Substring(0, file.Length - SupportedFileEndings.First(s => IsSupportedFileEnding(file, s)).Length) + ".json";
+        var suffix = SupportedFileEndings.First(s => IsSupportedFileEnding(file, s));
+        return $"{file.AsSpan(0, file.Length - suffix.Length)}.json";
     }
 
     private static Dictionary<string, object> MergeMetadata(IDictionary<string, object> item, IDictionary<string, object> overwriteItems)

src/Docfx.Build.SchemaDriven/Processors/MarkdownInterpreter.cs

@@ -37,7 +37,7 @@ private static string MarkupCore(string content, IProcessContext context, string
         context.Dependency.UnionWith(mr.Dependency);
 
         if (mr.Html.StartsWith("<p"))
-            mr.Html = mr.Html.Insert(mr.Html.IndexOf(">"), " jsonPath=\"" + path + "\"");
+            mr.Html = mr.Html.Insert(mr.Html.IndexOf('>'), " jsonPath=\"" + path + "\"");
         return mr.Html;
     }
 }

src/Docfx.Build.SchemaDriven/Processors/MergeTypeInterpreter.cs

@@ -17,9 +17,4 @@ public object Interpret(BaseSchema schema, object value, IProcessContext context
         // TODO implement
         return value;
     }
-
-    private static object MergeCore(object value, IProcessContext context)
-    {
-        return value;
-    }
 }

src/Docfx.Build.SchemaDriven/SchemaDrivenDocumentProcessor.cs

@@ -185,8 +185,7 @@ public override SaveResult Save(FileModel model)
 
         if (((IDictionary<string, object>)model.Properties).TryGetValue("XrefSpec", out var value))
         {
-            var xrefSpec = value as XRefSpec;
-            if (xrefSpec != null)
+            if (value is XRefSpec xrefSpec)
             {
                 result.XRefSpecs = [xrefSpec];
             }

src/Docfx.Build/Conceptual/ConceptualDocumentProcessor.cs

@@ -107,8 +107,7 @@ public override SaveResult Save(FileModel model)
 
         if (((IDictionary<string, object>)model.Properties).TryGetValue("XrefSpec", out var value))
         {
-            var xrefSpec = value as XRefSpec;
-            if (xrefSpec != null)
+            if (value is XRefSpec xrefSpec)
             {
                 result.XRefSpecs = [xrefSpec];
             }

src/Docfx.Build/DocumentBuilder.cs

@@ -12,7 +12,7 @@
 
 namespace Docfx.Build.Engine;
 
-public class DocumentBuilder : IDisposable
+public sealed class DocumentBuilder : IDisposable
 {
     [ImportMany]
     internal IEnumerable<IDocumentProcessor> Processors { get; set; }
@@ -146,7 +146,7 @@ public void Build(IList<DocumentBuildParameters> parameters, string outputDirect
             .WriteToManifest(generatedManifest, parameters[0].OutputBaseDir)
             .Create();
 
-        _postProcessorsManager.Process(generatedManifest, outputDirectory);
+        _postProcessorsManager.Process(generatedManifest, outputDirectory, cancellationToken);
 
         generatedManifest.Dereference(parameters[0].OutputBaseDir, parameters[0].MaxParallelism);
 

src/Docfx.Build/PostProcessors/ExtractSearchIndex.cs

@@ -18,7 +18,9 @@ partial class ExtractSearchIndex : IPostProcessor
     [GeneratedRegex(@"\s+")]
     private static partial Regex s_regexWhiteSpace();
 
-    private static readonly Regex s_regexCase = new(@"[a-z0-9]+|[A-Z0-9]+[a-z0-9]*|[0-9]+", RegexOptions.Compiled);
+
+    [GeneratedRegex(@"[a-z0-9]+|[A-Z0-9]+[a-z0-9]*|[0-9]+")]
+    private static partial Regex s_regexCase();
 
     private static readonly HashSet<string> s_htmlInlineTags = new(StringComparer.OrdinalIgnoreCase)
     {
@@ -185,7 +187,7 @@ private static string[] GetStems(string str)
             return [string.Empty];
         }
         str = WebUtility.HtmlDecode(str);
-        return s_regexCase.Matches(str).Select(m => m.Value).ToArray();
+        return s_regexCase().Matches(str).Select(m => m.Value).ToArray();
     }
 
     private static List<string> GetStemAggregations(string str)

src/Docfx.Build/TableOfContents/TocDocumentProcessor.cs

@@ -72,7 +72,7 @@ public override void UpdateHref(FileModel model, IDocumentBuildContext context)
         model.Content = toc;
     }
 
-    private void UpdateTocItemHref(TocItemViewModel toc, FileModel model, IDocumentBuildContext context, string includedFrom = null)
+    private static void UpdateTocItemHref(TocItemViewModel toc, FileModel model, IDocumentBuildContext context, string includedFrom = null)
     {
         if (toc.IsHrefUpdated) return;
 
@@ -170,7 +170,7 @@ private static string ResolveHref(string pathToFile, string originalPathToFile,
         return fli.Href + segments;
     }
 
-    private void RegisterTocToContext(TocItemViewModel toc, FileModel model, IDocumentBuildContext context)
+    private static void RegisterTocToContext(TocItemViewModel toc, FileModel model, IDocumentBuildContext context)
     {
         var key = model.Key;
 
@@ -180,7 +180,7 @@ private void RegisterTocToContext(TocItemViewModel toc, FileModel model, IDocume
         context.RegisterTocInfo(new() { TocFileKey = key, Order = toc.Order ?? 0 });
     }
 
-    private void RegisterTocMapToContext(TocItemViewModel item, FileModel model, IDocumentBuildContext context)
+    private static void RegisterTocMapToContext(TocItemViewModel item, FileModel model, IDocumentBuildContext context)
     {
         var key = model.Key;
         // If tocHref is set, href is originally RelativeFolder type, and href is set to the homepage of TocHref,

src/Docfx.Build/TemplateProcessors/TemplateManager.cs

@@ -89,7 +89,7 @@ private bool TryExportResourceFiles(List<string> resourceNames, string outputDir
     {
         ArgumentException.ThrowIfNullOrEmpty(outputDirectory);
 
-        if (!resourceNames.Any())
+        if (resourceNames.Count == 0)
             return false;
 
         bool isEmpty = true;

src/Docfx.Build/XRefMaps/XRefArchive.cs

@@ -13,7 +13,6 @@ public sealed class XRefArchive : IXRefContainer, IDisposable
     #region Consts / Fields
     public const string MajorFileName = "xrefmap.yml";
 
-    private readonly object _syncRoot = new();
     private readonly XRefArchiveMode _mode;
     private readonly ZipArchive _archive;
     private readonly List<string> _entries;

src/Docfx.Build/XRefMaps/XRefArchiveReader.cs

@@ -5,7 +5,7 @@
 
 namespace Docfx.Build.Engine;
 
-public class XRefArchiveReader : XRefRedirectionReader, IDisposable
+public sealed class XRefArchiveReader : XRefRedirectionReader, IDisposable
 {
     #region Fields
     private readonly LruList<Tuple<string, XRefMap>> _lru;

src/Docfx.Build/XRefMaps/XRefCollection.cs

@@ -44,7 +44,7 @@ public async Task<IXRefContainerReader> CreateAsync(CancellationToken cancellati
             AddToDownloadList(_uris, cancellationToken);
             var dict = new Dictionary<string, IXRefContainer>();
 
-            while (_processing.Any())
+            while (_processing.Count != 0)
             {
                 Task<IXRefContainer> task = await Task.WhenAny(_processing.Keys)
                                                       .WaitAsync(cancellationToken);

src/Docfx.Build/XRefMaps/XRefMapDownloader.cs

@@ -80,7 +80,7 @@ private ValueTask<IXRefContainer> ReadLocalFileWithFallback(Uri uri, Cancellatio
     /// <remarks>
     /// Support scheme: http, https, file.
     /// </remarks>
-    private async ValueTask<IXRefContainer> DownloadBySchemeAsync(Uri uri, CancellationToken token = default)
+    private static async ValueTask<IXRefContainer> DownloadBySchemeAsync(Uri uri, CancellationToken token = default)
     {
         IXRefContainer result;
         if (uri.IsFile)

src/Docfx.Common/Git/GitUtility.cs

@@ -168,7 +168,7 @@ static string GitUrlToHttps(string url)
             foreach (var text in File.ReadAllLines(configPath))
             {
                 var line = text.Trim();
-                if (line.StartsWith("["))
+                if (line.StartsWith('['))
                 {
                     var remote = RemoteRegex().Replace(line, "$1");
                     key = remote != line ? remote : "";

src/Docfx.Common/Loggers/CompositeLogListener.cs

@@ -3,7 +3,7 @@
 
 namespace Docfx.Common;
 
-public class CompositeLogListener : ILoggerListener
+public sealed class CompositeLogListener : ILoggerListener
 {
     private readonly object _sync = new();
     private readonly List<ILoggerListener> _listeners = [];

src/Docfx.Common/Path/RelativePath.cs

@@ -447,10 +447,8 @@ private static RelativePath Create(bool isFromWorkingFolder, int parentDirectory
 
     private IEnumerable<string> GetSubdirectories(int skip)
     {
-        if (_parts.Length <= skip)
-        {
-            throw new ArgumentOutOfRangeException(nameof(skip));
-        }
+        ArgumentOutOfRangeException.ThrowIfGreaterThanOrEqual(skip, _parts.Length);
+
         return _parts.Take(_parts.Length - skip - 1);
     }
 

src/Docfx.Common/YamlDeserializerWithFallback.cs

@@ -19,9 +19,8 @@ private YamlDeserializerWithFallback(
     }
 
     public static YamlDeserializerWithFallback Create<T>() =>
-        new(
-            (Func<TextReader> tr) => YamlUtility.Deserialize<T>(tr()),
-            (string path) => YamlUtility.Deserialize<T>(path));
+        new(tr => YamlUtility.Deserialize<T>(tr()),
+            path => YamlUtility.Deserialize<T>(path));
 
     public YamlDeserializerWithFallback WithFallback<T>() =>
         new(

src/Docfx.DataContracts.Common/ExternalReferences/ExternalReferencePackageWriter.cs

@@ -7,7 +7,7 @@
 
 namespace Docfx.DataContracts.Common;
 
-public class ExternalReferencePackageWriter : IDisposable
+public sealed class ExternalReferencePackageWriter : IDisposable
 {
     private readonly ZipArchive _zip;
 

src/Docfx.MarkdigEngine.Extensions/CodeSnippet/CodeSnippet.cs

@@ -111,7 +111,7 @@ public string ToAttributeString()
 
     public string GetHighlightLinesString()
     {
-        if (HighlightRanges != null && HighlightRanges.Any())
+        if (HighlightRanges != null && HighlightRanges.Count != 0)
         {
             return string.Join(',', HighlightRanges.Select(highlight =>
             {

src/Docfx.MarkdigEngine.Extensions/CodeSnippet/HtmlCodeSnippetRenderer.cs

@@ -155,14 +155,14 @@ static void BuildFileExtensionLanguageMap()
         {
             foreach (var (language, aliases) in s_languageAlias.Select(i => (i.Key, i.Value)))
             {
-                Debug.Assert(!language.StartsWith("."));
+                Debug.Assert(!language.StartsWith('.'));
 
                 s_languageByFileExtension.Add(language, language);
                 s_languageByFileExtension.Add($".{language}", language);
 
                 foreach (var alias in aliases)
                 {
-                    Debug.Assert(!alias.StartsWith("."));
+                    Debug.Assert(!alias.StartsWith('.'));
 
                     s_languageByFileExtension.Add(alias, language);
                     s_languageByFileExtension.Add($".{alias}", language);
@@ -418,20 +418,6 @@ private static string CountAndReplaceIndentSpaces(string line, out int count)
         return sb.ToString();
     }
 
-    private static bool IsLineInRange(int lineNumber, List<CodeRange> allCodeRanges)
-    {
-        if (allCodeRanges.Count == 0) return true;
-
-        for (int rangeNumber = 0; rangeNumber < allCodeRanges.Count; rangeNumber++)
-        {
-            var range = allCodeRanges[rangeNumber];
-            if (lineNumber >= range.Start && lineNumber <= range.End)
-                return true;
-        }
-
-        return false;
-    }
-
     private string GetWarning()
     {
         var warningTitle = _context.GetToken(WarningTitleId) ?? DefaultWarningTitle;

src/Docfx.MarkdigEngine.Extensions/ExtensionsHelper.cs

@@ -253,7 +253,7 @@ private static bool MatchPath(ref StringSlice slice, ref string path)
 
         if (includedFilePath.Length >= 1 && includedFilePath.First() == '<' && slice.CurrentChar == '>')
         {
-            includedFilePath = includedFilePath.Substring(1, includedFilePath.Length - 1).Trim();
+            includedFilePath = includedFilePath.Substring(1).Trim();
         }
 
         if (slice.CurrentChar == ')')

src/Docfx.MarkdigEngine.Extensions/MarkdigExtensionSettingConverter.NewtonsoftJson.cs

@@ -41,7 +41,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
                         var name = prop.Name;
 
                         var options = prop.Value;
-                        if (options.Count() == 0)
+                        if (!options.Any())
                         {
                             return new MarkdigExtensionSetting(name);
                         }

src/Docfx.MarkdigEngine.Extensions/MarkdigExtensionSettingConverter.SystemTextJson.cs

@@ -53,7 +53,7 @@ public override void Write(Utf8JsonWriter writer, MarkdigExtensionSetting value,
             if (value == null)
                 return;
 
-            var model = (MarkdigExtensionSetting)value;
+            var model = value;
 
             if (model.Options == null || !model.Options.HasValue)
             {

src/Docfx.MarkdigEngine.Extensions/MarkdownExtensions.cs

@@ -59,7 +59,7 @@ public static MarkdownPipelineBuilder UseOptionalExtensions(
         this MarkdownPipelineBuilder pipeline,
         MarkdigExtensionSetting[] optionalExtensions)
     {
-        if (!optionalExtensions.Any())
+        if (optionalExtensions.Length == 0)
         {
             return pipeline;
         }

src/Docfx.MarkdigEngine.Extensions/MonikerRange/MonikerRangeParser.cs

@@ -10,7 +10,7 @@ namespace Docfx.MarkdigEngine.Extensions;
 
 public class MonikerRangeParser : BlockParser
 {
-    private const string StartString = "moniker";
+    // private const string StartString = "moniker";
     private const string EndString = "moniker-end";
     private const char Colon = ':';
 

src/Docfx.MarkdigEngine.Extensions/QuoteSectionNote/QuoteSectionNoteRender.cs

@@ -104,7 +104,7 @@ public static string FixUpLink(string link)
     {
         if (link.StartsWith("http:"))
         {
-            link = "https:" + link.Substring("http:".Length);
+            link = $"https:{link.AsSpan("http:".Length)}";
         }
         if (Uri.TryCreate(link, UriKind.Absolute, out Uri videoLink))
         {

src/Docfx.Plugins/DefaultFileAbstractLayer.cs

@@ -5,7 +5,7 @@
 
 namespace Docfx.Plugins;
 
-public class DefaultFileAbstractLayer : IFileAbstractLayer
+public sealed class DefaultFileAbstractLayer : IFileAbstractLayer
 {
     public IEnumerable<string> GetAllInputFiles()
     {

src/Docfx.Plugins/DocumentExceptionExtensions.cs

@@ -72,11 +72,7 @@ public static void RunAll<TElement>(this IEnumerable<TElement> elements, Action<
     {
         ArgumentNullException.ThrowIfNull(elements);
         ArgumentNullException.ThrowIfNull(action);
-
-        if (parallelism <= 0)
-        {
-            throw new ArgumentOutOfRangeException(nameof(parallelism));
-        }
+        ArgumentOutOfRangeException.ThrowIfNegativeOrZero(parallelism);
 
         try
         {

src/Docfx.YamlSerialization/YamlDeserializer.cs

@@ -146,7 +146,7 @@ public void RegisterTypeConverter(IYamlTypeConverter typeConverter)
 
     public object? Deserialize(TextReader input, IValueDeserializer? deserializer = null)
     {
-        return Deserialize(input, typeof(object), deserializer);
+        return Deserialize<object>(input, deserializer);
     }
 
     public object? Deserialize(TextReader input, Type type, IValueDeserializer? deserializer = null)
@@ -161,7 +161,7 @@ public void RegisterTypeConverter(IYamlTypeConverter typeConverter)
 
     public object? Deserialize(IParser reader, IValueDeserializer? deserializer = null)
     {
-        return Deserialize(reader, typeof(object), deserializer);
+        return Deserialize<object>(reader, deserializer);
     }
 
     /// <summary>

src/docfx/Models/MetadataCommand.cs

@@ -69,7 +69,7 @@ private static Dictionary<string, string> ResolveMSBuildProperties(MetadataComma
                 if (index > -1)
                 {
                     // Latter one overwrites former one
-                    properties[pair.Substring(0, index)] = pair.Substring(index + 1, pair.Length - index - 1);
+                    properties[pair.Substring(0, index)] = pair.Substring(index + 1);
                 }
             }
         }