Skip to content

Commit

Permalink
✨ Stylecop.json (#14)
Browse files Browse the repository at this point in the history
Adds `stylecop.json` to not require documentation for internal elements.
Adds back XML documentation warning.

+semver:minor
  • Loading branch information
connorjs authored Jul 28, 2024
1 parent 410c616 commit e3e6860
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
6 changes: 1 addition & 5 deletions connorjs-analyzers/build/connorjs-analyzers.globalconfig
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions connorjs-analyzers/build/connorjs-analyzers.props
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<Project>
<ItemGroup>
<GlobalAnalyzerConfigFiles Include="$(MSBuildThisFileDirectory)connorjs-analyzers.globalconfig" />
<AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" Link="stylecop.json" />
</ItemGroup>

<!-- MSBuild properties (for .NET) -->
Expand Down
8 changes: 8 additions & 0 deletions connorjs-analyzers/build/stylecop.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
"settings": {
"documentationRules": {
"documentInternalElements": false
}
}
}

0 comments on commit e3e6860

Please sign in to comment.