.template-NuGet/StyleCop.json at main · TaffarelJr/.template-NuGet · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{
  "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
  "settings": {
    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#documentation-rules
    "documentationRules": {
      "companyName": "RJ Hollberg",
      "copyrightText": "Copyright © {companyName}. All rights reserved.\nLicensed under the {licenseName} license.\nSee the {licenseFile} file in the project root for full license information.",
      "xmlHeader": true,
      "variables": {
        "licenseName": "MIT",
        "licenseFile": "LICENSE"
      },
      "headerDecoration": "─────────────────────────────────────────────────────────────────────────────",
      "documentInterfaces": true,
      "documentExposedElements": true,
      "documentInternalElements": true,
      "documentPrivateElements": false,
      "documentPrivateFields": false,
      "documentationCulture": "en-US",
      "fileNamingConvention": "stylecop",
      "excludeFromPunctuationCheck": ["seealso"]
    },

    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#indentation
    "indentation": {
      "indentationSize": 4,
      "tabSize": 4,
      "useTabs": false
    },

    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#layout-rules
    "layoutRules": {
      "newlineAtEndOfFile": "require",
      "allowConsecutiveUsings": true,
      "allowDoWhileOnClosingBrace": false
    },

    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#maintainability-rules
    "maintainabilityRules": {
      "topLevelTypes": ["class", "interface", "struct", "enum"]
    },

    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#naming-rules
    "namingRules": {
      "allowCommonHungarianPrefixes": false,
      "allowedHungarianPrefixes": [],
      "allowedNamespaceComponents": [],
      "includeInferredTupleElementNames": false,
      "tupleElementNameCasing": "PascalCase"
    },

    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#ordering-rules
    "orderingRules": {
      "elementOrder": ["kind", "accessibility", "constant", "static", "readonly"],
      "systemUsingDirectivesFirst": true,
      "usingDirectivesPlacement": "outsideNamespace",
      "blankLinesBetweenUsingGroups": "allow"
    },

    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#readability-rules
    "readabilityRules": {
      "allowBuiltInTypeAliases": false
    },

    // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md#spacing-rules
    "spacingRules": {}
  }
}