Skip to content

Commit d83f40e

Browse files
committed
Add more analyzers and complete editorconfig
1 parent de0afaa commit d83f40e

16 files changed

+324
-96
lines changed

.editorconfig

Lines changed: 244 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,254 @@
22
root = true
33

44
[*]
5-
charset = utf-8
6-
insert_final_newline = true
7-
indent_style = space
85
indent_size = 2
6+
indent_style = space
7+
charset = utf-8
98
trim_trailing_whitespace = true
9+
insert_final_newline = true
1010

1111
[*.cs]
1212
indent_size = 4
13-
dotnet_diagnostic.IDE0005.severity = error
13+
tab_width = 4
14+
15+
# Diagnostics
16+
dotnet_analyzer_diagnostic.category-Style.severity = warning
17+
dotnet_diagnostic.CA1032.severity = none
18+
dotnet_diagnostic.CA1822.severity = none
19+
dotnet_diagnostic.CA2007.severity = none
20+
dotnet_diagnostic.CA2227.severity = none
21+
dotnet_diagnostic.IDE0005.severity = warning
22+
dotnet_diagnostic.IDE0008.severity = none
23+
dotnet_diagnostic.IDE0022.severity = none
24+
dotnet_diagnostic.IDE0061.severity = none
25+
dotnet_diagnostic.IDE0058.severity = none
26+
27+
# Organize usings
28+
dotnet_separate_import_directive_groups = false
1429
dotnet_sort_system_directives_first = true
30+
file_header_template = unset
31+
32+
# this. and Me. preferences
33+
dotnet_style_qualification_for_event = false
34+
dotnet_style_qualification_for_field = false
35+
dotnet_style_qualification_for_method = false
36+
dotnet_style_qualification_for_property = false
37+
38+
# Language keywords vs BCL types preferences
39+
dotnet_style_predefined_type_for_locals_parameters_members = true
40+
dotnet_style_predefined_type_for_member_access = true
41+
42+
# Parentheses preferences
43+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity
44+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity
45+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary
46+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity
47+
48+
# Modifier preferences
49+
dotnet_style_require_accessibility_modifiers = for_non_interface_members
50+
51+
# Expression-level preferences
52+
dotnet_style_coalesce_expression = true
53+
dotnet_style_collection_initializer = true
54+
dotnet_style_explicit_tuple_names = true
55+
dotnet_style_namespace_match_folder = true
56+
dotnet_style_null_propagation = true
57+
dotnet_style_object_initializer = true
58+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
59+
dotnet_style_prefer_auto_properties = true
60+
dotnet_style_prefer_collection_expression = when_types_loosely_match
61+
dotnet_style_prefer_compound_assignment = true
62+
dotnet_style_prefer_conditional_expression_over_assignment = true
63+
dotnet_style_prefer_conditional_expression_over_return = true
64+
dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed
65+
dotnet_style_prefer_inferred_anonymous_type_member_names = true
66+
dotnet_style_prefer_inferred_tuple_names = true
67+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true
68+
dotnet_style_prefer_simplified_boolean_expressions = true
69+
dotnet_style_prefer_simplified_interpolation = true
70+
71+
# Field preferences
72+
dotnet_style_readonly_field = true
73+
74+
# Parameter preferences
75+
dotnet_code_quality_unused_parameters = all:silent
76+
77+
# Suppression preferences
78+
dotnet_remove_unnecessary_suppression_exclusions = none
79+
80+
# New line preferences
81+
dotnet_style_allow_multiple_blank_lines_experimental = true
82+
dotnet_style_allow_statement_immediately_after_block_experimental = true
83+
84+
#### C# Coding Conventions ####
85+
86+
# var preferences
87+
csharp_style_var_elsewhere = false
88+
csharp_style_var_for_built_in_types = false
89+
csharp_style_var_when_type_is_apparent = false
90+
91+
# Expression-bodied members
92+
csharp_style_expression_bodied_accessors = true
93+
csharp_style_expression_bodied_constructors = false
94+
csharp_style_expression_bodied_indexers = true
95+
csharp_style_expression_bodied_lambdas = true
96+
csharp_style_expression_bodied_local_functions = false
97+
csharp_style_expression_bodied_methods = false
98+
csharp_style_expression_bodied_operators = false
99+
csharp_style_expression_bodied_properties = true
100+
101+
# Pattern matching preferences
102+
csharp_style_pattern_matching_over_as_with_null_check = true
103+
csharp_style_pattern_matching_over_is_with_cast_check = true
104+
csharp_style_prefer_extended_property_pattern = true
105+
csharp_style_prefer_not_pattern = true
106+
csharp_style_prefer_pattern_matching = true
107+
csharp_style_prefer_switch_expression = true
108+
109+
# Null-checking preferences
110+
csharp_style_conditional_delegate_call = true
111+
112+
# Modifier preferences
113+
csharp_prefer_static_local_function = true
114+
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async
115+
csharp_style_prefer_readonly_struct = true
116+
csharp_style_prefer_readonly_struct_member = true
117+
118+
# Code-block preferences
119+
csharp_prefer_braces = true
120+
csharp_prefer_simple_using_statement = true
15121
csharp_style_namespace_declarations = file_scoped:warning
16-
csharp_prefer_braces = true:warning
122+
csharp_style_prefer_method_group_conversion = true
123+
csharp_style_prefer_primary_constructors = true
124+
csharp_style_prefer_top_level_statements = true
125+
126+
# Expression-level preferences
127+
csharp_prefer_simple_default_expression = true
128+
csharp_style_deconstructed_variable_declaration = true
129+
csharp_style_implicit_object_creation_when_type_is_apparent = true
130+
csharp_style_inlined_variable_declaration = true
131+
csharp_style_prefer_index_operator = true
132+
csharp_style_prefer_local_over_anonymous_function = true
133+
csharp_style_prefer_null_check_over_type_check = true
134+
csharp_style_prefer_range_operator = true
135+
csharp_style_prefer_tuple_swap = true
136+
csharp_style_prefer_utf8_string_literals = true
137+
csharp_style_throw_expression = true
138+
csharp_style_unused_value_assignment_preference = discard_variable
139+
csharp_style_unused_value_expression_statement_preference = discard_variable
140+
141+
# 'using' directive preferences
142+
csharp_using_directive_placement = outside_namespace
143+
144+
# New line preferences
145+
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true
146+
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true
147+
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true
148+
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true
149+
csharp_style_allow_embedded_statements_on_same_line_experimental = true
150+
151+
#### C# Formatting Rules ####
152+
153+
# New line preferences
154+
csharp_new_line_before_catch = true
155+
csharp_new_line_before_else = true
156+
csharp_new_line_before_finally = true
157+
csharp_new_line_before_members_in_anonymous_types = true
158+
csharp_new_line_before_members_in_object_initializers = true
159+
csharp_new_line_before_open_brace = all
160+
csharp_new_line_between_query_expression_clauses = true
161+
162+
# Indentation preferences
163+
csharp_indent_block_contents = true
164+
csharp_indent_braces = false
165+
csharp_indent_case_contents = true
166+
csharp_indent_case_contents_when_block = true
167+
csharp_indent_labels = one_less_than_current
168+
csharp_indent_switch_labels = true
169+
170+
# Space preferences
171+
csharp_space_after_cast = false
172+
csharp_space_after_colon_in_inheritance_clause = true
173+
csharp_space_after_comma = true
174+
csharp_space_after_dot = false
175+
csharp_space_after_keywords_in_control_flow_statements = true
176+
csharp_space_after_semicolon_in_for_statement = true
177+
csharp_space_around_binary_operators = before_and_after
178+
csharp_space_around_declaration_statements = false
179+
csharp_space_before_colon_in_inheritance_clause = true
180+
csharp_space_before_comma = false
181+
csharp_space_before_dot = false
182+
csharp_space_before_open_square_brackets = false
183+
csharp_space_before_semicolon_in_for_statement = false
184+
csharp_space_between_empty_square_brackets = false
185+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
186+
csharp_space_between_method_call_name_and_opening_parenthesis = false
187+
csharp_space_between_method_call_parameter_list_parentheses = false
188+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
189+
csharp_space_between_method_declaration_name_and_open_parenthesis = false
190+
csharp_space_between_method_declaration_parameter_list_parentheses = false
191+
csharp_space_between_parentheses = false
192+
csharp_space_between_square_brackets = false
193+
194+
# Wrapping preferences
195+
csharp_preserve_single_line_blocks = true
196+
csharp_preserve_single_line_statements = true
197+
198+
#### Naming styles ####
199+
200+
# Naming rules
201+
202+
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
203+
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
204+
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
205+
206+
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
207+
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
208+
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
209+
210+
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
211+
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
212+
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
213+
214+
dotnet_naming_rule.const_fields.symbols = const_fields
215+
dotnet_naming_rule.const_fields.style = pascal_case
216+
dotnet_naming_rule.const_fields.severity = suggestion
217+
218+
dotnet_naming_rule.private_members_with_underscore.symbols = private_fields
219+
dotnet_naming_rule.private_members_with_underscore.style = prefix_underscore
220+
dotnet_naming_rule.private_members_with_underscore.severity = suggestion
221+
222+
# Symbol specifications
223+
224+
dotnet_naming_symbols.interface.applicable_kinds = interface
225+
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
226+
dotnet_naming_symbols.interface.required_modifiers =
227+
228+
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
229+
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
230+
dotnet_naming_symbols.types.required_modifiers =
231+
232+
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
233+
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
234+
dotnet_naming_symbols.non_field_members.required_modifiers =
235+
236+
dotnet_naming_symbols.private_fields.applicable_kinds = field
237+
dotnet_naming_symbols.private_fields.applicable_accessibilities = private
238+
239+
dotnet_naming_symbols.const_fields.applicable_kinds = field
240+
dotnet_naming_symbols.const_fields.required_modifiers = const
241+
242+
# Naming styles
243+
244+
dotnet_naming_style.pascal_case.required_prefix =
245+
dotnet_naming_style.pascal_case.required_suffix =
246+
dotnet_naming_style.pascal_case.word_separator =
247+
dotnet_naming_style.pascal_case.capitalization = pascal_case
248+
249+
dotnet_naming_style.begins_with_i.required_prefix = I
250+
dotnet_naming_style.begins_with_i.required_suffix =
251+
dotnet_naming_style.begins_with_i.word_separator =
252+
dotnet_naming_style.begins_with_i.capitalization = pascal_case
253+
254+
dotnet_naming_style.prefix_underscore.capitalization = camel_case
255+
dotnet_naming_style.prefix_underscore.required_prefix = _

