Repository navigation
Expand file tree
/
Copy path.editorconfig
More file actions
2714 lines (1898 loc) · 93.3 KB
/
Copy path.editorconfig
File metadata and controls
2714 lines (1898 loc) · 93.3 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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Purview.BuildSdk 1.2.0 - managed file, do not edit
#
# This file is written by Purview.BuildSdk and is replaced whenever the SDK version changes. The version
# on the first line is how the SDK recognises a file it owns: a .editorconfig without that marker is
# yours, and is never touched.
#
# To add your own rules, create a second .editorconfig in a subdirectory - `src/.editorconfig` is the
# usual choice - without `root = true`. EditorConfig applies the nearest file last, so your settings win
# over these, and nothing you write is lost when this file is updated.
#
# To stop the SDK updating this file, set one of:
# <PurviewEditorConfigAutoUpdate>false</PurviewEditorConfigAutoUpdate> keep this file as it is
# <PurviewRepoBootstrapMode>Never</PurviewRepoBootstrapMode> opt out of all bootstrapping
# <BootstrapEditorConfigToRepoRoot>false</BootstrapEditorConfigToRepoRoot>
#
# Deleting the first line also works: without the marker the SDK treats the file as yours. You then own
# every rule in it, including the ones a future SDK version would have fixed.
#
# See https://github.com/purview-dev/build-sdk#editorconfig for the full description.
root = true
# Base Configuration - General Settings, File Formatting, and Naming Conventions
# All Files
[*]
charset = utf-8
csharp_style_prefer_method_group_conversion = true:silent
csharp_style_prefer_primary_constructors = true:suggestion
csharp_style_prefer_top_level_statements = true:silent
end_of_line = lf
indent_size = 4
indent_style = tab
insert_final_newline = true
tab_width = 4
trim_trailing_whitespace = true
max_line_length = 120
# Type members
dotnet_hide_advanced_members = false
dotnet_member_insertion_location = with_other_members_of_the_same_kind
dotnet_property_generation_behavior = prefer_throwing_properties
# Symbol search
dotnet_search_reference_assemblies = true
# Nullability settings
dotnet_build_property.Nullable = enable
# Per-rule severity is authoritative in this file. The SDK sets AnalysisMode/AnalysisLevel as
# MSBuild properties, and the .NET SDK ignores bulk 'dotnet_analyzer_diagnostic.*' severity
# configuration whenever those properties are present. Do not re-add a bulk entry here: it
# silently does nothing and hides which severities are actually enforced.
# Visual Studio XML Project Files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
indent_size = 2
# XML Configuration Files
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct,xml,stylecop}]
indent_size = 2
# JSON Files
[*.{json,json5,webmanifest}]
indent_size = 2
# YAML Files
[*.{yml,yaml}]
indent_size = 2
# Markdown Files
[*.{md,mdx}]
trim_trailing_whitespace = false
# Bash Files
[*.sh]
end_of_line = lf
# Batch Files
[*.{cmd,bat}]
end_of_line = crlf
# Web Files
[*.{htm,html,js,jsm,ts,tsx,cjs,cts,ctsx,mjs,mts,mtsx,css,sass,scss,less,pcss,svg,vue}]
indent_size = 2
insert_final_newline = true
# Makefiles
[Makefile]
indent_style = tab
# .NET Style Rules - Naming Conventions
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/language-rules#net-style-rules
[*.{cs,csx,cake,vb,vbx}]
# Non-private static fields are PascalCase
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = warning
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case
# NOTE: the private-field rules that used to sit here referenced a style ('camel_case_underscore')
# and a symbol group ('private_fields') that were never defined, so they never applied. The real
# private-field rules are declared in the "StyleCop Field Naming Rules" section below.
dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected
dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
dotnet_naming_symbols.non_private_static_fields.required_modifiers = static
# Constants are PascalCase (field constants; local constants are locals and stay camelCase)
dotnet_naming_rule.constants_should_be_pascal_case.severity = warning
dotnet_naming_rule.constants_should_be_pascal_case.style = non_private_static_field_style
dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
dotnet_naming_style.constant_style.capitalization = pascal_case
dotnet_naming_symbols.constants.applicable_kinds = field
dotnet_naming_symbols.constants.required_modifiers = const
# Locals and parameters are camelCase
dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style
dotnet_naming_rule.locals_should_be_camel_case.severity = warning
# camel_case_style - Define the camelCase style
dotnet_naming_style.camel_case_style.capitalization = camel_case
dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local
# first_upper_style - The first character must start with an upper-case character
dotnet_naming_style.first_upper_style.capitalization = first_word_upper
# prefix_interface_with_i_style - Interfaces must be PascalCase and first character must be 'I'
dotnet_naming_style.prefix_interface_with_i_style.required_prefix = I
dotnet_naming_style.prefix_interface_with_i_style.capitalization = pascal_case
# prefix_type_parameters_with_t_style - Generic Type Parameters must be PascalCase and start with 'T'
dotnet_naming_style.prefix_type_parameters_with_t_style.capitalization = pascal_case
dotnet_naming_style.prefix_type_parameters_with_t_style.required_prefix = T
# disallowed_style - Anything that has this style applied is marked as disallowed
dotnet_naming_style.disallowed_style.capitalization = pascal_case
dotnet_naming_style.disallowed_style.required_prefix = ____RULE_VIOLATION____
dotnet_naming_style.disallowed_style.required_suffix = ____RULE_VIOLATION____
# internal_error_style - This style should never occur
dotnet_naming_style.internal_error_style.capitalization = pascal_case
dotnet_naming_style.internal_error_style.required_prefix = ____INTERNAL_ERROR____
dotnet_naming_style.internal_error_style.required_suffix = ____INTERNAL_ERROR____
# All public/protected/protected_internal constant fields must be PascalCase
dotnet_naming_rule.public_protected_constant_fields_must_be_pascal_case_rule.severity = warning
dotnet_naming_rule.public_protected_constant_fields_must_be_pascal_case_rule.style = non_private_static_field_style
dotnet_naming_rule.public_protected_constant_fields_must_be_pascal_case_rule.symbols = public_protected_constant_fields_group
dotnet_naming_symbols.public_protected_constant_fields_group.applicable_accessibilities = public, protected, protected_internal
dotnet_naming_symbols.public_protected_constant_fields_group.applicable_kinds = field
dotnet_naming_symbols.public_protected_constant_fields_group.required_modifiers = const
# All public/protected/protected_internal static readonly fields must be PascalCase
dotnet_naming_rule.public_protected_static_readonly_fields_must_be_pascal_case_rule.severity = warning
dotnet_naming_rule.public_protected_static_readonly_fields_must_be_pascal_case_rule.style = non_private_static_field_style
dotnet_naming_rule.public_protected_static_readonly_fields_must_be_pascal_case_rule.symbols = public_protected_static_readonly_fields_group
dotnet_naming_symbols.public_protected_static_readonly_fields_group.applicable_accessibilities = public, protected, protected_internal
dotnet_naming_symbols.public_protected_static_readonly_fields_group.applicable_kinds = field
dotnet_naming_symbols.public_protected_static_readonly_fields_group.required_modifiers = static, readonly
# No other public/protected/protected_internal fields are allowed
dotnet_naming_rule.other_public_protected_fields_disallowed_rule.severity = error
dotnet_naming_rule.other_public_protected_fields_disallowed_rule.style = disallowed_style
dotnet_naming_rule.other_public_protected_fields_disallowed_rule.symbols = other_public_protected_fields_group
dotnet_naming_symbols.other_public_protected_fields_group.applicable_accessibilities = public, protected, protected_internal
dotnet_naming_symbols.other_public_protected_fields_group.applicable_kinds = field
# StyleCop Field Naming Rules
# All non-private constant fields must be PascalCase. Private constants are owned by
# 'private_static_fields_group' below - a field must be covered by exactly one rule, otherwise the
# same violation is reported once per matching rule.
dotnet_naming_rule.stylecop_constant_fields_must_be_pascal_case_rule.severity = warning
dotnet_naming_rule.stylecop_constant_fields_must_be_pascal_case_rule.style = non_private_static_field_style
dotnet_naming_rule.stylecop_constant_fields_must_be_pascal_case_rule.symbols = stylecop_constant_fields_group
dotnet_naming_symbols.stylecop_constant_fields_group.applicable_accessibilities = public, internal, protected_internal, protected, private_protected
dotnet_naming_symbols.stylecop_constant_fields_group.applicable_kinds = field
dotnet_naming_symbols.stylecop_constant_fields_group.required_modifiers = const
# All non-private static readonly fields must be PascalCase. Private static readonly fields are
# owned by 'private_static_fields_group' below (see the note on the constant rule above).
dotnet_naming_rule.stylecop_static_readonly_fields_must_be_pascal_case_rule.severity = warning
dotnet_naming_rule.stylecop_static_readonly_fields_must_be_pascal_case_rule.style = non_private_static_field_style
dotnet_naming_rule.stylecop_static_readonly_fields_must_be_pascal_case_rule.symbols = stylecop_static_readonly_fields_group
dotnet_naming_symbols.stylecop_static_readonly_fields_group.applicable_accessibilities = public, internal, protected_internal, protected, private_protected
dotnet_naming_symbols.stylecop_static_readonly_fields_group.applicable_kinds = field
dotnet_naming_symbols.stylecop_static_readonly_fields_group.required_modifiers = static, readonly
# No non-private instance fields are allowed
dotnet_naming_rule.stylecop_instance_fields_must_be_private_rule.severity = error
dotnet_naming_rule.stylecop_instance_fields_must_be_private_rule.style = disallowed_style
dotnet_naming_rule.stylecop_instance_fields_must_be_private_rule.symbols = stylecop_fields_must_be_private_group
dotnet_naming_symbols.stylecop_fields_must_be_private_group.applicable_accessibilities = public, internal, protected_internal, protected, private_protected
dotnet_naming_symbols.stylecop_fields_must_be_private_group.applicable_kinds = field
# Private static fields are PascalCase: they are type-level state and are never qualified with 'this.'
dotnet_naming_rule.private_static_fields_must_be_pascal_case_rule.severity = warning
dotnet_naming_rule.private_static_fields_must_be_pascal_case_rule.style = non_private_static_field_style
dotnet_naming_rule.private_static_fields_must_be_pascal_case_rule.symbols = private_static_fields_group
dotnet_naming_symbols.private_static_fields_group.applicable_accessibilities = private
dotnet_naming_symbols.private_static_fields_group.applicable_kinds = field
dotnet_naming_symbols.private_static_fields_group.required_modifiers = static
# Private instance fields must be camelCase with a leading underscore: '_name', never 'name'. The
# prefix keeps field access unambiguous (so the noisy 'this.' qualifier is never needed) and keeps
# fields distinguishable from locals and parameters.
dotnet_naming_rule.private_instance_fields_must_be_camel_case_with_underscore_prefix.severity = warning
dotnet_naming_rule.private_instance_fields_must_be_camel_case_with_underscore_prefix.style = camel_case_underscore_style
dotnet_naming_rule.private_instance_fields_must_be_camel_case_with_underscore_prefix.symbols = private_instance_fields_group
dotnet_naming_symbols.private_instance_fields_group.applicable_accessibilities = private
dotnet_naming_symbols.private_instance_fields_group.applicable_kinds = field
# Local variables must be camelCase
dotnet_naming_rule.stylecop_local_fields_must_be_camel_case_rule.severity = silent
dotnet_naming_rule.stylecop_local_fields_must_be_camel_case_rule.style = camel_case_style
dotnet_naming_rule.stylecop_local_fields_must_be_camel_case_rule.symbols = stylecop_local_fields_group
dotnet_naming_symbols.stylecop_local_fields_group.applicable_accessibilities = local
dotnet_naming_symbols.stylecop_local_fields_group.applicable_kinds = local
# Sanity check - uncovered field case
dotnet_naming_rule.sanity_check_uncovered_field_case_rule.severity = error
dotnet_naming_rule.sanity_check_uncovered_field_case_rule.style = internal_error_style
dotnet_naming_rule.sanity_check_uncovered_field_case_rule.symbols = sanity_check_uncovered_field_case_group
dotnet_naming_symbols.sanity_check_uncovered_field_case_group.applicable_accessibilities = *
dotnet_naming_symbols.sanity_check_uncovered_field_case_group.applicable_kinds = field
# All elements (namespaces, classes, enums, etc.) must be PascalCase
dotnet_naming_rule.element_rule.severity = warning
dotnet_naming_rule.element_rule.style = non_private_static_field_style
dotnet_naming_rule.element_rule.symbols = element_group
dotnet_naming_symbols.element_group.applicable_kinds = namespace, class, enum, struct, delegate, event, method, property
# Interfaces use PascalCase and are prefixed with uppercase 'I'
dotnet_naming_rule.interface_rule.severity = warning
dotnet_naming_rule.interface_rule.style = prefix_interface_with_i_style
dotnet_naming_rule.interface_rule.symbols = interface_group
dotnet_naming_symbols.interface_group.applicable_kinds = interface
# Generics Type Parameters use PascalCase and are prefixed with uppercase 'T'
dotnet_naming_rule.type_parameter_rule.severity = warning
dotnet_naming_rule.type_parameter_rule.style = prefix_type_parameters_with_t_style
dotnet_naming_rule.type_parameter_rule.symbols = type_parameter_group
dotnet_naming_symbols.type_parameter_group.applicable_kinds = type_parameter
# Function parameters use camelCase
dotnet_naming_rule.parameters_rule.severity = warning
dotnet_naming_rule.parameters_rule.style = camel_case_style
dotnet_naming_rule.parameters_rule.symbols = parameters_group
dotnet_naming_symbols.parameters_group.applicable_kinds = parameter
# Type Parameters
dotnet_naming_rule.type_parameter_naming.severity = warning
dotnet_naming_rule.type_parameter_naming.style = type_parameter_style
dotnet_naming_rule.type_parameter_naming.symbols = type_parameter_symbol
dotnet_naming_style.type_parameter_style.capitalization = pascal_case
dotnet_naming_style.type_parameter_style.required_prefix = T
dotnet_naming_symbols.type_parameter_symbol.applicable_accessibilities = *
dotnet_naming_symbols.type_parameter_symbol.applicable_kinds = type_parameter
# Naming style shared by the private-field rules: camelCase with a required '_' prefix.
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
dotnet_naming_style.camel_case_underscore_style.required_prefix = _
# Local functions are PascalCase
dotnet_naming_rule.local_functions_should_be_pascal_case.severity = warning
dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style
dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
dotnet_naming_style.local_function_style.capitalization = pascal_case
dotnet_naming_symbols.local_functions.applicable_kinds = local_function
# "this." and "Me." qualifiers
dotnet_style_qualification_for_event = false:silent
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_property = false:silent
# Undocumented
dotnet_style_operator_placement_when_wrapping = end_of_line
# Naming styles
# NOTE: a 'types_should_be_pascal_case' rule (symbol group 'types') and an
# 'interface_should_be_begins_with_i' rule (symbol group 'interface') used to sit here, but neither
# symbol group was ever defined, so neither rule applied. Types are covered by 'element_rule' and
# interfaces by 'interface_rule' above.
# By default, name items with PascalCase
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = non_private_static_field_style
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
# pascal_case_style - Define the PascalCase style
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
# Symbol specifications
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
dotnet_naming_symbols.non_field_members.required_modifiers = *
# Naming styles
dotnet_naming_style.begins_with_i.capitalization = pascal_case
dotnet_naming_style.begins_with_i.required_prefix = I
dotnet_naming_style.begins_with_i.required_suffix =
dotnet_naming_style.begins_with_i.word_separator =
dotnet_naming_style.pascal_case.capitalization = pascal_case
dotnet_naming_style.pascal_case.required_prefix =
dotnet_naming_style.pascal_case.required_suffix =
dotnet_naming_style.pascal_case.word_separator =
# Simplify interpolation
dotnet_diagnostic.IDE0071.severity = warning
# Accessibility modifiers
dotnet_diagnostic.IDE0040.severity = warning
# Allow multiple blank lines
dotnet_diagnostic.IDE2000.severity = silent
# Code Quality Settings
dotnet_code_quality.enable_nullable_reference_types = true
dotnet_code_quality.enableNETAnalyzers = true
dotnet_code_quality.interpolated_string_composite_format = true
dotnet_code_quality.prefer_auto_properties = false
dotnet_code_quality.prefer_const = true
dotnet_code_quality.prefer_inferred_anonymous_type_member_names = true
dotnet_code_quality.prefer_inferred_tuple_names = true
dotnet_code_quality.prefer_readonly = true
# The real modifier policy is 'dotnet_style_require_accessibility_modifiers' (declared under
# "Modifier preferences" below). The 'require_accessibility_modifiers' and
# 'require_explicit_visibility' entries that used to live here are not .NET analyzer options:
# declaring them only pretended to enforce a policy that was never applied, so they were removed.
dotnet_code_quality.require_explicit_type_arguments = true
dotnet_code_quality.require_variable_declaration_for_explicit_type = false
dotnet_code_quality_unused_parameters = all:warning
dotnet_enable_roslyn_analyzers = true
dotnet_remove_unnecessary_suppression_exclusions = none
# RS0016: Add public types and members to the declared API
dotnet_public_api_analyzer.require_api_files = true
# Do not use generic CodeAction.Create to create CodeAction
dotnet_diagnostic.RS0005.severity = none
# C# Specific Settings
[*.{cs,csx,cake}]
# Newline options
csharp_new_line_before_catch = true
csharp_new_line_before_else = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_open_brace = all
csharp_new_line_between_query_expression_clauses = true
# C# Unnecessary code rules
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
csharp_style_unused_value_expression_statement_preference = discard_variable:silent
# Set the C# language version
csharp_language_version = latest
# Prefer var for inferred expressions such as method calls.
# PDS0003 supplies the narrower explicit-type rule for object creation.
csharp_style_var_elsewhere = true:warning
csharp_style_var_for_built_in_types = true:warning
csharp_style_var_when_type_is_apparent = true:warning
# Modifier preferences
csharp_prefer_static_anonymous_function = true
csharp_prefer_static_local_function = true:warning
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:warning
csharp_style_prefer_readonly_struct = true:suggestion
csharp_style_prefer_readonly_struct_member = true:suggestion
dotnet_style_readonly_field = true:warning
dotnet_style_require_accessibility_modifiers = omit_if_default:warning
# Code-block preferences
csharp_prefer_braces = when_multiline:suggestion
csharp_prefer_simple_using_statement = false:silent
dotnet_style_prefer_collection_expression = true:suggestion
# Prefer System.Threading.Lock
csharp_prefer_system_threading_lock = true:warning
# Prefer parameter null checking
csharp_style_prefer_parameter_null_checking = true:suggestion
# Prefer extended property pattern
csharp_style_prefer_extended_property_pattern = true:suggestion
# Prefer UTF-8 string literals
csharp_style_prefer_utf8_string_literals = true:suggestion
# Prefer tuple swap
csharp_style_prefer_tuple_swap = true:suggestion
# Prefer local over anonymous function
csharp_style_prefer_local_over_anonymous_function = true:suggestion
# Prefer unbound generic type in nameof
csharp_style_prefer_unbound_generic_type_in_nameof = true:warning
# Expression-level preferences
csharp_prefer_simple_default_expression = true:warning
csharp_style_deconstructed_variable_declaration = true:warning
csharp_style_implicit_object_creation_when_type_is_apparent = true:warning
csharp_style_inlined_variable_declaration = true:warning
csharp_style_pattern_local_over_anonymous_function = true:warning
csharp_style_prefer_index_operator = true:warning
csharp_style_prefer_range_operator = true:warning
csharp_style_prefer_null_check_over_type_check = true:warning
csharp_style_throw_expression = true:warning
# 'using' directive preferences
csharp_using_directive_placement = outside_namespace:warning
# New line preferences
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true:silent
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:silent
csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent
# Expression-Bodied members
csharp_style_expression_bodied_accessors = true:warning
csharp_style_expression_bodied_constructors = true:warning
csharp_style_expression_bodied_indexers = true:warning
csharp_style_expression_bodied_lambdas = true:warning
csharp_style_expression_bodied_local_functions = true:warning
csharp_style_expression_bodied_methods = true:suggestion
csharp_style_expression_bodied_operators = true:warning
csharp_style_expression_bodied_properties = true:warning
# Pattern matching preferences
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_pattern_matching_over_is_with_cast_check = true:warning
csharp_style_prefer_not_pattern = true:warning
csharp_style_prefer_pattern_matching = true:warning
csharp_style_prefer_switch_expression = true:warning
csharp_style_prefer_explicit_this = true:warning
# "Null" checking preferences
csharp_style_conditional_delegate_call = true:warning
# Spacing options
csharp_space_after_cast = false
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_semicolon_in_for_statement = true
csharp_space_around_binary_operators = before_and_after
csharp_space_around_declaration_statements = false
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_open_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false
# Wrap options
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = false
# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = true
csharp_indent_labels = one_less_than_current
csharp_indent_switch_labels = true
# Namespace options
csharp_style_namespace_declarations = file_scoped:warning
# Visual Basic Specific Settings
[*.{vb}]
visual_basic_preferred_modifier_order = Partial, Default, Private, Protected, Public, Friend, NotOverridable, Overridable, MustOverride, Overloads, Overrides, MustInherit, NotInheritable, Static, Shared, Shadows, ReadOnly, WriteOnly, Dim, Const, WithEvents, Widening, Narrowing, Custom, Async:warning
visual_basic_style_prefer_simplified_object_creation = all : suggestion
visual_basic_style_prefer_isnot_expression = true : suggestion
# .NET Style Preferences
[*.{cs,csx,cake,vb,vbx}]
# Language keywords instead of framework type names for type references
dotnet_style_predefined_type_for_locals_parameters_members = true:warning
dotnet_style_predefined_type_for_member_access = true:warning
# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:warning
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:warning
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:warning
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:warning
dotnet_style_collection_initializer = true:warning
dotnet_style_explicit_tuple_names = true:warning
dotnet_style_object_initializer = true:warning
dotnet_style_prefer_auto_properties = true:warning
dotnet_style_prefer_compound_assignment = true:warning
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
dotnet_style_prefer_conditional_expression_over_return = true:suggestion
dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed:warning
dotnet_style_prefer_inferred_anonymous_type_member_names = true:warning
dotnet_style_prefer_inferred_tuple_names = true:warning
dotnet_style_prefer_simplified_boolean_expressions = false:silent
dotnet_style_prefer_simplified_interpolation = true:warning
# Expression-level preferences
dotnet_prefer_system_hash_code = true
# Null-checking preferences
dotnet_style_coalesce_expression = true:warning
dotnet_style_null_propagation = true:warning
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
[*.g.cs]
# Generated source-generator output: any diagnostics are worthless, so treat as generated code.
generated_code = true
# Missing XML comment for publicly visible type or member 'Type_or_Member'
dotnet_diagnostic.CS1591.severity = none
# Design Rules (CA1000-CA1070)
# Design rules support adherence to the .NET Framework design guidelines
[*.{cs,vb}]
# Do not declare static members on generic types
dotnet_diagnostic.CA1000.severity = suggestion
# Types that own disposable fields should be disposable
dotnet_diagnostic.CA1001.severity = error
# Do not expose generic lists
dotnet_diagnostic.CA1002.severity = error
# Use generic event handler instances
dotnet_diagnostic.CA1003.severity = warning
# Avoid excessive parameters on generic types
dotnet_diagnostic.CA1005.severity = warning
# Enums should have zero value
dotnet_diagnostic.CA1008.severity = error
# Collections should implement generic interface
dotnet_diagnostic.CA1010.severity = warning
# Abstract types should not have public constructors
dotnet_diagnostic.CA1012.severity = error
# Mark assemblies with CLSCompliantAttribute
dotnet_diagnostic.CA1014.severity = silent
# Mark assemblies with AssemblyVersionAttribute
dotnet_diagnostic.CA1016.severity = error
# Mark assemblies with ComVisibleAttribute
dotnet_diagnostic.CA1017.severity = silent
# Mark attributes with AttributeUsageAttribute
dotnet_diagnostic.CA1018.severity = suggestion
# Define accessors for attribute arguments
dotnet_diagnostic.CA1019.severity = suggestion
# Avoid out parameters
dotnet_diagnostic.CA1021.severity = suggestion
# Use properties where appropriate
dotnet_diagnostic.CA1024.severity = suggestion
# Mark enums with FlagsAttribute
dotnet_diagnostic.CA1027.severity = error
# Enum storage should be Int32
dotnet_diagnostic.CA1028.severity = error
# Use events where appropriate
dotnet_diagnostic.CA1030.severity = suggestion
# Do not catch general exception types
dotnet_diagnostic.CA1031.severity = error
# Implement standard exception constructors
# Raised to warning: the public API surface of exceptions is part of the accessibility policy and
# must not be invisible to command-line builds.
dotnet_diagnostic.CA1032.severity = warning
# Interface methods should be callable by child types
# Raised to warning: explicit interface implementations that hide the member from derived types are
# an accessibility problem, not a style preference.
dotnet_diagnostic.CA1033.severity = warning
# Nested types should not be visible
dotnet_diagnostic.CA1034.severity = error
# Override methods on comparable types
dotnet_diagnostic.CA1036.severity = suggestion
# Avoid empty interfaces
# Raised to warning: empty interfaces are unenforceable contracts and were previously invisible to
# command-line builds.
dotnet_diagnostic.CA1040.severity = warning
# Provide ObsoleteAttribute message
dotnet_diagnostic.CA1041.severity = warning
# Use integral or string argument for indexers
dotnet_diagnostic.CA1043.severity = suggestion
# Properties should not be write only
dotnet_diagnostic.CA1044.severity = error
# Do not pass types by reference
dotnet_diagnostic.CA1045.severity = warning
# Do not overload operator equals on reference types
dotnet_diagnostic.CA1046.severity = warning
# Do not declare protected members in sealed types
dotnet_diagnostic.CA1047.severity = error
# Declare types in namespaces
dotnet_diagnostic.CA1050.severity = error
# Do not declare visible instance fields
dotnet_diagnostic.CA1051.severity = error
# Static holder types should be Static or NotInheritable
dotnet_diagnostic.CA1052.severity = warning
# Static holder types should not have default constructors
dotnet_diagnostic.CA1053.severity = warning
# URI parameters should not be strings
dotnet_diagnostic.CA1054.severity = warning
# URI return values should not be strings
dotnet_diagnostic.CA1055.severity = warning
# URI properties should not be strings
dotnet_diagnostic.CA1056.severity = warning
# Types should not extend certain base types
dotnet_diagnostic.CA1058.severity = warning
# Move P/Invokes to NativeMethods class
dotnet_diagnostic.CA1060.severity = warning
# Do not hide base class methods
dotnet_diagnostic.CA1061.severity = warning
# Validate arguments of public methods
dotnet_code_quality.CA1062.api_surface = public, protected
dotnet_diagnostic.CA1062.severity = error
# Implement IDisposable correctly
dotnet_diagnostic.CA1063.severity = error
# Exceptions should be public
dotnet_diagnostic.CA1064.severity = warning
# Do not raise exceptions in unexpected locations
dotnet_diagnostic.CA1065.severity = warning
# Implement IEquatable when overriding Equals
dotnet_diagnostic.CA1066.severity = warning
# Override Equals when implementing IEquatable
dotnet_diagnostic.CA1067.severity = warning
# CancellationToken parameters must come last
dotnet_diagnostic.CA1068.severity = warning
# Enums should not have duplicate values
dotnet_diagnostic.CA1069.severity = error
# Do not declare event fields as virtual
dotnet_diagnostic.CA1070.severity = warning
# Documentation Rules (CA1200)
# Documentation rules support writing well-documented libraries
[*.{cs,vb}]
# Avoid using cref tags with a prefix
dotnet_diagnostic.CA1200.severity = suggestion
# Globalization Rules (CA1303-CA1311 and CA2101)
# Globalization rules support world-ready libraries and applications
[*.{cs,vb}]
# Do not pass literals as localized parameters
dotnet_code_quality.CA1303.use_naming_heuristic = true
dotnet_diagnostic.CA1303.severity = none
# Specify CultureInfo
dotnet_diagnostic.CA1304.severity = error
# Specify IFormatProvider
dotnet_diagnostic.CA1305.severity = error
# Specify StringComparison for clarity
dotnet_diagnostic.CA1307.severity = error
# Normalize strings to uppercase
dotnet_diagnostic.CA1308.severity = warning
# Use ordinal StringComparison
dotnet_diagnostic.CA1309.severity = warning
# Specify StringComparison for correctness
dotnet_diagnostic.CA1310.severity = warning
# Specify a culture or use an invariant version
dotnet_diagnostic.CA1311.severity = error
# Specify marshaling for P/Invoke string arguments
dotnet_diagnostic.CA2101.severity = warning
# Interoperability Rules (CA1400-CA1422)
# Portability rules support portability across different platforms
# Interoperability rules support interaction with COM clients
[*.{cs,vb}]
# P/Invokes should not be visible
dotnet_diagnostic.CA1401.severity = error
# Validate platform compatibility
dotnet_diagnostic.CA1416.severity = suggestion
# Do not use OutAttribute on string parameters for P/Invokes
dotnet_diagnostic.CA1417.severity = suggestion
# Validate platform compatibility
dotnet_diagnostic.CA1418.severity = suggestion
# Provide a parameterless constructor that is as visible as the containing type for concrete types derived from 'System.Runtime.InteropServices.SafeHandle'
dotnet_diagnostic.CA1419.severity = suggestion
# Property, type, or attribute requires runtime marshalling
dotnet_diagnostic.CA1420.severity = suggestion
# Method uses runtime marshalling when DisableRuntimeMarshallingAttribute is applied
dotnet_diagnostic.CA1421.severity = warning
# Validate platform compatibility - obsoleted APIs
dotnet_diagnostic.CA1422.severity = warning
# Maintainability Rules (CA1501-CA1516)
# Maintainability rules support library and application maintenance
[*.{cs,vb}]
# Avoid excessive inheritance
dotnet_diagnostic.CA1501.severity = warning
# Avoid excessive complexity
dotnet_diagnostic.CA1502.severity = error
# Avoid unmaintainable code
dotnet_diagnostic.CA1505.severity = error
# Avoid excessive class coupling
dotnet_diagnostic.CA1506.severity = error
# Use nameof in place of string
dotnet_diagnostic.CA1507.severity = warning
# Avoid dead conditional code
dotnet_diagnostic.CA1508.severity = error
# Invalid entry in code metrics configuration file
dotnet_diagnostic.CA1509.severity = error
# Use ArgumentNullException throw helper
dotnet_diagnostic.CA1510.severity = warning
# Use ArgumentException throw helper
dotnet_diagnostic.CA1511.severity = warning
# Use ArgumentOutOfRangeException throw helper
dotnet_diagnostic.CA1512.severity = warning
# Use ObjectDisposedException throw helper
dotnet_diagnostic.CA1513.severity = warning
# Avoid redundant length argument
dotnet_diagnostic.CA1514.severity = warning
# Consider making public types internal
# Reported as a real build warning (not a suggestion) so accessibility hygiene cannot be ignored:
# a public type in an application or test assembly should be made internal rather than suppressed.
dotnet_diagnostic.CA1515.severity = warning
# Naming Rules (CA1700-CA1727 and IDE0130)
# Naming rules support adherence to the naming conventions of the .NET design guidelines
[*.{cs,vb}]
# Namespace does not match folder structure
dotnet_diagnostic.IDE0130.severity = warning
# Do not name enum values 'Reserved'
dotnet_code_quality.CA1700.api_surface = public, protected
dotnet_diagnostic.CA1700.severity = error
# Identifiers should not contain underscores
dotnet_code_quality.CA1707.api_surface = public, protected
dotnet_diagnostic.CA1707.severity = error
# Identifiers should differ by more than case
dotnet_diagnostic.CA1708.severity = error
# Identifiers should have correct suffix
dotnet_diagnostic.CA1710.severity = error
# Identifiers should not have incorrect suffix
dotnet_diagnostic.CA1711.severity = error
# Do not prefix enum values with type name
dotnet_diagnostic.CA1712.severity = error
# Events should not have Before or After prefix
dotnet_diagnostic.CA1713.severity = error
# Flags enums should have plural names
dotnet_diagnostic.CA1714.severity = error
# Identifiers should have correct prefix
dotnet_diagnostic.CA1715.severity = error
# Identifiers should not match keywords
dotnet_diagnostic.CA1716.severity = error
# Only FlagsAttribute enums should have plural names
dotnet_diagnostic.CA1717.severity = error
# Identifiers should not contain type names
dotnet_diagnostic.CA1720.severity = warning
# Property names should not match get methods
dotnet_diagnostic.CA1721.severity = error
# Type names should not match namespaces
dotnet_diagnostic.CA1724.severity = warning
# Parameter names should match base declaration
dotnet_diagnostic.CA1725.severity = warning
# Use PascalCase for named placeholders
dotnet_diagnostic.CA1727.severity = error
# Performance Rules (CA1802-CA1877)
# Performance rules support high-performance libraries and applications
[*.{cs,vb}]
# Use Literals Where Appropriate
dotnet_diagnostic.CA1802.severity = suggestion
# Do not initialize unnecessarily
dotnet_diagnostic.CA1805.severity = error
# Do not ignore method results
dotnet_diagnostic.CA1806.severity = error
# Initialize reference type static fields inline
dotnet_diagnostic.CA1810.severity = suggestion
# Avoid uninstantiated internal classes
dotnet_diagnostic.CA1812.severity = suggestion
# Avoid unsealed attributes
dotnet_diagnostic.CA1813.severity = suggestion
# Prefer jagged arrays over multidimensional
dotnet_diagnostic.CA1814.severity = warning
# Override equals and operator equals on value types
dotnet_diagnostic.CA1815.severity = warning
# Properties should not return arrays
dotnet_diagnostic.CA1819.severity = warning
dotnet_code_quality.CA1819.api_surface = public, protected
# Test for empty strings using string length
dotnet_diagnostic.CA1820.severity = error
# Remove empty finalizers
dotnet_diagnostic.CA1821.severity = error
# Mark members as static
dotnet_diagnostic.CA1822.severity = suggestion
# Avoid unused private fields
dotnet_diagnostic.CA1823.severity = error
# Mark assemblies with NeutralResourcesLanguageAttribute
dotnet_diagnostic.CA1824.severity = suggestion
# Avoid zero-length array allocations
dotnet_diagnostic.CA1825.severity = suggestion
# Use property instead of Linq Enumerable method
dotnet_diagnostic.CA1826.severity = error
# Do not use Count/LongCount when Any can be used
dotnet_diagnostic.CA1827.severity = silent
# Do not use CountAsync/LongCountAsync when AnyAsync can be used
dotnet_diagnostic.CA1828.severity = silent
# Use Length/Count property instead of Enumerable.Count() method
dotnet_diagnostic.CA1829.severity = error
# Prefer strongly-typed Append and Insert method overloads on StringBuilder
dotnet_diagnostic.CA1830.severity = warning
# Use AsSpan instead of Range-based indexers for string when appropriate
dotnet_diagnostic.CA1831.severity = error
# Use AsSpan or AsMemory instead of Range-based indexers for getting ReadOnlySpan or ReadOnlyMemory portion of an array *
dotnet_diagnostic.CA1832.severity = error
# Use AsSpan or AsMemory instead of Range-based indexers for getting Span or Memory portion of an array
dotnet_diagnostic.CA1833.severity = error
# Use StringBuilder.Append(char) for single character strings
dotnet_diagnostic.CA1834.severity = suggestion
# Prefer the memory-based overloads of ReadAsync/WriteAsync methods in stream-based classes
dotnet_diagnostic.CA1835.severity = warning
# Prefer IsEmpty over Count when available
dotnet_diagnostic.CA1836.severity = error
# Use Environment.ProcessId instead of Process.GetCurrentProcess().Id
dotnet_diagnostic.CA1837.severity = suggestion
# Avoid StringBuilder parameters for P/Invokes
dotnet_diagnostic.CA1838.severity = warning
# Use Environment.ProcessPath instead of Process.GetCurrentProcess().MainModule.FileName
dotnet_diagnostic.CA1839.severity = error
# Use Environment.CurrentManagedThreadId instead of Thread.CurrentThread.ManagedThreadId
dotnet_diagnostic.CA1840.severity = silent
# Prefer Dictionary Contains methods
dotnet_diagnostic.CA1841.severity = silent
# Do not use 'WhenAll' with a single task
*
dotnet_diagnostic.CA1842.severity = error
# Do not use 'WaitAll' with a single task
*
dotnet_diagnostic.CA1843.severity = error
# Provide memory-based overrides of async methods when subclassing 'Stream' *
dotnet_diagnostic.CA1844.severity = warning
# Use span-based 'string.Concat'
dotnet_diagnostic.CA1845.severity = error
# Prefer AsSpan over Substring
dotnet_diagnostic.CA1846.severity = error
# CA1852 (seal internal types) is intentionally not suppressed for internal types that are exposed
# to other assemblies through InternalsVisibleTo: those types must still be sealed. The blanket
# suppression that used to sit here relied on a malformed key, so it never even applied.
# Unsafe DataSet or DataTable in serializable type can be vulnerable to remote code execution attacks
dotnet_diagnostic.CA2352.severity = error