mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-03 17:56:44 +02:00
e88b4aa1a2
## Summary of the Pull Request
- Reformats .editorconfig file for CmdPal and adds comments to keep it
organized
- Explictly adds some defaults matching the current codebase - just to
override local settings
- This PR should not introduce new style or formatting to the codebase,
only codify the existing one
- Configuration changes
- Adds `csharp_preserve_single_line_statements = false` (matches current
default / StyleCop)
- Adds `dotnet_separate_import_directive_groups = false` (matches
current default / StyleCop)
- Normalize new line chars to Unix style in file_header_template
- Adds `insert_final_newline = true`(matches current default / StyleCop)
- Removes duplicate `csharp_style_var_for_built_in_types` and keeps more
severe variant true:warning
Actual configuration diff:
```diff
+csharp_preserve_single_line_statements = false
+dotnet_separate_import_directive_groups = false
-file_header_template = Copyright (c) Microsoft Corporation\r\nThe Microsoft Corporation licenses this file to you under the MIT license.\r\nSee the LICENSE file in the project root for more information.
+file_header_template = Copyright (c) Microsoft Corporation\nThe Microsoft Corporation licenses this file to you under the MIT license.\nSee the LICENSE file in the project root for more information.
+insert_final_newline = true
-csharp_style_var_for_built_in_types = true:suggestion
-csharp_style_var_for_built_in_types = true:warning
+csharp_style_var_for_built_in_types = true:warning
```
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
- [x] Closes: #41844
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx
<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments
<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
267 lines
12 KiB
INI
267 lines
12 KiB
INI
# Rules in this file were initially inferred by Visual Studio IntelliCode from the Template Studio codebase.
|
|
# You can modify the rules from these initially generated values to suit your own policies.
|
|
# You can learn more about editorconfig here: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference.
|
|
|
|
##################################################
|
|
# Global settings
|
|
##################################################
|
|
|
|
[*.{cs,vb}]
|
|
tab_width = 4
|
|
indent_size = 4
|
|
end_of_line = crlf
|
|
indent_style = space
|
|
insert_final_newline = true
|
|
file_header_template = Copyright (c) Microsoft Corporation\nThe Microsoft Corporation licenses this file to you under the MIT license.\nSee the LICENSE file in the project root for more information.
|
|
|
|
##################################################
|
|
# C# specific formatting
|
|
##################################################
|
|
|
|
[*.cs]
|
|
# ----------------------------------------------
|
|
# Core editorconfig formatting - indentation
|
|
# ----------------------------------------------
|
|
|
|
#place else statements on a new line
|
|
csharp_new_line_before_else = true
|
|
#require braces to be on a new line for lambdas, methods, control_blocks, types, properties, and accessors (also known as "Allman" style)
|
|
csharp_new_line_before_open_brace = all
|
|
|
|
# ----------------------------------------------
|
|
# Formatting - organize using options
|
|
# ----------------------------------------------
|
|
|
|
# sort System.* using directives alphabetically, and place them before other usings
|
|
dotnet_sort_system_directives_first = true
|
|
# Do not place System.* using directives before other using directives.
|
|
dotnet_separate_import_directive_groups = false
|
|
|
|
# ----------------------------------------------
|
|
# Formatting - spacing options
|
|
# ----------------------------------------------
|
|
|
|
#require NO space between a cast and the value
|
|
csharp_space_after_cast = false
|
|
#require a space before the colon for bases or interfaces in a type declaration
|
|
csharp_space_after_colon_in_inheritance_clause = true
|
|
#require a space after a keyword in a control flow statement such as a for loop
|
|
csharp_space_after_keywords_in_control_flow_statements = true
|
|
#require a space before the colon for bases or interfaces in a type declaration
|
|
csharp_space_before_colon_in_inheritance_clause = true
|
|
#remove space within empty argument list parentheses
|
|
csharp_space_between_method_call_empty_parameter_list_parentheses = false
|
|
#remove space between method call name and opening parenthesis
|
|
csharp_space_between_method_call_name_and_opening_parenthesis = false
|
|
#do not place space characters after the opening parenthesis and before the closing parenthesis of a method call
|
|
csharp_space_between_method_call_parameter_list_parentheses = false
|
|
#remove space within empty parameter list parentheses for a method declaration
|
|
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
|
|
#place a space character after the opening parenthesis and before the closing parenthesis of a method declaration parameter list.
|
|
csharp_space_between_method_declaration_parameter_list_parentheses = false
|
|
|
|
# ----------------------------------------------
|
|
# Formatting - wrapping options
|
|
# ----------------------------------------------
|
|
|
|
#leave code block on separate lines
|
|
csharp_preserve_single_line_blocks = true
|
|
#put each statement on a separate line
|
|
csharp_preserve_single_line_statements = false
|
|
|
|
##################################################
|
|
# C# style rules
|
|
##################################################
|
|
|
|
# ----------------------------------------------
|
|
# Style - Code block preferences
|
|
# ----------------------------------------------
|
|
|
|
#prefer curly braces even for one line of code
|
|
csharp_prefer_braces = true:suggestion
|
|
|
|
# ----------------------------------------------
|
|
# Style - expression bodied member options
|
|
# ----------------------------------------------
|
|
|
|
#prefer expression bodies for accessors
|
|
csharp_style_expression_bodied_accessors = true:warning
|
|
#prefer block bodies for constructors
|
|
csharp_style_expression_bodied_constructors = false:suggestion
|
|
#prefer expression bodies for methods
|
|
csharp_style_expression_bodied_methods = when_on_single_line:silent
|
|
#prefer expression-bodied members for properties
|
|
csharp_style_expression_bodied_properties = true:warning
|
|
|
|
# ----------------------------------------------
|
|
# Style - expression level options
|
|
# ----------------------------------------------
|
|
|
|
#prefer out variables to be declared before the method call
|
|
csharp_style_inlined_variable_declaration = false:suggestion
|
|
#prefer the language keyword for member access expressions, instead of the type name, for types that have a keyword to represent them
|
|
dotnet_style_predefined_type_for_member_access = true:suggestion
|
|
|
|
# ----------------------------------------------
|
|
# Style - Expression-level preferences
|
|
# ----------------------------------------------
|
|
|
|
#prefer default over default(T)
|
|
csharp_prefer_simple_default_expression = true:suggestion
|
|
#prefer objects to be initialized using object initializers when possible
|
|
dotnet_style_object_initializer = true:suggestion
|
|
|
|
# ----------------------------------------------
|
|
# Style - implicit and explicit types
|
|
# ----------------------------------------------
|
|
|
|
#prefer var over explicit type in all cases, unless overridden by another code style rule
|
|
csharp_style_var_elsewhere = true:suggestion
|
|
#prefer var is used to declare variables with built-in system types such as int
|
|
csharp_style_var_for_built_in_types = true:warning
|
|
#prefer var when the type is already mentioned on the right-hand side of a declaration expression
|
|
csharp_style_var_when_type_is_apparent = true:suggestion
|
|
|
|
# ----------------------------------------------
|
|
# Style - language keyword and framework type options
|
|
# ----------------------------------------------
|
|
|
|
#prefer the language keyword for local variables, method parameters, and class members, instead of the type name, for types that have a keyword to represent them
|
|
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
|
|
|
|
# ----------------------------------------------
|
|
# Style - Language rules
|
|
# ----------------------------------------------
|
|
|
|
csharp_style_implicit_object_creation_when_type_is_apparent = true:warning
|
|
|
|
# ----------------------------------------------
|
|
# Style - modifier options
|
|
# ----------------------------------------------
|
|
|
|
#prefer accessibility modifiers to be declared except for public interface members. This will currently not differ from always and will act as future proofing for if C# adds default interface methods.
|
|
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
|
|
|
|
# ----------------------------------------------
|
|
# Style - Modifier preferences
|
|
# ----------------------------------------------
|
|
|
|
#when this rule is set to a list of modifiers, prefer the specified ordering.
|
|
csharp_preferred_modifier_order = public,private,protected,internal,static,async,readonly,override,sealed,abstract,virtual:warning
|
|
dotnet_style_readonly_field = true:warning
|
|
|
|
# ----------------------------------------------
|
|
# Style - Pattern matching
|
|
# ----------------------------------------------
|
|
|
|
#prefer pattern matching instead of is expression with type casts
|
|
csharp_style_pattern_matching_over_as_with_null_check = true:warning
|
|
|
|
# ----------------------------------------------
|
|
# Style - qualification options
|
|
# ----------------------------------------------
|
|
|
|
#prefer events not to be prefaced with this. or Me. in Visual Basic
|
|
dotnet_style_qualification_for_event = false:suggestion
|
|
#prefer fields not to be prefaced with this. or Me. in Visual Basic
|
|
dotnet_style_qualification_for_field = false:suggestion
|
|
#prefer methods not to be prefaced with this. or Me. in Visual Basic
|
|
dotnet_style_qualification_for_method = false:suggestion
|
|
#prefer properties not to be prefaced with this. or Me. in Visual Basic
|
|
dotnet_style_qualification_for_property = false:suggestion
|
|
|
|
# ----------------------------------------------
|
|
# Style - expression bodies
|
|
# ----------------------------------------------
|
|
csharp_style_expression_bodied_operators = false:silent
|
|
csharp_style_expression_bodied_indexers = true:silent
|
|
csharp_style_expression_bodied_lambdas = true:silent
|
|
csharp_style_expression_bodied_local_functions = false:silent
|
|
|
|
# ----------------------------------------------
|
|
# Style - Miscellaneous preferences
|
|
# ----------------------------------------------
|
|
|
|
csharp_indent_labels = one_less_than_current
|
|
csharp_using_directive_placement = outside_namespace:silent
|
|
csharp_prefer_simple_using_statement = true:warning
|
|
csharp_style_namespace_declarations = file_scoped:warning
|
|
|
|
[*.{cs,vb}]
|
|
dotnet_style_operator_placement_when_wrapping = beginning_of_line
|
|
dotnet_style_coalesce_expression = true:suggestion
|
|
dotnet_style_null_propagation = true:suggestion
|
|
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
|
|
dotnet_style_prefer_auto_properties = true:silent
|
|
dotnet_style_object_initializer = true:suggestion
|
|
dotnet_style_collection_initializer = true:suggestion
|
|
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
|
|
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
|
|
dotnet_style_prefer_conditional_expression_over_return = true:silent
|
|
csharp_style_unused_value_assignment_preference = discard_variable:warning
|
|
|
|
##################################################
|
|
# Naming rules
|
|
##################################################
|
|
|
|
[*.{cs,vb}]
|
|
|
|
# Naming rules
|
|
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
|
|
|
|
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
|
|
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
|
|
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
|
|
|
|
# Symbol specifications
|
|
|
|
dotnet_naming_symbols.interface.applicable_kinds = interface
|
|
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.interface.required_modifiers =
|
|
|
|
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
|
|
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.types.required_modifiers =
|
|
|
|
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
|
|
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.non_field_members.required_modifiers =
|
|
|
|
# Naming styles
|
|
|
|
dotnet_naming_style.begins_with_i.required_prefix = I
|
|
dotnet_naming_style.begins_with_i.required_suffix =
|
|
dotnet_naming_style.begins_with_i.word_separator =
|
|
dotnet_naming_style.begins_with_i.capitalization = pascal_case
|
|
|
|
dotnet_naming_style.pascal_case.required_prefix =
|
|
dotnet_naming_style.pascal_case.required_suffix =
|
|
dotnet_naming_style.pascal_case.word_separator =
|
|
dotnet_naming_style.pascal_case.capitalization = pascal_case
|
|
|
|
dotnet_naming_style.pascal_case.required_prefix =
|
|
dotnet_naming_style.pascal_case.required_suffix =
|
|
dotnet_naming_style.pascal_case.word_separator =
|
|
dotnet_naming_style.pascal_case.capitalization = pascal_case
|
|
dotnet_style_explicit_tuple_names = true:suggestion
|
|
dotnet_style_prefer_inferred_tuple_names = true:suggestion
|
|
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
|
|
dotnet_style_prefer_compound_assignment = true:warning
|
|
dotnet_style_prefer_simplified_interpolation = true:suggestion
|
|
|
|
|
|
##################################################
|
|
# Diagnostics
|
|
##################################################
|
|
|
|
[*.{cs,vb}]
|
|
# CS8305: Type is for evaluation purposes only and is subject to change or removal in future updates.
|
|
dotnet_diagnostic.CS8305.severity = suggestion
|