src/Dfe.Analytics/AspNetCore/DfeAnalyticsAspNetCoreConfigureOptions.cs

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,11 @@
33

44
namespace Dfe.Analytics.AspNetCore;
55

6-
internal class DfeAnalyticsAspNetCoreConfigureOptions : IConfigureOptions<DfeAnalyticsAspNetCoreOptions>
6+
#pragma warning disable CA1812
7+
internal class DfeAnalyticsAspNetCoreConfigureOptions(IConfiguration configuration) : IConfigureOptions<DfeAnalyticsAspNetCoreOptions>
8+
#pragma warning restore CA1812
79
{
8-
private readonly IConfiguration _configuration;
9-
10-
public DfeAnalyticsAspNetCoreConfigureOptions(IConfiguration configuration)
11-
{
12-
_configuration = configuration;
13-
}
10+
private readonly IConfiguration _configuration = configuration;
1411

1512
public void Configure(DfeAnalyticsAspNetCoreOptions options)
1613
{

src/Dfe.Analytics/AspNetCore/DfeAnalyticsAspNetCoreOptions.cs

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public class DfeAnalyticsAspNetCoreOptions
4545
/// Whether the original response status code should be used for requests that have been reexecuted
4646
/// using StatusCodePagesMiddleware.
4747
/// </summary>
48-
public bool RestoreOriginalStatusCode { get; set; } = false;
48+
public bool RestoreOriginalStatusCode { get; set; }
4949

5050
/// <summary>
5151
/// Gets the current user's ID from the <see cref="HttpContext"/> using the <see cref="UserIdClaimType"/> claim.
@@ -57,11 +57,8 @@ public class DfeAnalyticsAspNetCoreOptions
5757
{
5858
ArgumentNullException.ThrowIfNull(httpContext);
5959

60-
if (UserIdClaimType is null)
61-
{
62-
throw new InvalidOperationException($"{nameof(UserIdClaimType)} is not configured.");
63-
}
64-
65-
return httpContext.User.FindFirstValue(UserIdClaimType);
60+
return UserIdClaimType is null
61+
? throw new InvalidOperationException($"{nameof(UserIdClaimType)} is not configured.")
62+
: httpContext.User.FindFirstValue(UserIdClaimType);
6663
}
6764
}

src/Dfe.Analytics/AspNetCore/DfeAnalyticsAspNetCorePostConfigureOptions.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33

44
namespace Dfe.Analytics.AspNetCore;
55

6+
#pragma warning disable CA1812
67
internal class DfeAnalyticsAspNetCorePostConfigureOptions : IPostConfigureOptions<DfeAnalyticsAspNetCoreOptions>
8+
#pragma warning restore CA1812
79
{
810
public void PostConfigure(string? name, DfeAnalyticsAspNetCoreOptions options)
911
{

src/Dfe.Analytics/AspNetCore/DfeAnalyticsMiddleware.cs

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
using System.Globalization;
12
using System.Threading.RateLimiting;
23
using Microsoft.AspNetCore.Diagnostics;
34
using Microsoft.AspNetCore.Http;
@@ -211,10 +212,12 @@ protected virtual void PopulateEventFromRequest(Event @event, HttpContext contex
211212
/// </remarks>
212213
/// <param name="context">The current <see cref="HttpContext"/>.</param>
213214
/// <returns>A <see cref="string"/> with an anonymized form of the client's IP address and user agent.</returns>
214-
protected virtual string? GetAnonymizedUserAgentAndIp(HttpContext context) =>
215-
context.Connection.RemoteIpAddress is not null ?
216-
Event.Anonymize(context.Request.Headers.UserAgent + context.Connection.RemoteIpAddress) :
217-
null;
215+
protected virtual string? GetAnonymizedUserAgentAndIp(HttpContext context)
216+
{
217+
ArgumentNullException.ThrowIfNull(context);
218+
219+
return context.Connection.RemoteIpAddress is not null ? Event.Anonymize(context.Request.Headers.UserAgent + context.Connection.RemoteIpAddress) : null;
220+
}
218221

219222
/// <summary>
220223
/// Populates the response properties on <paramref name="event"/> with the information in <paramref name="context"/>.
@@ -228,12 +231,12 @@ protected virtual void PopulateEventFromResponse(Event @event, HttpContext conte
228231
ArgumentNullException.ThrowIfNull(context);
229232

230233
@event.ResponseContentType = context.Response.ContentType;
231-
@event.ResponseStatus = context.Response.StatusCode.ToString();
234+
@event.ResponseStatus = context.Response.StatusCode.ToString(CultureInfo.InvariantCulture);
232235

233236
if (AspNetCoreOptions.RestoreOriginalStatusCode &&
234237
context.Features.Get<IStatusCodeReExecuteFeature>() is IStatusCodeReExecuteFeature statusCodeReExecuteFeature)
235238
{
236-
@event.ResponseStatus = statusCodeReExecuteFeature.OriginalStatusCode.ToString();
239+
@event.ResponseStatus = statusCodeReExecuteFeature.OriginalStatusCode.ToString(CultureInfo.InvariantCulture);
237240
}
238241

239242
// We may not have been able to get the user the first time around (depending on the order middleware is registered);

src/Dfe.Analytics/AspNetCore/EnrichWebRequestEventContext.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Dfe.Analytics.AspNetCore;
44

55
/// <summary>
6-
/// Contains the <see cref="Dfe.Analytics.Event"/> and <see cref="Microsoft.AspNetCore.Http.HttpContext"/> for a request.
6+
/// Contains the <see cref="Analytics.Event"/> and <see cref="Microsoft.AspNetCore.Http.HttpContext"/> for a request.
77
/// </summary>
88
public sealed class EnrichWebRequestEventContext
99
{

src/Dfe.Analytics/AspNetCore/WebRequestEventFeature.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public void IgnoreEvent()
4646
/// <summary>
4747
/// Whether an event has been sent for this <see cref="HttpContext"/>.
4848
/// </summary>
49-
internal bool EventSent { get; private set; } = false;
49+
internal bool EventSent { get; private set; }
5050

5151
internal void MarkEventSent()
5252
{

src/Dfe.Analytics/Dfe.Analytics.csproj

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@
1515
<IncludeSymbols>true</IncludeSymbols>
1616
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
1717
<EmbedUntrackedSources>true</EmbedUntrackedSources>
18+
<AnalysisMode>All</AnalysisMode>
19+
<NoWarn>$(NoWarn);CA1716;CA1852;CA1848</NoWarn>
1820
</PropertyGroup>
19-
21+
2022
<ItemGroup>
2123
<FrameworkReference Include="Microsoft.AspNetCore.App" PrivateAssets="all" />
2224
<PackageReference Include="Google.Cloud.BigQuery.V2" Version="[3.0,4.0)" />
@@ -32,5 +34,5 @@
3234
<ItemGroup>
3335
<None Include="$(RepoRoot)README.md" Pack="true" PackagePath="\" />
3436
</ItemGroup>
35-
37+
3638
</Project>

0 commit comments

Comments
 (0)