Update sanity check and .editorconfig (open-telemetry#378)

.editorconfig

@@ -1,130 +1,149 @@
 # To learn more about .editorconfig see https://aka.ms/editorconfigdocs
-############################### 
-# Core EditorConfig Options   # 
-############################### 
-# All files 
-[*] 
-indent_style = space 
-# Code files 
-[*.{cs,csx,vb,vbx}] 
-indent_size = 4 
-insert_final_newline = true 
-trim_trailing_whitespace = true 
-charset = utf-8-bom 
-# maintain DOS/Windows style line endings in md files
-[*.md]
-end_of_line = crlf
-############################### 
-# .NET Coding Conventions     # 
-############################### 
-[*.{cs,vb}] 
-# Organize usings 
-dotnet_sort_system_directives_first = true 
-# this. preferences 
-dotnet_style_qualification_for_field = true:suggestion 
-dotnet_style_qualification_for_property = true:suggestion 
-dotnet_style_qualification_for_method = true:suggestion 
-dotnet_style_qualification_for_event = true:suggestion 
-# Language keywords vs BCL types preferences 
-dotnet_style_predefined_type_for_locals_parameters_members = true:silent 
-dotnet_style_predefined_type_for_member_access = true:silent 
-# Parentheses preferences 
-dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent 
-dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent 
-dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent 
-dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent 
-# Modifier preferences 
-dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent 
-dotnet_style_readonly_field = true:suggestion 
-# Expression-level preferences 
-dotnet_style_object_initializer = true:suggestion 
-dotnet_style_collection_initializer = true:suggestion 
-dotnet_style_explicit_tuple_names = true:suggestion 
-dotnet_style_null_propagation = true:suggestion 
-dotnet_style_coalesce_expression = true:suggestion 
-dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent 
-dotnet_prefer_inferred_tuple_names = true:suggestion 
-dotnet_prefer_inferred_anonymous_type_member_names = true:suggestion 
-dotnet_style_prefer_auto_properties = true:silent 
-dotnet_style_prefer_conditional_expression_over_assignment = true:silent 
-dotnet_style_prefer_conditional_expression_over_return = true:silent 
-############################### 
-# Naming Conventions          # 
-############################### 
-# Style Definitions 
-dotnet_naming_style.pascal_case_style.capitalization             = pascal_case 
-# Use PascalCase for constant fields   
-dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion 
-dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields 
-dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style 
-dotnet_naming_symbols.constant_fields.applicable_kinds            = field 
-dotnet_naming_symbols.constant_fields.applicable_accessibilities  = * 
-dotnet_naming_symbols.constant_fields.required_modifiers          = const 
-############################### 
-# C# Coding Conventions       # 
-############################### 
-[*.cs] 
+###############################
+# Core EditorConfig Options   #
+###############################
+# All files
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{cs,cshtml,htm,html,md,py,sln,xml}]
+indent_size = 4
+
+###############################
+# .NET Coding Conventions     #
+###############################
+# Directive order based on dotnet/runtime settings
+# https://github.com/dotnet/runtime/blob/main/.editorconfig
+[*.cs]
+# New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_case_contents = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = flush_left
+
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
+
+# this. preferences
+dotnet_style_qualification_for_field = true:suggestion
+dotnet_style_qualification_for_property = true:suggestion
+dotnet_style_qualification_for_method = true:suggestion
+dotnet_style_qualification_for_event = true:suggestion
+
+# var preferences, language keywords vs BCL types preferences
+csharp_style_var_for_built_in_types = true:silent
+csharp_style_var_when_type_is_apparent = true:silent
+csharp_style_var_elsewhere = true:silent
+dotnet_style_predefined_type_for_locals_parameters_members = true:silent
+dotnet_style_predefined_type_for_member_access = true:silent
+
+# name all constant fields using PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+# Code style defaults
+dotnet_sort_system_directives_first = true
+csharp_prefer_braces = true:silent
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+csharp_prefer_simple_using_statement = true:suggestion
+dotnet_style_readonly_field = true:suggestion
+csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
+dotnet_style_prefer_simplified_interpolation = true:suggestion
+dotnet_style_object_initializer = true:suggestion
+
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+csharp_prefer_simple_default_expression = true:suggestion
+
+# Expression-bodied members
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+
+# Pattern matching
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+
+# Null checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Other features
+csharp_style_prefer_index_operator = false:none
+csharp_style_prefer_range_operator = false:none
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_deconstructed_variable_declaration = true:suggestion
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_before_colon_in_inheritance_clause = true
+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_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
+
+# Code analyzers
+# CA1031: Do not catch general exception types
+dotnet_diagnostic.CA1031.severity = none
+
+# CA1303: Do not pass literals as localized parameters
+dotnet_diagnostic.CA1303.severity = none
+
+# IDE0001: Simplify name
+dotnet_diagnostic.IDE0001.severity = warning
+
+# IDE0002: Simplify member access
+dotnet_diagnostic.IDE0002.severity = warning
+
+# IDE0005: Remove unnecessary import
 dotnet_diagnostic.IDE0005.severity = warning
