From 3a42c0a119af659c842922ca8759b6a63862a876 Mon Sep 17 00:00:00 2001 From: Phil Scott Date: Sat, 20 Feb 2021 22:40:37 -0500 Subject: [PATCH] Adds DotSettings and tweaks editoconfigs for tests R# and Rider have quite a bit of noise related to documentation in the testing projects so this disables those warnings. In the main projects, R# and Rider complain loudly about the namespaces not matching the file structure. The DotSettings file disables that warning. Once you get rid of that noise there are quite a few opportunities for trimming out redundant code that R# points out especially with the nullable support enabled, plus there are some bugs related to multiple enumerations worth looking into I think. --- src/Spectre.Console.Testing/.editorconfig | 3 +++ src/Spectre.Console.Tests/.editorconfig | 6 ++++++ src/Spectre.Console.sln.DotSettings | 2 ++ 3 files changed, 11 insertions(+) create mode 100644 src/Spectre.Console.sln.DotSettings diff --git a/src/Spectre.Console.Testing/.editorconfig b/src/Spectre.Console.Testing/.editorconfig index 70136ae..4f53fb9 100644 --- a/src/Spectre.Console.Testing/.editorconfig +++ b/src/Spectre.Console.Testing/.editorconfig @@ -7,6 +7,9 @@ dotnet_diagnostic.CS1591.severity = none # SA1600: Elements should be documented dotnet_diagnostic.SA1600.severity = none +# SA1200: Using directives should be placed correctly +dotnet_diagnostic.SA1200.severity = none + # Default severity for analyzer diagnostics with category 'StyleCop.CSharp.OrderingRules' dotnet_analyzer_diagnostic.category-StyleCop.CSharp.OrderingRules.severity = none diff --git a/src/Spectre.Console.Tests/.editorconfig b/src/Spectre.Console.Tests/.editorconfig index 5b36435..5a0cfde 100644 --- a/src/Spectre.Console.Tests/.editorconfig +++ b/src/Spectre.Console.Tests/.editorconfig @@ -7,6 +7,12 @@ dotnet_analyzer_diagnostic.category-StyleCop.CSharp.DocumentationRules.severity # CA1707: Identifiers should not contain underscores dotnet_diagnostic.CA1707.severity = none +# SA1600: Elements should be documented +dotnet_diagnostic.SA1600.severity = none + +# SA1601: Partial elements should be documented +dotnet_diagnostic.SA1601.severity = none + # SA1200: Using directives should be placed correctly dotnet_diagnostic.SA1200.severity = none diff --git a/src/Spectre.Console.sln.DotSettings b/src/Spectre.Console.sln.DotSettings new file mode 100644 index 0000000..5b88222 --- /dev/null +++ b/src/Spectre.Console.sln.DotSettings @@ -0,0 +1,2 @@ + + DO_NOT_SHOW \ No newline at end of file