forked from dotnet/roslyn-analyzers
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMicrosoft.CodeAnalysis.PublicApiAnalyzers.sarif
More file actions
157 lines (157 loc) · 5.93 KB
/
Microsoft.CodeAnalysis.PublicApiAnalyzers.sarif
File metadata and controls
157 lines (157 loc) · 5.93 KB
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
{
"$schema": "http://json.schemastore.org/sarif-1.0.0",
"version": "1.0.0",
"runs": [
{
"tool": {
"name": "Microsoft.CodeAnalysis.PublicApiAnalyzers",
"version": "2.9.7",
"language": "en-US"
},
"rules": {
"RS0016": {
"id": "RS0016",
"shortDescription": "Add public types and members to the declared API",
"fullDescription": "All public types and members should be declared in PublicAPI.txt. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes.",
"defaultLevel": "warning",
"helpUri": "https://github.com/dotnet/roslyn-analyzers/blob/master/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md",
"properties": {
"category": "ApiDesign",
"isEnabledByDefault": true,
"typeName": "DeclarePublicApiAnalyzer",
"languages": [
"C#",
"Visual Basic"
],
"tags": [
"Telemetry"
]
}
},
"RS0017": {
"id": "RS0017",
"shortDescription": "Remove deleted types and members from the declared API",
"fullDescription": "When removing a public type or member the corresponding entry in PublicAPI.txt should also be removed. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes.",
"defaultLevel": "warning",
"helpUri": "https://github.com/dotnet/roslyn-analyzers/blob/master/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md",
"properties": {
"category": "ApiDesign",
"isEnabledByDefault": true,
"typeName": "DeclarePublicApiAnalyzer",
"languages": [
"C#",
"Visual Basic"
],
"tags": [
"Telemetry"
]
}
},
"RS0022": {
"id": "RS0022",
"shortDescription": "Constructor make noninheritable base class inheritable",
"fullDescription": "Constructor makes its noninheritable base class inheritable, thereby exposing its protected members.",
"defaultLevel": "warning",
"helpUri": "https://github.com/dotnet/roslyn-analyzers/blob/master/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md",
"properties": {
"category": "ApiDesign",
"isEnabledByDefault": true,
"typeName": "DeclarePublicApiAnalyzer",
"languages": [
"C#",
"Visual Basic"
],
"tags": [
"Telemetry"
]
}
},
"RS0024": {
"id": "RS0024",
"shortDescription": "The contents of the public API files are invalid",
"fullDescription": "The contents of the public API files are invalid: {0}",
"defaultLevel": "warning",
"helpUri": "https://github.com/dotnet/roslyn-analyzers/blob/master/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md",
"properties": {
"category": "ApiDesign",
"isEnabledByDefault": true,
"typeName": "DeclarePublicApiAnalyzer",
"languages": [
"C#",
"Visual Basic"
],
"tags": [
"Telemetry"
]
}
},
"RS0025": {
"id": "RS0025",
"shortDescription": "Do not duplicate symbols in public API files",
"fullDescription": "The symbol '{0}' appears more than once in the public API files.",
"defaultLevel": "warning",
"helpUri": "https://github.com/dotnet/roslyn-analyzers/blob/master/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md",
"properties": {
"category": "ApiDesign",
"isEnabledByDefault": true,
"typeName": "DeclarePublicApiAnalyzer",
"languages": [
"C#",
"Visual Basic"
],
"tags": [
"Telemetry"
]
}
},
"RS0026": {
"id": "RS0026",
"shortDescription": "Do not add multiple public overloads with optional parameters",
"fullDescription": "Symbol '{0}' violates the backcompat requirement: 'Do not add multiple overloads with optional parameters'. See '{1}' for details.",
"defaultLevel": "warning",
"helpUri": "https://github.com/dotnet/roslyn/blob/master/docs/Adding%20Optional%20Parameters%20in%20Public%20API.md",
"properties": {
"category": "ApiDesign",
"isEnabledByDefault": true,
"typeName": "DeclarePublicApiAnalyzer",
"languages": [
"C#",
"Visual Basic"
],
"tags": [
"Telemetry"
]
}
},
"RS0027": {
"id": "RS0027",
"shortDescription": "Public API with optional parameter(s) should have the most parameters amongst its public overloads.",
"fullDescription": "Symbol '{0}' violates the backcompat requirement: 'Public API with optional parameter(s) should have the most parameters amongst its public overloads'. See '{1}' for details.",
"defaultLevel": "warning",
"helpUri": "https://github.com/dotnet/roslyn/blob/master/docs/Adding%20Optional%20Parameters%20in%20Public%20API.md",
"properties": {
"category": "ApiDesign",
"isEnabledByDefault": true,
"typeName": "DeclarePublicApiAnalyzer",
"languages": [
"C#",
"Visual Basic"
],
"tags": [
"Telemetry"
]
}
}
}
},
{
"tool": {
"name": "Microsoft.CodeAnalysis.PublicApiAnalyzers.CodeFixes",
"version": "2.9.7",
"language": "en-US"
},
"rules": {
}
}
]
}