Skip to content

Commit 69de0c9

Browse files
mikechu-optimizelymikechu-optimizely
authored
Add IDE-level linting of code style guide (#301)
* Add Rider .idea/ to gitignore * Add JetBrains Rider coding style .DotSettings * Add VS code style settings .editorconfig file
1 parent 0bd8a45 commit 69de0c9

File tree

3 files changed

+287
-0
lines changed

3 files changed

+287
-0
lines changed

‎.editorconfig

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

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,3 +245,5 @@ OptimizelySDK.Package/nuget.exe
245245
OptimizelySDK.Package/content
246246
OptimizelySDK.Package/lib
247247

248+
# JetBrains
249+
.idea/

‎OptimizelySDK.sln.DotSettings

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
2+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/BRACES_FOR_FOR/@EntryValue">Required</s:String>
3+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/BRACES_FOR_FOREACH/@EntryValue">Required</s:String>
4+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/BRACES_FOR_IFELSE/@EntryValue">Required</s:String>
5+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/BRACES_FOR_WHILE/@EntryValue">Required</s:String>
6+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/FORCE_ATTRIBUTE_STYLE/@EntryValue">Join</s:String>
7+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/LOCAL_FUNCTION_BODY/@EntryValue">ExpressionBody</s:String>
8+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/METHOD_OR_OPERATOR_BODY/@EntryValue">ExpressionBody</s:String>
9+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/TRAILING_COMMA_IN_MULTILINE_LISTS/@EntryValue">True</s:Boolean>
10+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/ACCESSOR_DECLARATION_BRACES/@EntryValue">END_OF_LINE</s:String>
11+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/ACCESSOR_OWNER_DECLARATION_BRACES/@EntryValue">END_OF_LINE</s:String>
12+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/ANONYMOUS_METHOD_DECLARATION_BRACES/@EntryValue">END_OF_LINE</s:String>
13+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/CASE_BLOCK_BRACES/@EntryValue">END_OF_LINE</s:String>
14+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/EMPTY_BLOCK_STYLE/@EntryValue">TOGETHER_SAME_LINE</s:String>
15+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/KEEP_EXISTING_EXPR_MEMBER_ARRANGEMENT/@EntryValue">False</s:Boolean>
16+
<s:Int64 x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/MAX_INITIALIZER_ELEMENTS_ON_LINE/@EntryValue">0</s:Int64>
17+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/OTHER_BRACES/@EntryValue">END_OF_LINE</s:String>
18+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_ACCESSOR_ATTRIBUTE_ON_SAME_LINE_EX/@EntryValue">NEVER</s:String>
19+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_ACCESSORHOLDER_ATTRIBUTE_ON_SAME_LINE_EX/@EntryValue">NEVER</s:String>
20+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_CATCH_ON_NEW_LINE/@EntryValue">False</s:Boolean>
21+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_ELSE_ON_NEW_LINE/@EntryValue">False</s:Boolean>
22+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_FIELD_ATTRIBUTE_ON_SAME_LINE_EX/@EntryValue">NEVER</s:String>
23+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_FINALLY_ON_NEW_LINE/@EntryValue">False</s:Boolean>
24+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/PLACE_SIMPLE_INITIALIZER_ON_SINGLE_LINE/@EntryValue">False</s:Boolean>
25+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_AFTER_DOT_IN_METHOD_CALLS/@EntryValue">True</s:Boolean>
26+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_BEFORE_BINARY_PATTERN_OP/@EntryValue">False</s:Boolean>
27+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_BEFORE_DECLARATION_RPAR/@EntryValue">True</s:Boolean>
28+
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_BEFORE_TERNARY_OPSIGNS/@EntryValue">False</s:Boolean>
29+
<s:Int64 x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_LIMIT/@EntryValue">100</s:Int64>
30+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_LINQ_EXPRESSIONS/@EntryValue">CHOP_ALWAYS</s:String>
31+
<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpFormat/WRAP_VERBATIM_INTERPOLATED_STRINGS/@EntryValue">WRAP_IF_LONG</s:String>
32+
<s:Int64 x:Key="/Default/CodeStyle/CodeFormatting/XmlDocFormatter/WRAP_LIMIT/@EntryValue">100</s:Int64>
33+
<s:Boolean x:Key="/Default/CodeStyle/CSharpUsing/AddImportsToDeepestScope/@EntryValue">True</s:Boolean>
34+
<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForBuiltInTypes/@EntryValue">UseVarWhenEvident</s:String>
35+
<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForOtherTypes/@EntryValue">UseVarWhenEvident</s:String>
36+
<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForSimpleTypes/@EntryValue">UseVarWhenEvident</s:String>
37+
<s:Boolean x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/PreferExplicitDiscardDeclaration/@EntryValue">True</s:Boolean>
38+
<s:Boolean x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/PreferSeparateDeconstructedVariablesDeclaration/@EntryValue">True</s:Boolean>
39+
<s:Boolean x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/UseRoslynLogicForEvidentTypes/@EntryValue">True</s:Boolean>
40+
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=EnumMember/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb"&gt;&lt;ExtraRule Prefix="" Suffix="" Style="AaBb" /&gt;&lt;/Policy&gt;</s:String>
41+
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=Interfaces/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="I" Suffix="" Style="AaBb" /&gt;</s:String>
42+
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=LocalConstants/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AA_BB" /&gt;</s:String>
43+
<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateStaticReadonly/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /&gt;</s:String></wpf:ResourceDictionary>

0 commit comments

Comments
 (0)