Code Cleanup

Apply file layout

Reorders type members in files according to the rules configurable on the Editor | Code Style | C# | File Layout page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Rearrange members with file and type layout patterns.

Update file header

Inserts or updates the file header comment

.

Syntax Styles

Apply 'var' style

Applies the rules for 'var' usage during the cleanup. The rules are configurable on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Use explicit or implicit modifier definition for types

Applies the rule for type modifiers - whether on not to use the internal modifier explicitly. The rule is configurable on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Modifiers.

Use explicit or implicit modifier definition for type members

Applies the rule for type member modifiers - whether on not to use the private modifier explicitly. The rule is configurable on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Modifiers.

Sort modifiers

Applies the preferred order of type/member modifiers. The rule is configurable on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Modifiers.

Apply arguments style (named | positional)

Applies the preferences for named/positional arguments for specific types of parameters. The preferences are configurable on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Named/Positional Arguments.

Remove redundant parentheses

Removes redundant optional parentheses in cases specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Optional Parentheses.

Add parentheses to explicitly specify operation precedence

Adds optional parentheses to clarify precedence of operations in cases specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Optional Parentheses.

Add/remove braces around single statements

Adds or removes optional braces around single nested statements as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Braces for Single Nested Statements.

Add/remove brackets for attributes

Applies the rules for multiple attributes as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Multiple Attributes.

Apply code body style

Applies preferences for bodies of type members (expression body | statement body) as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Bodies of Type Members.

Arrange trailing commas

Applies preferences for trailing commas in declarations with multiple items and similar constructs (object, array, and collection initializers, as well as enums and switch expressions) as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Trailing Commas.

Apply object creation style ('new()' vs 'new T()')

Applies preferences for using the target-typed new operator in C# 9.0 and later as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Object Creation ('new()' vs 'new T()').

Apply default value style ('default' vs 'default(T)')

Applies preferences for using optional type specification in default value expressions as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Default Value Expressions ('default' vs 'default(T)').

Remove code redundancies

On the Editor | Inspection Severity page of JetBrains Rider settings Ctrl+Alt+S, in the Redundancies in Code categories for most languages, JetBrains Rider lists over 50 redundancies that have associated code inspections. Some of them require special attention, and you cannot process them in the batch mode. That leaves Code Cleanup with about 30 redundancies that it is able to remove automatically whenever you select Remove code redundancies in your cleanup profile.

Specifically, code cleanup:

• Removes:

  • Redundant empty constructors.

  • Explicit integer type specifiers in enumerations.

  • true specifiers in for statements.

  • Redundant type casts.

  • Redundant parentheses from attributes without arguments.

  • Explicit calls to base class constructors without arguments.

  • Redundant boolean comparisons.

  • Redundant braces from collection initializers with a single expression.

  • Redundant explicit delegate creation expressions.

  • Empty argument lists from object/collection initializers.

  • Redundant new keywords.

  • Redundant partial modifiers on type declarations where a type has a single part.

  • Redundant unsafe contexts and statements.

  • Redundant object.ToString() calls (for example, in a concatenation with a string or as an argument of a string.Format() call).

  • Redundant string.ToCharArray() calls.

  • Redundant specifications of argument types.

  • Signatures in anonymous methods where its parameters are not used in the method body.

  • Non-referenced labels.

  • Redundant field initializers.

  • Redundant explicit names in anonymous type properties.

  • Redundant nullable types where value type is implicitly convertible to nullable.

• Converts:

  • Nullable types to short form Nullable<T> to T?.

  • Static method invocations to extension method calls where extension methods are invoked as static methods.

  • To implicitly typed array creation expressions when array type can be inferred from initializer.

• Fixes:

  • Occurrences where static members of a type are accessed via derived members of the type.

Use auto-property, if possible

Replaces simple properties and corresponding backing fields with auto-properties. For more information, see Use auto-properties.

Make field read-only, if possible

Adds the 'readonly' keyword to fields that are assigned in the declaration or in a constructor and only have read usages. For more information, see Make fields readonly.

Make auto-property get-only, if possible

Removes the redundant set accessor on auto-properties that are initialized from the constructor/initializer and have no write usages. Note that this task only works for C# 6.0.

By default, JetBrains Rider automatically detects C# version based on the associated compiler. However, you can specify the target C# version explicitly for a project — press Alt+Enter on the project in the Solution Explorer and use the Language version selector on the Application page of the Project Properties dialog.

To set the C# version for all projects in your solution, specify it in a Directory.Build.props file in your solution directory as described here.

Arrange qualifiers

Applies the rules for qualifying type members. The rules are configurable on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Optional Member Qualifiers.

Fix built-in type references

