JetBrains Rider 2021.2 Help

Code cleanup

Code | Reformat and Cleanup...
Ctrl+E, C

JetBrains Rider allows you to apply formatting and other code style preferences in a bulk mode to instantly eliminate code style violations in one or more files, in a project or in the entire solution.

Code cleanup profiles

Code cleanup can have various configurations (profiles) to apply in different cases according to your needs. There are three default profiles available out of the box:

These profiles help in most cases but you cannot configure them. If you want to run code cleanup with the custom set of cleanup tasks, you need to create a custom profile and specify the set of desired tasks there.

Create a new custom cleanup profile

  1. Press Ctrl+Alt+S or choose File | Settings (Windows and Linux) or JetBrains Rider | Preferences (macOS) from the menu.

  2. Go to the cleanup profiles settings page: Editor | Code Cleanup.

  3. Click Add on the top of the page. JetBrains Rider will create a new cleanup profile.

  4. Select the newly created profile in the list of profiles.

  5. Use the right pane to configure the list of tasks in the selected profile.

  6. Click Save in the Settings dialog to apply the modifications and let JetBrains Rider choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see Layer-based settings.

Your newly created cleanup profile will be available in the Code Cleanup dialog (Code | Code Cleanup) when you are running code cleanup. You can also set this profile to be used for the silent cleanup.

Run code cleanup

Code | Reformat and Cleanup...
Ctrl+E, C

JetBrains Rider can apply code cleanup to an arbitrarily selected block of code, all code in the current file, all files in a directory, files in the current VCS changelist, the current project, or even the current solution. Make sure that you select the right set of cleanup tasks by choosing the right cleanup profile.

Clean up the selection or the whole file

  1. Select the scope where you want to clean up code:

    • Make a selection in the editor to clean up code in the selection.

    • Set the caret anywhere in the file to clean up code in the file.

  2. Press Ctrl+E, C or choose Code | Reformat and Cleanup... from the main menu.

  3. In the Code Cleanup dialog that opens, you can check and optionally change the scope for cleaning code and choose a cleanup profile to apply. Use the area to the right of the selected profile to check the tasks included in that profile.

  4. If none of the available profiles suits you, click Edit Android studio icons avd edit, then choose one of the existing profiles and click Clone to create a new custom profile and save the changes.

  5. Click OK to clean code in the selected scope.

You can clean up not only an individual file, but also multiple files in a directory, project or entire solution. To do so, you should run code cleanup from the Solution Explorer.

Clean up multiple files, projects, or entire solution

  1. Select one or more items (files, directories, projects, or the solution) in the Solution Explorer.

  2. Press Ctrl+E, C or choose Code | Reformat and Cleanup... from the main menu.

  3. Choose a cleanup profile as described above.

  4. Click OK to clean code in the selected scope.

You can also run code cleanup on code that you have recently modified and are going to commit to Git. JetBrains Rider will run the selected cleanup profile before committing.

Clean up code before committing it to Git

  1. Press Ctrl+K or select Git | Commit from the main menu.

  2. In the Commit tool window, click Show Commit Options and in the Before Commit area, select the Cleanup with... checkbox.

  3. Optionally, you can click Choose profile to specify the cleanup profile that should be used.

  4. Click Commit or Commit and Push. JetBrains Rider will run code cleanup on the ranges selected for commit and then commit the changes.

Silent cleanup

Code | Silent Reformat and Cleanup
Ctrl+E, F

You can also run code cleanup in the silent mode - that is, without displaying the Code Cleanup dialog. Since in this case you will not be able to choose a profile explicitly, you have to assign some cleanup profile to use for the silent code cleanup.

Assign a profile for silent code cleanup

  1. Press Ctrl+Alt+S or choose File | Settings (Windows and Linux) or JetBrains Rider | Preferences (macOS) from the menu.

  2. Go to the cleanup profiles settings page: Editor | Code Cleanup.

  3. Select a cleanup profile on the left and click Set as default for silent cleanup at the top of the options page.

  4. Click Save in the Settings dialog to apply the modifications and let JetBrains Rider choose where to save them, or save the modifications to a specific settings layer using the Save To list. For more information, see Layer-based settings.

Run code cleanup in silent mode

  1. Do one of the following:

    • To run silent code cleanup in a specific code file, open it in the text editor or select it in the Solution Explorer.

    • To apply silent code cleanup to a set of files (directory, project, or solution), select the corresponding item in the Solution Explorer.

  2. Press Ctrl+E, F or choose Code | Silent Reformat and Cleanup from the main menu. Alternatively, you can press Ctrl+Shift+A, start typing the command name in the popup, and then choose it there.

Available code cleanup tasks

The tables below list available cleanup tasks for different languages. If you need the cleanup to perform only a part of these tasks, you can create a custom cleanup profile for that.

C#

Apply file layoutReorders 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 headerInserts or updates the file header comment .
Syntax Styles
Apply 'var' styleApplies 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 typesApplies 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 membersApplies 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 modifiersApplies 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 parenthesesRemoves 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 precedenceAdds 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 statementsAdds 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 attributesApplies 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 styleApplies 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 commasApplies 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 possibleRemoves 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 qualifiersApplies 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 referencesApplies 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 referencesReplaces 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 codeReformats 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 commentsReformats 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:
// A plain single-line comment
or
/* A plain multi-line comment */

XAML

Collapse empty tagsRemoves the closing tag if the tag body is empty.
Remove redundant attributesRemoves attributes, such as Freeze, modifiers, name, span, UpdateSourceTrigger, Mode if they are redundant in the context
Remove redundant resourceRemoves resource references that are not used
Remove redundant property settersRemoves unused setters for the following properties: property, attached, style.
Remove redundant namespace aliasRemove 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 definitionsRemoves definitions if they are redundant in the context
Remove forbidden attributesRemoves attributes, such as name, span if they are forbidden in the context

XML

Reformat codeReformats 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.

VB.NET

Remove code redundanciesRemoves redundant code the same way as for C# Language
Optimize 'import' directivesRemoves unused namespace import directives .
Shorten qualified referencesReplaces 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 codeReformats 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 commentsReformats 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:
// A plain single-line comment
or
/* A plain multi-line comment */

CSS

Alphabetize propertiesRearranges CSS properties in the alphabetical order.
Reformat codeReformats 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.

JavaScript-like languages

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

JavaScript

Normalize quotes around string literalApplies 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 scopesMoves 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 stringsIn 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:
var str1 = "Hello,"; var str2 = "Test: " + str1 + " World1";
will be converted to
const str1 = "Hello, "; const str2 = `Test: ${str1} World1`;
Reformat codeReformats 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 commentsReformats 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:
// A plain single-line comment
or
/* A plain multi-line comment */

TypeScript

Remove redundant qualifiersUse this option to remove redundant type name qualifiers.
Optimize 'import' statementsUse 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 commentsUse this option to remove redundant reference comments.
Synchronize 'public' presence with code styleThis 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 neededThis 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 styleThis 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 neededApplies 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 assertionsReplaces
var bar = <string> foo;
with
var bar = foo as string;
which is a recommended way to avoid ambiguity with JSX syntax.

HTML

Reformat codeReformats 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 valueApplies the preferred quote style: single quote (') or double quote (").

ASP.NET

Optimize @Register directivesRemoves unused @Register directives.
Last modified: 13 September 2021