Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
322 changes: 322 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,327 @@
root = true

###############################
# Core EditorConfig Options #
###############################

[*]
indent_style = space
indent_size = 4
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{xml,csproj,props,targets,slnx,json,yml,yaml}]
indent_size = 2

[*.md]
trim_trailing_whitespace = false

###############################
# .NET / C# Code Style #
###############################

[*.cs]

#### Organize usings ####
dotnet_sort_system_directives_first = true
dotnet_separate_import_directive_groups = false

#### this. and Me. preferences ####
dotnet_style_qualification_for_field = false:warning
dotnet_style_qualification_for_property = false:warning
dotnet_style_qualification_for_method = false:warning
dotnet_style_qualification_for_event = false:warning

#### Language keywords vs BCL types preferences ####
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:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_relational_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:warning

#### Expression-level preferences ####
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:warning
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
dotnet_style_prefer_conditional_expression_over_return = true:suggestion
dotnet_style_prefer_compound_assignment = true:suggestion
dotnet_style_prefer_simplified_interpolation = true:suggestion
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion

#### Null-checking preferences ####
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning

#### File header ####
file_header_template = Copyright (c) GraphZen LLC. All rights reserved.\nLicensed under the GraphZen Community License. See the LICENSE file in the project root for license information.

###############################
# C# Code Style Rules #
###############################

#### var preferences ####
csharp_style_var_for_built_in_types = true:suggestion
csharp_style_var_when_type_is_apparent = true:suggestion
csharp_style_var_elsewhere = true:suggestion

#### Expression-bodied members ####
csharp_style_expression_bodied_methods = true:suggestion
csharp_style_expression_bodied_constructors = true:suggestion
csharp_style_expression_bodied_operators = true:suggestion
csharp_style_expression_bodied_properties = true:suggestion
csharp_style_expression_bodied_indexers = true:suggestion
csharp_style_expression_bodied_accessors = true:suggestion
csharp_style_expression_bodied_lambdas = true:silent
csharp_style_expression_bodied_local_functions = true:suggestion

#### 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
csharp_style_prefer_switch_expression = true:suggestion
csharp_style_prefer_pattern_matching = true:suggestion
csharp_style_prefer_not_pattern = 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,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async:warning

#### Code-block preferences ####
csharp_prefer_braces = true:warning
csharp_prefer_simple_using_statement = true:suggestion
csharp_style_namespace_declarations = file_scoped:warning

#### Expression-level preferences ####
csharp_prefer_simple_default_expression = true:suggestion
csharp_style_prefer_local_over_anonymous_function = true:suggestion
csharp_style_prefer_index_operator = true:suggestion
csharp_style_prefer_range_operator = true:suggestion
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
csharp_style_prefer_tuple_swap = true:suggestion
csharp_style_prefer_utf8_string_literals = true:suggestion
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
csharp_style_unused_value_expression_statement_preference = discard_variable:silent
csharp_using_directive_placement = outside_namespace:warning

###############################
# 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 = one_less_than_current
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents_when_block = true

#### Space preferences ####
csharp_space_after_cast = false
csharp_space_after_keywords_in_control_flow_statements = true
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_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_call_parameter_list_parentheses = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_after_comma = true
csharp_space_before_comma = false
csharp_space_after_dot = false
csharp_space_before_dot = false
csharp_space_after_semicolon_in_for_statement = true
csharp_space_before_semicolon_in_for_statement = false
csharp_space_around_declaration_statements = false
csharp_space_before_open_square_brackets = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_square_brackets = false

#### Wrapping preferences ####
csharp_preserve_single_line_statements = false
csharp_preserve_single_line_blocks = true

###############################
# Naming Conventions #
###############################

#### Naming styles ####
dotnet_naming_style.pascal_case_style.capitalization = pascal_case

dotnet_naming_style.camel_case_style.capitalization = camel_case

dotnet_naming_style.underscore_camel_case_style.capitalization = camel_case
dotnet_naming_style.underscore_camel_case_style.required_prefix = _

