Kerberos.NET icon indicating copy to clipboard operation
Kerberos.NET copied to clipboard

Apply the team stylecop rules

Open SteveSyfuhs opened this issue 5 years ago • 0 comments

Describe the bug We have stylecop rules for this project, but it's not included in the build.

Expected behavior We need to include the team-specific rules into the project so the build picks it up.

They are:

<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
    <Rule Id="SA0001" Action="None" />
    <Rule Id="SA1025" Action="None" />
    <Rule Id="SA1117" Action="None" />
    <Rule Id="SA1118" Action="None" />
    <Rule Id="SA1119" Action="None" />
    <Rule Id="SA1121" Action="None" />
    <Rule Id="SA1124" Action="None" />
    <Rule Id="SA1132" Action="None" />
    <Rule Id="SA1201" Action="None" />
    <Rule Id="SA1202" Action="None" />
    <Rule Id="SA1204" Action="None" />
    <Rule Id="SA1401" Action="None" />
    <Rule Id="SA1413" Action="None" />
    <Rule Id="SA1600" Action="None" />
    <Rule Id="SA1602" Action="None" />
    <Rule Id="SA1611" Action="None" />
    <Rule Id="SA1615" Action="None" />
    <Rule Id="SA1618" Action="None" />
    <Rule Id="SA1623" Action="None" />
    <Rule Id="SA1629" Action="None" />
    <Rule Id="SA1642" Action="None" />
    <Rule Id="SA1649" Action="None" />
    <Rule Id="SA1652" Action="None" />

    <!-- Kerberos.NET specific rules -->
    
    <Rule Id="SA1512" Action="None" /> <!-- Single line comments -->
    <Rule Id="CA1707" Action="None" /> <!-- Underscores are required for compat -->
    <Rule Id="SA1310" Action="None" /> <!-- Underscores -->
    <Rule Id="SA1313" Action="None" /> <!-- Underscores -->
    <Rule Id="SA1309" Action="None" /> <!-- Underscores -->
    <Rule Id="SA1009" Action="None" /> <!-- parentheses -->
    <Rule Id="SA1111" Action="None" /> <!-- parentheses -->
    <Rule Id="SA1405" Action="None" /> <!-- Debug.Assert -->
    <Rule Id="CA1034" Action="None" /> <!-- Nested types -->
    <Rule Id="SA1601" Action="None" /> <!-- Partial elements should be documented -->
    <Rule Id="SA1636" Action="None" /> <!-- Header should match settings -->
    <Rule Id="CA1028" Action="None" /> <!-- underlying types -->
    <Rule Id="CA1308" Action="None" /> <!-- ToLowerInvariant -->
    <Rule Id="CA1031" Action="None" /> <!-- Specific exceptions -->
    <Rule Id="CA2225" Action="None" /> <!-- op_implicit -->
</Rules>

And the file header needs to be added:

"documentationRules": {
	"companyName": "The .NET Foundation",
	"xmlHeader": false,
	"documentationCulture": "en-US",
	"headerDecoration": "-----------------------------------------------------------------------",
	"copyrightText": "{headerDecoration}\nLicensed to {companyName} under one or more agreements.\n{companyName} licenses this file to you under the MIT license.\r\n{headerDecoration}",
	"variables": {
		"headerDecoration": "-----------------------------------------------------------------------"
	}
},

SteveSyfuhs avatar Aug 09 '20 15:08 SteveSyfuhs