Applies the rule for built-in type names (C# keyword or CLR type name). The rule is configurable on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Code Syntax Style: Built-In Type References.

Usings

Includes the following configurable options:

Optimize 'using' directives

Removes unused namespace import directives

and sorts the namespace import directives: all System.* namespaces go first, sorted alphabetically by the second word after the dot; all other namespaces go next, in alphabetical order.. For more information, see Code Syntax Style: Namespace Imports.

Embrace 'using' directives in region

If this checkbox is selected, a new region for wrapping all namespace import directives is created during cleanup.

Region name

Allows specifying a name for the region wrapping namespace import directives.

Shorten qualified references

Replaces fully qualified names with short names when possible by importing namespaces, implementing settings configured on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Reformat code

Reformats your code according to the preferences that you can configure on the Editor | Code Style | C# page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Manage and apply formatting rules.

Reformat embedded XML doc comments

Reformats XML doc comments according to options configurable on the Editor | Code Style | C# | XML Doc Comments page of JetBrains Rider settings Ctrl+Alt+S.

Note that JetBrains Rider does not reformat plain comments like:

or

Collapse empty tags

Removes the closing tag if the tag body is empty.

Remove redundant attributes

Removes attributes, such as Freeze, modifiers, name, span, UpdateSourceTrigger, Mode if they are redundant in the context

Remove redundant resource

Removes resource references that are not used

Remove redundant property setters

Removes unused setters for the following properties: property, attached, style.

Remove redundant namespace alias

Remove all redundant namespace aliases in the scope of cleanup. Redundant aliases are also detected with the code inspection and can be removed with a quick-fix.

Remove redundant definitions

Removes definitions if they are redundant in the context

Remove forbidden attributes

Removes attributes, such as name, span if they are forbidden in the context

Reformat code

Reformats your code according to the preferences that you can configure on the Editor | Code Style | XML page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Manage and apply formatting rules.

Remove code redundancies

Removes redundant code the same way as for C# Language

Optimize 'import' directives

Removes unused namespace import directives

.

Shorten qualified references

Replaces fully qualified names with short names when possible by importing namespaces, implementing settings configured on the Editor | Code Style | VB.NET | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Reformat code

Reformats your code according to the preferences that you can configure on the Editor | Code Style | VB.NET page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Manage and apply formatting rules.

Reformat embedded XML doc comments

Reformats XML doc comments according to options configurable on the Editor | Code Style | C# | XML Doc Comments page of JetBrains Rider settings Ctrl+Alt+S.

Note that JetBrains Rider does not reformat plain comments like:

or

Alphabetize properties

Rearranges CSS properties in the alphabetical order.

Reformat code

Reformats your code according to the preferences that you can configure on the Editor | Code Style | CSS page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Manage and apply formatting rules.

Apply statement termination

Adds the optional semicolon ; at the end of statements in JavaScript, TypeScript, and JSON.

Normalize quotes around string literal

Applies the preferred quote style: single quote (') or double quote ("). The preference can be configured on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Correct 'var' to 'let'/'const' where possible

let and const are supported in the following cases:

• In JavaScript code, if the target JavaScript language level is ECMAScript 6 (you can choose it on the Languages & Frameworks | JavaScript page of JetBrains Rider settings Ctrl+Alt+S)

• In TypeScript 1.4, if the target ECMAScript 6 is selected in the project properties.

• In TypeScript 1.5 or later.

Move let/const to most possible inner scopes

Moves variables defined outside of a function/compound statement, and so on closer to their usages if there are no other usages in outer scopes.

Convert string concatenations to template strings

In JavaScript code, if the target JavaScript language level is ECMAScript 6 (you can choose it on the Languages & Frameworks | JavaScript page of JetBrains Rider settings Ctrl+Alt+S), as well as in TypeScript 1.4 or later, this option will convert string concatenations to template strings. For example:

will be converted to

Reformat code

Reformats your code according to the preferences that you can configure on the Editor | Code Style | JavaScript page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Manage and apply formatting rules.

Reformat embedded XML doc comments

Reformats XML doc comments according to options configurable on the Editor | Code Style | C# | XML Doc Comments page of JetBrains Rider settings Ctrl+Alt+S.

Note that JetBrains Rider does not reformat plain comments like:

or

Remove redundant qualifiers

Use this option to remove redundant type name qualifiers.

Optimize 'import' statements

Use this option to remove redundant 'import' statements or fully-qualified names according to the settings configurable on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Optimize reference comments

Use this option to remove redundant reference comments.

Synchronize 'public' presence with code style

This option lets you add or remove explicit 'public' modifier according to settings configurable on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Add explicit 'any' type annotation if needed

This option lets you add explicit 'any' annotation to types according to settings configurable on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Synchronize type annotation presence with code style

This option lets you enforce explicit/implicit typing according to settings configurable on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Fix relative path style in 'require' if needed

Applies the Relative file reference style in 'require' code style preference for relative paths in the require keyword. For example, import X = require("file1") or import X = require("./file1"). You can configure this preference on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider settings Ctrl+Alt+S.

Use 'as' instead of type assertions

Replaces

with

which is a recommended way to avoid ambiguity with JSX syntax.

Reformat code

Reformats your code according to the preferences that you can configure on the Editor | Code Style | HTML page of JetBrains Rider settings Ctrl+Alt+S. For more information, see Manage and apply formatting rules.

Normalize quotes around attribute value

Applies the preferred quote style: single quote (') or double quote (").

Optimize @Register directives

Removes unused @Register directives.