dotnet_naming_style.interface_style.capitalization = pascal_case
dotnet_naming_style.interface_style.required_prefix = I

dotnet_naming_style.type_parameter_style.capitalization = pascal_case
dotnet_naming_style.type_parameter_style.required_prefix = T

#### Naming symbols ####
dotnet_naming_symbols.interface_symbols.applicable_kinds = interface
dotnet_naming_symbols.interface_symbols.applicable_accessibilities = *

dotnet_naming_symbols.type_parameter_symbols.applicable_kinds = type_parameter
dotnet_naming_symbols.type_parameter_symbols.applicable_accessibilities = *

dotnet_naming_symbols.type_symbols.applicable_kinds = class, struct, enum, delegate
dotnet_naming_symbols.type_symbols.applicable_accessibilities = *

dotnet_naming_symbols.method_symbols.applicable_kinds = method
dotnet_naming_symbols.method_symbols.applicable_accessibilities = *

dotnet_naming_symbols.property_symbols.applicable_kinds = property, event
dotnet_naming_symbols.property_symbols.applicable_accessibilities = *

dotnet_naming_symbols.public_field_symbols.applicable_kinds = field
dotnet_naming_symbols.public_field_symbols.applicable_accessibilities = public, internal, protected, protected_internal

dotnet_naming_symbols.private_field_symbols.applicable_kinds = field
dotnet_naming_symbols.private_field_symbols.applicable_accessibilities = private, private_protected

dotnet_naming_symbols.private_static_readonly_field_symbols.applicable_kinds = field
dotnet_naming_symbols.private_static_readonly_field_symbols.applicable_accessibilities = private, private_protected
dotnet_naming_symbols.private_static_readonly_field_symbols.required_modifiers = static, readonly

dotnet_naming_symbols.private_static_field_symbols.applicable_kinds = field
dotnet_naming_symbols.private_static_field_symbols.applicable_accessibilities = private, private_protected
dotnet_naming_symbols.private_static_field_symbols.required_modifiers = static

dotnet_naming_symbols.local_symbols.applicable_kinds = local, parameter
dotnet_naming_symbols.local_symbols.applicable_accessibilities = *

dotnet_naming_symbols.local_function_symbols.applicable_kinds = local_function
dotnet_naming_symbols.local_function_symbols.applicable_accessibilities = *

dotnet_naming_symbols.const_field_symbols.applicable_kinds = field
dotnet_naming_symbols.const_field_symbols.applicable_accessibilities = *
dotnet_naming_symbols.const_field_symbols.required_modifiers = const

dotnet_naming_symbols.namespace_symbols.applicable_kinds = namespace
dotnet_naming_symbols.namespace_symbols.applicable_accessibilities = *

#### Naming rules ####
dotnet_naming_rule.interfaces_must_be_prefixed.severity = warning
dotnet_naming_rule.interfaces_must_be_prefixed.symbols = interface_symbols
dotnet_naming_rule.interfaces_must_be_prefixed.style = interface_style

dotnet_naming_rule.type_parameters_must_be_prefixed.severity = warning
dotnet_naming_rule.type_parameters_must_be_prefixed.symbols = type_parameter_symbols
dotnet_naming_rule.type_parameters_must_be_prefixed.style = type_parameter_style

dotnet_naming_rule.types_must_be_pascal_case.severity = warning
dotnet_naming_rule.types_must_be_pascal_case.symbols = type_symbols
dotnet_naming_rule.types_must_be_pascal_case.style = pascal_case_style

dotnet_naming_rule.methods_must_be_pascal_case.severity = warning
dotnet_naming_rule.methods_must_be_pascal_case.symbols = method_symbols
dotnet_naming_rule.methods_must_be_pascal_case.style = pascal_case_style

dotnet_naming_rule.properties_must_be_pascal_case.severity = warning
dotnet_naming_rule.properties_must_be_pascal_case.symbols = property_symbols
dotnet_naming_rule.properties_must_be_pascal_case.style = pascal_case_style

