From baaf9bea6b7d1119c03346637dd65e0d5a39d2ca Mon Sep 17 00:00:00 2001 From: Connor Sullivan Date: Sun, 28 Jul 2024 18:16:54 -0400 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Stylecop.json?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds `stylecop.json` to not require documentation for internal elements. Adds back XML documentation warning. semver:major --- connorjs-analyzers/build/connorjs-analyzers.globalconfig | 6 +----- connorjs-analyzers/build/connorjs-analyzers.props | 1 + connorjs-analyzers/build/stylecop.json | 8 ++++++++ 3 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 connorjs-analyzers/build/stylecop.json diff --git a/connorjs-analyzers/build/connorjs-analyzers.globalconfig b/connorjs-analyzers/build/connorjs-analyzers.globalconfig index 4d76552..fae3450 100644 --- a/connorjs-analyzers/build/connorjs-analyzers.globalconfig +++ b/connorjs-analyzers/build/connorjs-analyzers.globalconfig @@ -71,10 +71,6 @@ dotnet_diagnostic.SA1518.severity = none # StyleCop - https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/DOCUMENTATION.md -## Special rules - https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SpecialRules.md -; Not all projects need to generate XML Documentation. Trust projects to enable `GenerateDocumentationFile` if needed. -dotnet_diagnostic.SA0001.severity = none - ## Documentation - https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/DocumentationRules.md -; Do not need file header. +; Do not need file header (repository licenses should suffice) dotnet_diagnostic.SA1633.severity = none diff --git a/connorjs-analyzers/build/connorjs-analyzers.props b/connorjs-analyzers/build/connorjs-analyzers.props index 56b3b22..759bd80 100644 --- a/connorjs-analyzers/build/connorjs-analyzers.props +++ b/connorjs-analyzers/build/connorjs-analyzers.props @@ -1,6 +1,7 @@ + diff --git a/connorjs-analyzers/build/stylecop.json b/connorjs-analyzers/build/stylecop.json new file mode 100644 index 0000000..b3dfb25 --- /dev/null +++ b/connorjs-analyzers/build/stylecop.json @@ -0,0 +1,8 @@ +{ + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "settings": { + "documentationRules": { + "documentInternalElements": false + } + } +}