-# var preferences 
-csharp_style_var_for_built_in_types = true:silent 
-csharp_style_var_when_type_is_apparent = true:silent 
-csharp_style_var_elsewhere = true:silent 
-# Expression-bodied members 
-csharp_style_expression_bodied_methods = false:silent 
-csharp_style_expression_bodied_constructors = false:silent 
-csharp_style_expression_bodied_operators = false:silent 
-csharp_style_expression_bodied_properties = true:silent 
-csharp_style_expression_bodied_indexers = true:silent 
-csharp_style_expression_bodied_accessors = true:silent 
-# Pattern matching preferences 
-csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion 
-csharp_style_pattern_matching_over_as_with_null_check = true:suggestion 
-# Null-checking preferences 
-csharp_style_throw_expression = true:suggestion 
-csharp_style_conditional_delegate_call = true:suggestion 
-# Modifier preferences 
-csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion 
-# Expression-level preferences 
-csharp_prefer_braces = true:silent 
-csharp_style_deconstructed_variable_declaration = true:suggestion 
-csharp_prefer_simple_default_expression = true:suggestion 
-csharp_style_pattern_local_over_anonymous_function = true:suggestion 
-csharp_style_inlined_variable_declaration = true:suggestion 
-############################### 
-# C# Formatting Rules         # 
-############################### 
-# New line preferences 
-csharp_new_line_before_open_brace = all 
-csharp_new_line_before_else = true 
-csharp_new_line_before_catch = true 
-csharp_new_line_before_finally = true 
-csharp_new_line_before_members_in_object_initializers = true 
-csharp_new_line_before_members_in_anonymous_types = true 
-csharp_new_line_between_query_expression_clauses = true 
-# Indentation preferences 
-csharp_indent_case_contents = true 
-csharp_indent_switch_labels = true 
-csharp_indent_labels = flush_left 
-# Space preferences 
-csharp_space_after_cast = false 
-csharp_space_after_keywords_in_control_flow_statements = true 
-csharp_space_between_method_call_parameter_list_parentheses = false 
-csharp_space_between_method_declaration_parameter_list_parentheses = false 
-csharp_space_between_parentheses = false 
-csharp_space_before_colon_in_inheritance_clause = true 
-csharp_space_after_colon_in_inheritance_clause = true 
-csharp_space_around_binary_operators = before_and_after 
-csharp_space_between_method_declaration_empty_parameter_list_parentheses = false 
-csharp_space_between_method_call_name_and_opening_parenthesis = false 
-csharp_space_between_method_call_empty_parameter_list_parentheses = false 
-# Wrapping preferences 
-csharp_preserve_single_line_statements = true 
-csharp_preserve_single_line_blocks = true 
-############################### 
-# VB Coding Conventions       # 
-############################### 
-[*.vb] 
-# Modifier preferences 
-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:suggestion 
+
 [obj/**.cs]
 generated_code = true
+
+[*.csproj]
+indent_size = 2

build/sanitycheck.py

@@ -8,7 +8,7 @@
 CRLF = b'\r\n'
 LF = b'\n'
 
-def sanitycheck(pattern, allow_utf8 = False):
+def sanitycheck(pattern, allow_utf8 = False, allow_eol = (CRLF, LF), indent = 1):
     error_count = 0
 
     for filename in glob.glob(pattern, recursive=True):
@@ -26,6 +26,8 @@ def sanitycheck(pattern, allow_utf8 = False):
             for line in content.splitlines(True):
                 if allow_utf8 and lineno == 1 and line.startswith(b'\xef\xbb\xbf'):
                     line = line[3:]
+                if any(b == 7 for b in line):
+                    error.append('  TAB found at Ln:{} {}'.format(lineno, line))
                 if any(b > 127 for b in line):
                     error.append('  Non-ASCII character found at Ln:{} {}'.format(lineno, line))
                 if line[-2:] == CRLF:
@@ -43,6 +45,18 @@ def sanitycheck(pattern, allow_utf8 = False):
                 elif line[-1:] == CR:
                     error.append('  CR found at Ln:{} {}'.format(lineno, line))
                     line = line[:-1]
+                if eol:
+                    if eol not in allow_eol:
+                        error.append('  Line ending {} not allowed at Ln:{}'.format(eol, lineno))
+                        break
+                if line.startswith(b' '):
+                    spc_count = 0
+                    for c in line:
+                        if c != 32:
+                            break
+                        spc_count += 1
+                    if not indent or spc_count % indent:
+                        error.append('  {} SPC found at Ln:{} {}'.format(spc_count, lineno, line))
                 if line[-1:] == b' ' or line[-1:] == b'\t':
                     error.append('  Trailing space found at Ln:{} {}'.format(lineno, line))
                 lineno += 1
@@ -58,19 +72,23 @@ def sanitycheck(pattern, allow_utf8 = False):
     return error_count
 
 retval = 0
-retval += sanitycheck('**/*.cmd')
-retval += sanitycheck('**/*.config', allow_utf8 = True)
-retval += sanitycheck('**/*.cs', allow_utf8 = True)
-retval += sanitycheck('**/*.cshtml', allow_utf8 = True)
-retval += sanitycheck('**/*.csproj', allow_utf8 = True)
-retval += sanitycheck('**/*.htm')
-retval += sanitycheck('**/*.html')
-retval += sanitycheck('**/*.md')
-retval += sanitycheck('**/*.proj')
-retval += sanitycheck('**/*.props')
-retval += sanitycheck('**/*.py')
-retval += sanitycheck('**/*.ruleset', allow_utf8 = True)
-retval += sanitycheck('**/*.sln', allow_utf8 = True)
-retval += sanitycheck('**/*.xml')
+retval += sanitycheck('.editorconfig', allow_eol = (LF,), indent = 0)
+retval += sanitycheck('**/Dockerfile', allow_eol = (LF,), indent = 2)
+retval += sanitycheck('**/*.cmd', allow_eol = (CRLF,), indent = 2)
+retval += sanitycheck('**/*.config', allow_utf8 = True, allow_eol = (LF,), indent = 2)
+retval += sanitycheck('**/*.cs', allow_utf8 = True, allow_eol = (LF,))
+retval += sanitycheck('**/*.cshtml', allow_utf8 = True, allow_eol = (LF,), indent = 4)
+retval += sanitycheck('**/*.csproj', allow_utf8 = True, allow_eol = (LF,), indent = 2)
+retval += sanitycheck('**/*.htm', allow_eol = (LF,), indent = 4)
+retval += sanitycheck('**/*.html', allow_eol = (LF,), indent = 4)
+retval += sanitycheck('**/*.md', allow_eol = (LF,))
+retval += sanitycheck('**/*.proj', allow_eol = (LF,), indent = 2)
+retval += sanitycheck('**/*.props', allow_eol = (LF,), indent = 2)
+retval += sanitycheck('**/*.py', allow_eol = (LF,), indent = 4)
+retval += sanitycheck('**/*.ruleset', allow_utf8 = True, allow_eol = (LF,), indent = 2)
+retval += sanitycheck('**/*.sln', allow_utf8 = True, allow_eol = (LF,), indent = 4)
+retval += sanitycheck('**/*.targets', allow_eol = (LF,), indent = 2)
+retval += sanitycheck('**/*.xml', allow_eol = (LF,), indent = 4)
+retval += sanitycheck('**/*.yml', allow_eol = (LF,), indent = 2)
 
 sys.exit(retval)

examples/Directory.Build.targets

@@ -1,4 +1,4 @@
 <Project>
   <Import Project="..\Directory.Build.targets" Condition="Exists('..\Directory.Build.targets')" />
   <Import Project="$(RepoRoot)\build\Common.targets" />
-</Project>
+</Project>