JetBrains Rider 2020.1 Help

Code Cleanup

File | Settings | Editor | Code Cleanup for Windows and Linux

JetBrains Rider | Preferences | Editor | Code Cleanup for macOS Ctrl+Alt+S the Settings/Preferences icon

This page of JetBrains Rider options allows you to manage and configure custom cleanup profiles, as well as to assign a cleanup profile for the silent code cleanup. The two default profiles (Full Cleanup, Reformat & Apply Syntax Style and Reformat Code) are also shown here. You cannot modify modify them, but you can clone them to make new custom profiles.

Toolbar controls

Use the following controls to configure the selected cleanup profile:

ThemedIcon AddPattern Screen Gray png Add Click this button to create a new custom Code Cleanup profile. As soon as a new profile is created, it opens in the editing mode, where you can configure the list of cleanup tasks.
ThemedIcon CodeCleanupOptionPage Screen Gray png Set as default Click this button to use the selected profile for silent cleanup.
ThemedIcon Duplicate Screen Gray pngClone Click this button to create a copy of the selected profile. If you have default settings, you will need to duplicate one of the default cleanup profiles to create a custom cleanup profile. As soon as a new profile is created, it opens in the editing mode, where you can configure the list of cleanup tasks.
ThemedIcon Edit Screen Gray png Rename Click this button to rename the selected custom profile. Note that default profiles (Full Cleanup, Reformat & Apply Syntax Style and Reformat Code) cannot be renamed.
ThemedIcon Remove Screen Gray png Remove Click this button to remove the selected custom profile. Note that default profiles (Full Cleanup, Reformat & Apply Syntax Style and Reformat Code) cannot be removed.

Code cleanup tasks for selected profile

These tasks become configurable for the selected custom cleanup profile. Initially, there are no custom profiles and tasks of the default profiles cannot be edited. You can click ThemedIcon Duplicate Screen Gray png Duplicate to create an editable copy of one of the default profiles and then edit its tasks.

C#

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 options 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 options 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 options 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 options 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 options 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 options 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 options 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 options 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 options Ctrl+Alt+S. For more information, see Code Syntax Style: Braces for Single Nested Statements.
Arrange attributes Applies the rules for multiple attributes as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider options Ctrl+Alt+S. For more information, see Code Syntax Style: Multiple Attributes.
Apply code body style Applies preferences for bodies of function members (expression body | statement body) as specified on the Editor | Code Style | C# | Syntax Style page of JetBrains Rider options Ctrl+Alt+S. For more information, see Code Syntax Style: Bodies of Function 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 options Ctrl+Alt+S. For more information, see Code Syntax Style: Trailing Commas.
Remove code redundancies

On the Editor | Inspection Severity page of JetBrains Rider options 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 — 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 .
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 options 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 options 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 options 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 options Ctrl+Alt+S. For more information, see Manage and Apply Code 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 options Ctrl+Alt+S.

Note that JetBrains Rider does not reformat plain comments like:
// A plain single-line comment
or
/* A plain multi-line comment */

XAML

Collapse empty tags Removes the closing tag if the tag is empty.

XML

Reformat code Reformats your code according to the preferences that you can configure on the Editor | Code Style | XML page of JetBrains Rider options Ctrl+Alt+S. For more information, see Manage and Apply Code Formatting Rules.

VB.NET

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 options 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 options Ctrl+Alt+S. For more information, see Manage and Apply Code 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 options Ctrl+Alt+S.

Note that JetBrains Rider does not reformat plain comments like:
// A plain single-line comment
or
/* A plain multi-line comment */

CSS

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 options Ctrl+Alt+S. For more information, see Manage and Apply Code Formatting Rules.

JavaScript-like languages

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

JavaScript

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 options 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 options 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 options Ctrl+Alt+S) , as well as in TypeScript 1.4 or later, this option will convert string concatenations to template strings. For example:
var str1 = "Hello,"; var str2 = "Test: " + str1 + " World1";
will be converted to
const str1 = "Hello, "; const str2 = `Test: ${str1} World1`;
Reformat code Reformats your code according to the preferences that you can configure on the Editor | Code Style | JavaScript page of JetBrains Rider options Ctrl+Alt+S. For more information, see Manage and Apply Code 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 options Ctrl+Alt+S.

Note that JetBrains Rider does not reformat plain comments like:
// A plain single-line comment
or
/* A plain multi-line comment */

TypeScript

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 options Ctrl+Alt+S.
Optimize reference comments Use this option to remove redundant reference comments.
Synchronize 'public' presence with code style This options lets you add or remove explicit 'public' modifier according to settings configurable on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider options Ctrl+Alt+S.
Add explicit 'any' type annotation if needed This options lets you add explicit 'any' annotation to types according to settings configurable on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider options Ctrl+Alt+S.
Synchronize type annotation presence with code style This options lets you enforce explicit/implicit typing according to settings configurable on the Editor | Code Style | TypeScript | Syntax Style page of JetBrains Rider options 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 options Ctrl+Alt+S.
Use 'as' instead of type assertions Replaces
var bar = <string> foo;
with
var bar = foo as string;
which is a recommended way to avoid ambiguity with JSX syntax.

HTML

Reformat code Reformats your code according to the preferences that you can configure on the Editor | Code Style | HTML page of JetBrains Rider options Ctrl+Alt+S. For more information, see Manage and Apply Code Formatting Rules.
Normalize quotes around attribute value Applies the preferred quote style: single quote (') or double quote (") .

ASP.NET

Optimize @Register directives Removes unused @Register directives.
Last modified: 08 May 2020