-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy path.editorconfig
More file actions
162 lines (141 loc) · 7.48 KB
/
Copy path.editorconfig
File metadata and controls
162 lines (141 loc) · 7.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
[*.{md,markdown}]
trim_trailing_whitespace = false
[*.{yml,yaml,json}]
indent_size = 2
[*.{csproj,props,targets,slnx,xml}]
indent_size = 2
[*.cs]
# Terminal.Gui house style — see /specs/00-plan.md §4
csharp_indent_case_contents = true
csharp_indent_labels = flush_left
csharp_indent_switch_labels = true
csharp_preserve_single_line_blocks = true
# Allman braces
csharp_new_line_before_open_brace = all
csharp_new_line_before_catch = true
csharp_new_line_before_else = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = false
# Space before (), [] — `Method ()`, `array [i]`
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_between_method_call_name_and_opening_parenthesis = true
csharp_space_between_method_declaration_name_and_open_parenthesis = true
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_after_cast = false
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_semicolon_in_for_statement = true
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false
# NOTE on severities below.
#
# Directory.Build.props sets BOTH <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
# AND <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>. Together those turn every
# style rule with severity `:warning` (or higher) into a build error. So we deliberately
# keep stylistic preferences at `:suggestion` here — they show as IDE squiggles for
# discoverability, but don't block the build. Enforcement happens in two other places:
#
# 1. `dotnet format Terminal.Gui.Editor.slnx --verify-no-changes` in CI, and
# 2. `dotnet jb cleanupcode Terminal.Gui.Editor.slnx --profile="TG.Editor Full Cleanup"` in CI
# (and the Stop hook in .claude/settings.json before each agent turn ends).
#
# Both tools auto-fix what they can and surface a clean diff. The `:warning` posture
# is reserved for things that should genuinely fail the build immediately — currently
# nothing stylistic does. If you want a rule to be ship-blocking, raise it explicitly
# below the `# Build-blocking rules` line.
# `var` policy: built-ins only (see CLAUDE.md "Coding standards")
csharp_style_var_for_built_in_types = true:suggestion
csharp_style_var_when_type_is_apparent = false:suggestion
csharp_style_var_elsewhere = false:suggestion
# Expression-bodied members
# Properties / accessors / lambdas: prefer expression bodies when they fit.
# Methods / constructors / operators / local-functions: block bodies (see CLAUDE.md).
csharp_style_expression_bodied_methods = false:suggestion
csharp_style_expression_bodied_constructors = false:suggestion
csharp_style_expression_bodied_operators = false:suggestion
csharp_style_expression_bodied_local_functions = false:suggestion
csharp_style_expression_bodied_properties = when_on_single_line:suggestion
csharp_style_expression_bodied_indexers = when_on_single_line:suggestion
csharp_style_expression_bodied_accessors = when_on_single_line:suggestion
csharp_style_expression_bodied_lambdas = true:suggestion
# C# 12+ collection expressions and target-typed `new`.
# `[1, 2, 3]` not `new int[] { 1, 2, 3 }`; `new ()` not `new Foo ()` when type is inferable.
dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
# Pattern matching, modern null handling.
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_pattern_matching = true:suggestion
csharp_style_prefer_not_pattern = true:suggestion
csharp_style_prefer_switch_expression = true:suggestion
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
dotnet_style_prefer_conditional_expression_over_return = true:suggestion
# Range / index, modern string handling.
csharp_style_prefer_range_operator = true:suggestion
csharp_style_prefer_index_operator = true:suggestion
csharp_prefer_simple_using_statement = true:suggestion
csharp_using_directive_placement = outside_namespace:suggestion
# Auto-property convention: ReSharper's "convert field to auto-property" is unreliable
# around the C# 13 `field` keyword (see CLAUDE.md "Properties"), so we DO NOT enforce it.
# Hand-write `field`-backed properties when the setter has logic; cleanup leaves them alone.
dotnet_style_prefer_auto_properties = false:none
# Misc
csharp_prefer_braces = true:suggestion
csharp_prefer_static_local_function = true:suggestion
dotnet_style_readonly_field = true:suggestion
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
dotnet_style_qualification_for_field = false:suggestion
dotnet_style_qualification_for_property = false:suggestion
dotnet_style_qualification_for_method = false:suggestion
dotnet_style_qualification_for_event = false:suggestion
csharp_preferred_modifier_order = public, private, protected, internal, file, new, static, abstract, virtual, sealed, readonly, override, extern, unsafe, volatile, async, required:suggestion
# Build-blocking rules (intentionally none right now — see note at top).
# IDE0005 (unused usings) is NOT promoted because Roslyn requires
# <GenerateDocumentationFile>true</GenerateDocumentationFile> for that rule to run during
# build (https://github.com/dotnet/roslyn/issues/41640), and that flag emits a flood of
# CS1591 warnings on every undocumented public member. `dotnet format` and `jb cleanupcode`
# in the CI verify step catch unused usings without needing the doc file.
# ReSharper-specific space rules — `dotnet format` reads the csharp_space_* keys above, but
# ReSharper has additional knobs that don't have csharp_* equivalents. These keep ReSharper's
# code-cleanup output aligned with our house style (notably: `new ()` with the space before
# the parens, not `new()`).
resharper_space_before_new_parentheses = true
resharper_space_before_method_call_parentheses = true
resharper_space_before_method_parentheses = true
resharper_space_before_empty_method_call_parentheses = true
resharper_space_before_empty_method_parentheses = true
resharper_space_before_typeof_parentheses = true
resharper_space_before_default_parentheses = true
resharper_space_before_checked_parentheses = true
resharper_space_before_sizeof_parentheses = true
resharper_space_before_nameof_parentheses = true
# AvaloniaEdit-lifted source keeps upstream formatting for manual re-syncs.
[src/Terminal.Gui.Editor/Document/**/*.cs]
generated_code = true
[src/Terminal.Gui.Editor/Folding/**/*.cs]
generated_code = true
[src/Terminal.Gui.Editor/Search/**/*.cs]
generated_code = true
[src/Terminal.Gui.Editor/Utils/**/*.cs]
generated_code = true