8000 Specify api_surface property for all code quality rules (#15778) · PowerShell/PowerShell@6a21bcc · GitHub
[go: up one dir, main page]

Skip to content

Commit 6a21bcc

Browse files
authored
Specify api_surface property for all code quality rules (#15778)
1 parent 336bec3 commit 6a21bcc

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

.globalconfig

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@ dotnet_diagnostic.CA1005.severity = none
2525
# CA1008: Enums should have zero value
2626
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1008
2727
dotnet_diagnostic.CA1008.severity = none
28+
dotnet_code_quality.CA1008.api_surface = public
2829

2930
# CA1010: Generic interface should also be implemented
3031
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1010
3132
dotnet_diagnostic.CA1010.severity = silent
33+
dotnet_code_quality.CA1010.api_surface = public
3234

3335
# CA1012: Abstract types should not have public constructors
3436
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1012
@@ -62,18 +64,22 @@ dotnet_diagnostic.CA1021.severity = none
6264
# CA1024: Use properties where appropriate
6365
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1024
6466
dotnet_diagnostic.CA1024.severity = none
67+
dotnet_code_quality.CA1024.api_surface = public
6568

6669
# CA1027: Mark enums with FlagsAttribute
6770
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1027
6871
dotnet_diagnostic.CA1027.severity = none
72+
dotnet_code_quality.CA1027.api_surface = public
6973

7074
# CA1028: Enum Storage should be Int32
7175
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1028
7276
dotnet_diagnostic.CA1028.severity = none
77+
dotnet_code_quality.CA1028.api_surface = public
7378

7479
# CA1030: Use events where appropriate
7580
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1030
7681
dotnet_diagnostic.CA1030.severity = none
82+
dotnet_code_quality.CA1030.api_surface = public
7783

7884
# CA1031: Do not catch general exception types
7985
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1031
@@ -94,23 +100,27 @@ dotnet_diagnostic.CA1034.severity = none
94100
# CA1036: Override methods on comparable types
95101
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1036
96102
dotnet_diagnostic.CA1036.severity = silent
103+
dotnet_code_quality.CA1036.api_surface = public
97104

98105
# CA1040: Avoid empty interfaces
99106
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1040
100107
dotnet_diagnostic.CA1040.severity = none
108+
dotnet_code_quality.CA1040.api_surface = public
101109

102110
# CA1041: Provide ObsoleteAttribute message
103111
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1041
104112
dotnet_diagnostic.CA1041.severity = warning
113+
dotnet_code_quality.CA1041.api_surface = public
105114

106115
# CA1043: Use Integral Or String Argument For Indexers
107116
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1043
108117
dotnet_diagnostic.CA1043.severity = warning
109-
dotnet_code_quality.ca1043.api_surface = all
118+
dotnet_code_quality.CA1043.api_surface = all
110119

111120
# CA1044: Properties should not be write only
112121
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1044
113122
dotnet_diagnostic.CA1044.severity = none
123+
dotnet_code_quality.CA1044.api_surface = public
114124

115125
# CA1045: Do not pass types by reference
116126
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1045
@@ -131,6 +141,7 @@ dotnet_diagnostic.CA1050.severity = warning
131141
# CA1051: Do not declare visible instance fields
132142
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1051
133143
dotnet_diagnostic.CA1051.severity = silent
144+
dotnet_code_quality.CA1051.api_surface = public
134145

135146
# CA1052: Static holder types should be Static or NotInheritable
136147
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1052
@@ -140,18 +151,22 @@ dotnet_code_quality.CA1052.api_surface = private, internal
140151
# CA1054: URI-like parameters should not be strings
141152
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1054
142153
dotnet_diagnostic.CA1054.severity = none
154+
dotnet_code_quality.CA1054.api_surface = public
143155

144156
# CA1055: URI-like return values should not be strings
145157
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1055
146158
dotnet_diagnostic.CA1055.severity = none
159+
dotnet_code_quality.CA1055.api_surface = public
147160

148161
# CA1056: URI-like properties should not be strings
149162
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1056
150163
dotnet_diagnostic.CA1056.severity = none
164+
dotnet_code_quality.CA1056.api_surface = public
151165

152166
# CA1058: Types should not extend certain base types
153167
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1058
154168
dotnet_diagnostic.CA1058.severity = none
169+
dotnet_code_quality.CA1058.api_surface = public
155170

156171
# CA1060: Move pinvokes to native methods class
157172
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1060
@@ -168,6 +183,7 @@ dotnet_diagnostic.CA1062.severity = none
168183
# CA1063: Implement IDisposable Correctly
169184
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1063
170185
dotnet_diagnostic.CA1063.severity = none
186+
dotnet_code_quality.CA1063.api_surface = public
171187

172188
# CA1064: Exceptions should be public
173189
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1064
@@ -284,14 +300,17 @@ dotnet_diagnostic.CA1707.severity = silent
284300
# CA1708: Identifiers should differ by more than case
285301
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1708
286302
dotnet_diagnostic.CA1708.severity = silent
303+
dotnet_code_quality.CA1708.api_surface = public
287304

288305
# CA1710: Identifiers should have correct suffix
289306
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1710
290307
dotnet_diagnostic.CA1710.severity = silent
308+
dotnet_code_quality.CA1710.api_surface = public
291309

292310
# CA1711: Identifiers should not have incorrect suffix
293311
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1711
294312
dotnet_diagnostic.CA1711.severity = silent
313+
dotnet_code_quality.CA1711.api_surface = public
295314

296315
# CA1712: Do not prefix enum values with type name
297316
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1712
@@ -304,18 +323,22 @@ dotnet_diagnostic.CA1713.severity = none
304323
# CA1715: Identifiers should have correct prefix
305324
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1715
306325
dotnet_diagnostic.CA1715.severity = silent
326+
dotnet_code_quality.CA1715.api_surface = public
307327

308328
# CA1716: Identifiers should not match keywords
309329
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1716
310330
dotnet_diagnostic.CA1716.severity = silent
331+
dotnet_code_quality.CA1716.api_surface = public
311332

312333
# CA1720: Identifier contains type name
313334
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1720
314335
dotnet_diagnostic.CA1720.severity = silent
336+
dotnet_code_quality.CA1720.api_surface = public
315337

316338
# CA1721: Property names should not match get methods
317339
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1721
318340
dotnet_diagnostic.CA1721.severity = none
341+
dotnet_code_quality.CA1721.api_surface = public
319342

320343
# CA1724: Type names should not match namespaces
321344
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1724
@@ -324,14 +347,17 @@ dotnet_diagnostic.CA1724.severity = none
324347
# CA1725: Parameter names should match base declaration
325348
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1725
326349
dotnet_diagnostic.CA1725.severity = silent
350+
dotnet_code_quality.CA1725.api_surface = public
327351

328352
# CA1801: Review unused parameters
329353
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1801
330354
dotnet_diagnostic.CA1801.severity = none
355+
dotnet_code_quality.CA1801.api_surface = all
331356

332357
# CA1802: Use literals where appropriate
333358
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1802
334359
dotnet_diagnostic.CA1802.severity = none
360+
dotnet_code_quality.CA1802.api_surface = public
335361

336362
# CA1805: Do not initialize unnecessarily
337363
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1805
@@ -360,6 +386,7 @@ dotnet_diagnostic.CA1814.severity = none
360386
# CA1815: Override equals and operator equals on value types
361387
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1815
362388
dotnet_diagnostic.CA1815.severity = none
389+
dotnet_code_quality.CA1815.api_surface = public
363390

364391
# CA1816: Dispose methods should call SuppressFinalize
365392
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1816
@@ -368,6 +395,7 @@ dotnet_diagnostic.CA1816.severity = warning
368395
# CA1819: Properties should not return arrays
369396
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1819
370397
dotnet_diagnostic.CA1819.severity = none
398+
dotnet_code_quality.CA1819.api_surface = public
371399

372400
# CA1820: Test for empty strings using string length
373401
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1820
@@ -557,6 +585,7 @@ dotnet_diagnostic.CA2207.severity = warning
557585
# CA2208: Instantiate argument exceptions correctly
558586
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2208
559587
dotnet_diagnostic.CA2208.severity = suggestion
588+
dotnet_code_quality.CA2208.api_surface = all
560589

561590
# CA2211: Non-constant fields should not be visible
562591
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2211
@@ -581,6 +610,7 @@ dotnet_diagnostic.CA2216.severity = warning
581610
# CA2217: Do not mark enums with FlagsAttribute
582611
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2217
583612
dotnet_diagnostic.CA2217.severity = none
613+
dotnet_code_quality.CA2217.api_surface = public
584614

585615
# CA2218: Override GetHashCode on overriding Equals
586616
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2218
@@ -597,10 +627,12 @@ dotnet_diagnostic.CA2224.severity = suggestion
597627
# CA2225: Operator overloads have named alternates
598628
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2225
599629
dotnet_diagnostic.CA2225.severity = none
630+
dotnet_code_quality.CA2225.api_surface = public
600631

601632
# CA2226: Operators should have symmetrical overloads
602633
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2226
603634
dotnet_diagnostic.CA2226.severity = none
635+
dotnet_code_quality.CA2226.api_surface = public
604636

605637
# CA2227: Collection properties should be read only
606638
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2227
@@ -613,10 +645,12 @@ dotnet_diagnostic.CA2229.severity = silent
613645
# CA2231: Overload operator equals on overriding value type Equals
614646
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2231
615647
dotnet_diagnostic.CA2231.severity = suggestion
648+
dotnet_code_quality.CA2231.api_surface = public
616649

617650
# CA2234: Pass system uri objects instead of strings
618651
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2234
619652
dotnet_diagnostic.CA2234.severity = none
653+
dotnet_code_quality.CA2234.api_surface = public
620654

621655
# CA2235: Mark all non-serializable fields
622656
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2235

0 commit comments

Comments
 (0)
0