-
Notifications
You must be signed in to change notification settings - Fork 173
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #540 from jmarolf/feature/move-wiki-to-docs
Move Wiki to the Docs Folder
- Loading branch information
Showing
3 changed files
with
169 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Welcome to the format wiki! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| The dotnet-format global tool supports the following core set of EditorConfig properties: | ||
|
|
||
| - indent_style | ||
| - indent_size | ||
| - tab_width | ||
| - end_of_line | ||
| - insert_final_newline | ||
| - trim_trailing_whitespace | ||
| - root | ||
|
|
||
| In addition dotnet-format supports a subset of the [.NET coding convention settings for EditorConfig](https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2017). | ||
|
|
||
| # Formatting conventions | ||
| Most of the rules for formatting conventions have the following format: | ||
|
|
||
| `rule_name = false|true` | ||
|
|
||
| You specify either `true` (prefer this style) or `false` (do not prefer this style). You do not specify a severity. For a few rules, instead of `true` or `false`, you specify other values to describe when and where to apply the rule. | ||
|
|
||
| ## C# formatting settings | ||
| The formatting rules in this section apply only to C# code. | ||
|
|
||
| **Newline options** | ||
| These formatting rules concern the use of new lines to format code. | ||
|
|
||
| - csharp_new_line_before_open_brace (default value: `all`) | ||
| - csharp_new_line_before_else (default value: `true`) | ||
| - csharp_new_line_before_catch (default value: `true`) | ||
| - csharp_new_line_before_finally (default value: `true`) | ||
| - csharp_new_line_before_members_in_object_initializers (default value: `true`) | ||
| - csharp_new_line_before_members_in_anonymous_types (default value: `true`) | ||
| - csharp_new_line_between_query_expression_clauses (default value: `true`) | ||
|
|
||
| **Indentation options** | ||
| These formatting rules concern the use of indentation to format code. | ||
|
|
||
| - csharp_indent_case_contents (default value: `true`) | ||
| - csharp_indent_switch_labels (default value: `true`) | ||
| - csharp_indent_labels (default value: `no_change`) | ||
|
|
||
| **Spacing options** | ||
| These formatting rules concern the use of space characters to format code. | ||
|
|
||
| - csharp_space_after_cast (default value: `false`) | ||
| - csharp_space_after_keywords_in_control_flow_statements (default value: `true`) | ||
| - csharp_space_between_method_declaration_parameter_list_parentheses (default value: `false`) | ||
| - csharp_space_between_method_call_parameter_list_parentheses (default value: `false`) | ||
| - csharp_space_between_parentheses (default value: `false`) | ||
| - csharp_space_before_colon_in_inheritance_clause (default value: `true`) | ||
| - csharp_space_after_colon_in_inheritance_clause (default value: `true`) | ||
| - csharp_space_around_binary_operators (default value: `before_and_after`) | ||
| - csharp_space_between_method_declaration_empty_parameter_list_parentheses (default value: `false`) | ||
| - csharp_space_between_method_call_name_and_opening_parenthesis (default value: `false`) | ||
| - csharp_space_between_method_call_empty_parameter_list_parentheses (default value: `false`) | ||
|
|
||
| **Wrapping options** | ||
| These formatting rules concern the use of single lines versus separate lines for statements and code blocks. | ||
|
|
||
| - csharp_preserve_single_line_statements (default value: `true`) | ||
| - csharp_preserve_single_line_blocks (default value: `true`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| There are 3 sections of editorconfig configuration options: Formatting, Code Style, and Naming. For the most part the Formatting options are covered by the Roslyn Formatter, which leaves the Code Style and Naming options to be implemented. Below is a list of Code Style options. Naming options will be handled separately. | ||
|
|
||
| # .NET code style settings | ||
|
|
||
| ## "This." and "Me." qualifiers | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| dotnet_style_qualification_for_field | AbstractQualifyMemberAccessDiagnosticAnalyzer | CodeStyleOptions.QualifyFieldAccess | AddQualificationDiagnosticId = "IDE0009" | ||
| dotnet_style_qualification_for_property | AbstractQualifyMemberAccessDiagnosticAnalyzer | CodeStyleOptions.QualifyPropertyAccess | AddQualificationDiagnosticId = "IDE0009" | ||
| dotnet_style_qualification_for_method | AbstractQualifyMemberAccessDiagnosticAnalyzer | CodeStyleOptions.QualifyMethodAccess | AddQualificationDiagnosticId = "IDE0009" | ||
| dotnet_style_qualification_for_event | AbstractQualifyMemberAccessDiagnosticAnalyzer | CodeStyleOptions.QualifyEventAccess | AddQualificationDiagnosticId = "IDE0009" | ||
|
|
||
| ## Language keywords instead of framework type names for type references | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| dotnet_style_predefined_type_for_locals_parameters_members | PreferFrameworkTypeDiagnosticAnalyzerBase | CodeStyleOptions.PreferIntrinsicPredefinedTypeKeywordInDeclaration | PreferBuiltInOrFrameworkTypeDiagnosticId = "IDE0049" | ||
| dotnet_style_predefined_type_for_member_access | PreferFrameworkTypeDiagnosticAnalyzerBase | CodeStyleOptions.PreferIntrinsicPredefinedTypeKeywordInMemberAccess | PreferBuiltInOrFrameworkTypeDiagnosticId = "IDE0049" | ||
|
|
||
| ## Modifier preferences | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| dotnet_style_require_accessibility_modifiers | AbstractAddAccessibilityModifiersDiagnosticAnalyzer | CodeStyleOptions.RequireAccessibilityModifiers | AddAccessibilityModifiersDiagnosticId = "IDE0040" | ||
| csharp_preferred_modifier_order | AbstractOrderModifiersDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferredModifierOrder | OrderModifiersDiagnosticId = "IDE0036" | ||
| visual_basic_preferred_modifier_order | AbstractOrderModifiersDiagnosticAnalyzer | VisualBasicCodeStyleOptions.PreferredModifierOrder | OrderModifiersDiagnosticId = "IDE0036" | ||
| dotnet_style_readonly_field | MakeFieldReadonlyDiagnosticAnalyzer | CodeStyleOption.PreferReadonly | MakeFieldReadonlyDiagnosticId = "IDE0044" | ||
|
|
||
| ## Parentheses preferences | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| dotnet_style_parentheses_in_arithmetic_binary_operators | AbstractAddRequiredParenthesesDiagnosticAnalyzer<br>AbstractRemoveUnnecessaryParenthesesDiagnosticAnalyzer | CodeStyleOption.ArithmeticBinaryParentheses | AddRequiredParenthesesDiagnosticId = "IDE0048"<br>RemoveUnnecessaryParenthesesDiagnosticId = "IDE0047" | ||
| dotnet_style_parentheses_in_other_binary_operators | AbstractAddRequiredParenthesesDiagnosticAnalyzer<br>AbstractRemoveUnnecessaryParenthesesDiagnosticAnalyzer | CodeStyleOptions.OtherBinaryParentheses | AddRequiredParenthesesDiagnosticId = "IDE0048"<br>RemoveUnnecessaryParenthesesDiagnosticId = "IDE0047" | ||
| dotnet_style_parentheses_in_other_operators | AbstractAddRequiredParenthesesDiagnosticAnalyzer<br>AbstractRemoveUnnecessaryParenthesesDiagnosticAnalyzer | CodeStyleOptions.OtherParentheses | AddRequiredParenthesesDiagnosticId = "IDE0048"<br>RemoveUnnecessaryParenthesesDiagnosticId = "IDE0047" | ||
| dotnet_style_parentheses_in_relational_binary_operators | AbstractAddRequiredParenthesesDiagnosticAnalyzer<br>AbstractRemoveUnnecessaryParenthesesDiagnosticAnalyzer | CodeStyleOptions.RelationalBinaryParentheses | AddRequiredParenthesesDiagnosticId = "IDE0048"<br>RemoveUnnecessaryParenthesesDiagnosticId = "IDE0047" | ||
|
|
||
| ## Expression-level preferences | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| dotnet_style_object_initializer | AbstractUseObjectInitializerDiagnosticAnalyzer | CodeStyleOptions.PreferObjectInitializer | UseObjectInitializerDiagnosticId = "IDE0017" | ||
| dotnet_style_collection_initializer | AbstractUseCollectionInitializerDiagnosticAnalyzer | CodeStyleOptions.PreferCollectionInitializer | UseCollectionInitializerDiagnosticId = "IDE0028" | ||
| dotnet_style_explicit_tuple_names | UseExplicitTupleNameDiagnosticAnalyzer | CodeStyleOptions.PreferExplicitTupleNames | UseExplicitTupleNameDiagnosticId = "IDE0033" | ||
| dotnet_style_prefer_inferred_tuple_names | AbstractUseInferredMemberNameDiagnosticAnalyzer | CodeStyleOptions.PreferInferredTupleNames | UseInferredMemberNameDiagnosticId = "IDE0037" | ||
| dotnet_style_prefer_inferred_anonymous_type_member_names | AbstractUseInferredMemberNameDiagnosticAnalyzer | CodeStyleOptions.PreferInferredAnonymousTypeMemberNames | UseInferredMemberNameDiagnosticId = "IDE0037" | ||
| dotnet_style_prefer_auto_properties | AbstractUseAutoPropertyAnalyzer | CodeStyleOptions.PreferAutoProperties | UseAutoPropertyDiagnosticId = "IDE0032" | ||
| dotnet_style_prefer_is_null_check_over_reference_equality_method | AbstractUseIsNullCheckForReferenceEqualsDiagnosticAnalyzer | CodeStyleOptions.PreferIsNullCheckOverReferenceEqualityMethod | UseIsNullCheckDiagnosticId = "IDE0041" | ||
| dotnet_style_prefer_conditional_expression_over_assignment | AbstractUseConditionalExpressionForAssignmentDiagnosticAnalyzer | CodeStyleOptions.PreferConditionalExpressionOverAssignment | UseConditionalExpressionForAssignmentDiagnosticId = "IDE0045" | ||
| dotnet_style_prefer_conditional_expression_over_return | AbstractUseConditionalExpressionForReturnDiagnosticAnalyzer | CodeStyleOptions.PreferConditionalExpressionOverReturn | UseConditionalExpressionForReturnDiagnosticId = "IDE0046" | ||
| dotnet_style_prefer_compound_assignment | AbstractUseCompoundAssignmentDiagnosticAnalyzer | CodeStyleOptions.PreferCompoundAssignment | UseCompoundAssignmentDiagnosticId = "IDE0054" | ||
|
|
||
| ## "Null" checking preferences | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| dotnet_style_coalesce_expression | AbstractUseCoalesceExpressionDiagnosticAnalyzer | CodeStyleOptions.PreferCoalesceExpression | UseCoalesceExpressionDiagnosticId = "IDE0029" | ||
| dotnet_style_null_propagation | AbstractUseNullPropagationDiagnosticAnalyzer | CodeStyleOptions.PreferNullPropagation | UseNullPropagationDiagnosticId = "IDE0031" | ||
|
|
||
| # C# code style settings | ||
|
|
||
| ## Implicit and explicit types | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| csharp_style_var_for_built_in_types | CSharpUseExplicitTypeDiagnosticAnalyzer<br>CSharpUseImplicitTypeDiagnosticAnalyzer | CSharpCodeStyleOptions.VarForBuiltInTypes | UseExplicitTypeDiagnosticId = "IDE0008"<br>UseImplicitTypeDiagnosticId = "IDE0007" | ||
| csharp_style_var_when_type_is_apparent | CSharpUseExplicitTypeDiagnosticAnalyzer<br>CSharpUseImplicitTypeDiagnosticAnalyzer | CSharpCodeStyleOptions.VarWhenTypeIsApparent | UseExplicitTypeDiagnosticId = "IDE0008"<br>UseImplicitTypeDiagnosticId = "IDE0007" | ||
| csharp_style_var_elsewhere | CSharpUseExplicitTypeDiagnosticAnalyzer<br>CSharpUseImplicitTypeDiagnosticAnalyzer | CSharpCodeStyleOptions.VarElsewhere | UseExplicitTypeDiagnosticId = "IDE0008"<br>UseImplicitTypeDiagnosticId = "IDE0007" | ||
|
|
||
| ## Expression-bodied members | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| csharp_style_expression_bodied_methods | UseExpressionBodyForMethodsHelper | CSharpCodeStyleOptions.PreferExpressionBodiedMethods | UseExpressionBodyForMethodsDiagnosticId = "IDE0022" | ||
| csharp_style_expression_bodied_constructors | UseExpressionBodyForConstructorsHelper | CSharpCodeStyleOptions.PreferExpressionBodiedConstructors | UseExpressionBodyForConstructorsDiagnosticId = "IDE0021" | ||
| csharp_style_expression_bodied_operators | UseExpressionBodyForOperatorsHelper | CSharpCodeStyleOptions.PreferExpressionBodiedOperators | UseExpressionBodyForOperatorsDiagnosticId = "IDE0024" | ||
| csharp_style_expression_bodied_properties | UseExpressionBodyForPropertiesHelper | CSharpCodeStyleOptions.PreferExpressionBodiedProperties | UseExpressionBodyForPropertiesDiagnosticId = "IDE0025" | ||
| csharp_style_expression_bodied_indexers | UseExpressionBodyForIndexersHelper | CSharpCodeStyleOptions.PreferExpressionBodiedIndexers | UseExpressionBodyForIndexersDiagnosticId = "IDE0026" | ||
| csharp_style_expression_bodied_accessors | UseExpressionBodyForAccessorsHelper | CSharpCodeStyleOptions.PreferExpressionBodiedAccessors | UseExpressionBodyForAccessorsDiagnosticId = "IDE0027" | ||
| csharp_style_expression_bodied_lambdas | UseExpressionBodyForLambdaDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferExpressionBodiedLambdas | UseExpressionBodyForLambdaExpressionsDiagnosticId = "IDE0053" | ||
| csharp_style_expression_bodied_local_functions | UseExpressionBodyForLocalFunctionHelper | CSharpCodeStyleOptions.PreferExpressionBodiedLocalFunctions | UseExpressionBodyForLocalFunctionsDiagnosticId = "IDE0061" | ||
|
|
||
| ## Pattern matching | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| csharp_style_pattern_matching_over_is_with_cast_check | CSharpIsAndCastCheckDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferPatternMatchingOverIsWithCastCheck | InlineIsTypeCheckId = "IDE0020" | ||
| csharp_style_pattern_matching_over_as_with_null_check | CSharpAsAndNullCheckDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferPatternMatchingOverAsWithNullCheck | InlineAsTypeCheckId = "IDE0019" | ||
| csharp_style_prefer_switch_expression | ConvertSwitchStatementToExpressionDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferSwitchExpression | ConvertSwitchStatementToExpressionDiagnosticId = "IDE0066" | ||
|
|
||
| ## Inlined variable declarations | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| csharp_style_inlined_variable_declaration | CSharpInlineDeclarationDiagnosticAnalyzer | CodeStyleOptions.PreferInlinedVariableDeclaration | InlineDeclarationDiagnosticId = "IDE0018" | ||
|
|
||
| ## Expression-level preferences | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| csharp_prefer_simple_default_expression | CSharpUseDefaultLiteralDiagnosticAnalyzer | CSharpCodeStyleOptions.UseDefaultLiteralDiagnosticId | UseDefaultLiteralDiagnosticId = "IDE0034" | ||
| csharp_style_deconstructed_variable_declaration | CSharpUseDeconstructionDiagnosticAnalyzer | CodeStyleOptions.PreferDeconstructedVariableDeclaration | UseDeconstructionDiagnosticId = "IDE0042" | ||
| csharp_style_pattern_local_over_anonymous_function | CSharpUseLocalFunctionDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferLocalOverAnonymousFunction | UseLocalFunctionDiagnosticId = "IDE0039" | ||
| csharp_style_prefer_index_operator | CSharpUseIndexOperatorDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferIndexOperator | UseIndexOperatorDiagnosticId = "IDE0056" | ||
| csharp_style_prefer_range_operator | CSharpUseRangeOperatorDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferRangeOperator | UseRangeOperatorDiagnosticId = "IDE0057" | ||
| csharp_prefer_static_local_function | MakeLocalFunctionStaticDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferStaticLocalFunction | MakeLocalFunctionStaticDiagnosticId = "IDE0062" | ||
| csharp_prefer_simple_using_statement | UseSimpleUsingStatementDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferSimpleUsingStatement | UseSimpleUsingStatementDiagnosticId = "IDE0063" | ||
|
|
||
| ## "Null" checking preferences | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| csharp_style_throw_expression | AbstractUseThrowExpressionDiagnosticAnalyzer | CodeStyleOptions.PreferThrowExpression | UseThrowExpressionDiagnosticId = "IDE0016" | ||
| csharp_style_conditional_delegate_call | InvokeDelegateWithConditionalAccessAnalyzer | CSharpCodeStyleOptions.PreferConditionalDelegateCall | InvokeDelegateWithConditionalAccessId = "IDE1005" | ||
|
|
||
| ## Code block preferences | ||
| Name | Base Class | Option | Diagnostic | ||
| -|-|-|- | ||
| csharp_prefer_braces | CSharpAddBracesDiagnosticAnalyzer | CSharpCodeStyleOptions.PreferBraces | AddBracesDiagnosticId = "IDE0011" |