dotnet_naming_rule.const_fields_must_be_pascal_case.severity = warning
dotnet_naming_rule.const_fields_must_be_pascal_case.symbols = const_field_symbols
dotnet_naming_rule.const_fields_must_be_pascal_case.style = pascal_case_style

dotnet_naming_rule.public_fields_must_be_pascal_case.severity = warning
dotnet_naming_rule.public_fields_must_be_pascal_case.symbols = public_field_symbols
dotnet_naming_rule.public_fields_must_be_pascal_case.style = pascal_case_style

dotnet_naming_rule.private_static_readonly_fields_must_be_pascal.severity = warning
dotnet_naming_rule.private_static_readonly_fields_must_be_pascal.symbols = private_static_readonly_field_symbols
dotnet_naming_rule.private_static_readonly_fields_must_be_pascal.style = pascal_case_style

dotnet_naming_rule.private_static_fields_must_be_underscore_camel.severity = warning
dotnet_naming_rule.private_static_fields_must_be_underscore_camel.symbols = private_static_field_symbols
dotnet_naming_rule.private_static_fields_must_be_underscore_camel.style = underscore_camel_case_style

dotnet_naming_rule.private_fields_must_be_underscore_camel.severity = warning
dotnet_naming_rule.private_fields_must_be_underscore_camel.symbols = private_field_symbols
dotnet_naming_rule.private_fields_must_be_underscore_camel.style = underscore_camel_case_style

dotnet_naming_rule.locals_must_be_camel_case.severity = warning
dotnet_naming_rule.locals_must_be_camel_case.symbols = local_symbols
dotnet_naming_rule.locals_must_be_camel_case.style = camel_case_style

dotnet_naming_rule.local_functions_must_be_pascal_case.severity = warning
dotnet_naming_rule.local_functions_must_be_pascal_case.symbols = local_function_symbols
dotnet_naming_rule.local_functions_must_be_pascal_case.style = pascal_case_style

dotnet_naming_rule.namespaces_must_be_pascal_case.severity = warning
dotnet_naming_rule.namespaces_must_be_pascal_case.symbols = namespace_symbols
dotnet_naming_rule.namespaces_must_be_pascal_case.style = pascal_case_style

###############################
# Analyzer Severities #
###############################

# IDE0005: Remove unnecessary using directives
dotnet_diagnostic.IDE0005.severity = warning

# IDE0011: Add braces
dotnet_diagnostic.IDE0011.severity = warning

# IDE0160/IDE0161: Namespace declaration preferences
dotnet_diagnostic.IDE0161.severity = warning

# IDE0065: Using directive placement
dotnet_diagnostic.IDE0065.severity = warning

# IDE0003/IDE0009: this. and Me. preferences
dotnet_diagnostic.IDE0003.severity = warning
dotnet_diagnostic.IDE0009.severity = warning

###############################
# ReSharper Properties #
###############################

# Trailing comma in multiline lists
resharper_trailing_comma_in_multiline_lists = true

# Braces for control flow
resharper_braces_for_for = required
resharper_braces_for_foreach = required
resharper_braces_for_while = required

# Abbreviation overrides (allow AST, QL as valid naming)
resharper_abbreviations = AST QL

###############################
# Test Projects #
###############################

[test/**/*.cs]

# Disable naming rules for test projects (tests commonly use snake_case for methods, classes, and fields)
dotnet_diagnostic.IDE1006.severity = none
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
* text=auto

*.cs text diff=csharp
*.sh text eol=lf
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ jobs:
- name: Build
run: dotnet build --no-restore --configuration Release

- name: Check formatting
run: dotnet format --verify-no-changes --verbosity diagnostic

- name: Test
run: dotnet test --no-build --configuration Release --logger "trx;LogFileName=test-results.trx" --collect:"XPlat Code Coverage" --results-directory ./test-results

Expand Down
3 changes: 3 additions & 0 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<LangVersion>latest</LangVersion>
<ImplicitUsings>enable</ImplicitUsings>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);CS1591;CS1587</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
Loading
Loading