Skip to content

EditorConfig

Robert Coltheart edited this page Nov 1, 2021 · 2 revisions

To use the below EditorConfig file, simply place in your Machine Specifications project folder, alongside your .csproj.

Note that the formatting and naming settings will apply to all files, including mock or helper classes that aren't specifications. You can further refine this by excluding certain folders, or by including specifications based on a naming convention.

; This file is for unifying the coding style for different editors and IDEs.
; More information at http://EditorConfig.org

[*.cs]
dotnet_style_require_accessibility_modifiers = never
dotnet_style_readonly_field = false

# Severities
dotnet_diagnostic.IDE0052.severity = none

# Naming styles
dotnet_naming_style.snake_case.capitalization = all_lower
dotnet_naming_style.snake_case.word_separator = _

# Symbol specifications
dotnet_naming_symbols.static_field.applicable_kinds = field
dotnet_naming_symbols.static_field.applicable_accessibilities = *
dotnet_naming_symbols.static_field.required_modifiers = static

dotnet_naming_symbols.specs_delegate.applicable_kinds = field
dotnet_naming_symbols.specs_delegate.applicable_accessibilities = *

dotnet_naming_symbols.specs_class.applicable_kinds = class
dotnet_naming_symbols.specs_class.applicable_accessibilities = private, internal

# Naming rules
dotnet_naming_rule.static_field_should_be_snake_case.severity = error
dotnet_naming_rule.static_field_should_be_snake_case.symbols = static_field
dotnet_naming_rule.static_field_should_be_snake_case.style = snake_case

dotnet_naming_rule.machine_delegate_should_be_snake_case.severity = error
dotnet_naming_rule.machine_delegate_should_be_snake_case.symbols = specs_delegate
dotnet_naming_rule.machine_delegate_should_be_snake_case.style = snake_case

dotnet_naming_rule.specs_class_should_be_snake_case.severity = error
dotnet_naming_rule.specs_class_should_be_snake_case.symbols = specs_class
dotnet_naming_rule.specs_class_should_be_snake_case.style = snake_case
Clone this wiki locally