JetBrains Rider 2019.3 Help

Features

You can start with watching this 3-minute video where Matt Ellis gives a short overview of JetBrains Rider features for Unity Development.

Unity Explorer

Unity Explorer

Modes
By default, when working with a Unity project in Rider, the Explorer window works in the Unity mode showing you all the assets that constitute the project. If you switch the Explorer window to the Solution mode, you will see only the Scripts part of the project.

Packages
Primarily, the Packages node shows you the contents of the Packages folder in the root of your project. This might well only contain a manifest.json file which you can edit in Rider and when saved, Unity will update your project to include the packages you've added. More importantly, the Packages node will also show all of the packages referenced in your project. Unity supports a number of different package types, and Rider will show them all. For more details on how Rider works with Unity packages, refer to the blog post.

Control over Unity editor

To reduce the time you spend context switching between Rider and the Unity editor, some of the Unity editor's functionality is exposed directly in Rider on the Unity toolbar located in the top right corner.

Unity toolbar

The toolbar allows:

  • Controlling play mode: The Play, Pause, and Step buttons correspond to the same buttons in the Unity editor and work in the exact same way.

  • Refreshing the asset database: The Refresh Refresh button causes the Unity editor to import any newly added assets, and if necessary, compile the project and regenerate the solution files (which Rider will silently reload). This is useful when adding new files through Rider, either by refactoring and renaming a file, or by adding new C# script or shader via file templates. It is also really helpful when adding a new .asmdef assembly definition file: create the file in Rider, save, click Refresh and Unity will generate a new project file that Rider will silently reload. Note that there is also an automatic refresh, which happens whenever a file is saved. Learn more about refreshing Unity assets.

  • Accessing important Unity-related actions using the Unity-related actions Unity-related Actions list:

    • Start Unity: start Unity Editor and open the Unity project that corresponds to the solution opened in Rider.

    • Start Unity: start Unity Editor with enabled code coverage support and open the Unity project that corresponds to the solution opened in Rider.

    • Attach to Unity Process...: attach to the running Unity instance, for example for debugging or unit testing purposes. You can also run this action in the main menu Run | Attach to Unity Process....

    • Unity Settings...: quickly open the Rider's Unity Engine settings page.

    • Show Unity Log Window : open the log viewer.

    • Switch to Full UI / Switch to Minimized UI: switch between the full Rider UI and the minimized one (all UI elements that are not related to Unity are hidden).

Editor tips

  • JetBrains Rider marks classes, methods and fields that are implicitly used by Unity directly in the editor.

    Editor tips

  • The UnityEngine.Color and UnityEngine.Color32 colors are highlighted, and hitting Alt+Enter will open the color palette editor to modify the color. Also named colors and Color.HSVToRGB are supported.

    Named colors

Find Usages

In Unity projects, the Find Usages Shift+F12 feature is extended with data pulled from Unity scenes, assets and prefabs. If you search for a class or a method used as an event handler, Rider will show where it is used in Unity files, grouped by type, component name, and parent game objects.

Moreover, there is a separate Find Unity Usages action that shows only the usages made from the Unity Editor.

Code Vision

The Code Vision feature also supports Unity. Right in the Rider editor, you can see what classes, methods, fields (including field values set in Unity), and even assets are implicitly used. Code Vision provides navigation to the Unity Editor.

Performance indicators

Unity performance indicators

The indicator in the left gutter highlights performance sensitive areas: event functions that are called each frame, such as Update, FixedUpdate and LateUpdate, as well as coroutine methods. Inside these frequently called methods, Rider will add performance indicators to known expensive operations, like calls to GetComponent, Find or SendMessage, with context actions to move the initialization to Start or Awake.

Event functions

  • You can generate event functions using Unity Event Functions the Generate Code menu Alt+Insert. This action is also available from Alt+Enter everywhere inside a Unity-based class.

  • Auto-completion will suggest event function names when declaring methods in Unity-based classes, and expand to include method signature. Start typing an event function within a class deriving from a known Unity class, such as MonoBehaviour.

    JetBrains Rider: Unity code completion

  • Descriptions for event functions and parameters in Unity based classes are shown in tooltips and Quick Documentation.

    JetBrains Rider: Unity quick documentation

Inspections and quick-fixes

  • Rider shows warnings for unknown scenes, tags, and layers.

    Unity unknown layer warning

  • When the Solution-Wide Analysis is enabled, JetBrains Rider understands implicitly used fields and event functions and do not highlight them as not accessed.

  • Empty event functions are shown as dead code, with a quick-fix to remove them.

  • Using the SyncVarAttribute inside any class other than NetworkBehaviour is treated as an error.

  • A quick-fix is suggested to create a serialized field from a usage of an unresolved symbol:

    Unresolved symbol quick-fix

  • JetBrains Rider ensures that all of your event functions have correct signatures: it highlights incorrect signatures and offers a quick-fix to correct them:

    Unity signatures

  • JetBrains Rider warns you against using an inefficient string literal comparison with the tag property, and provides a quick-fix to rewrite this as a call to CompareTag.

    Compare tag quick-fix

  • JetBrains Rider warns you if you try to use the new keyword to create a new instance of a class deriving from MonoBehaviour or ScriptableObject. A quick-fix is suggested to use gameObject.AddComponent<T>() or ScriptableObject.CreateInstance<T>() instead.

  • There are also inspections for the [InitializeOnLoad] and [InitializeOnLoadMethod] attributes, ensuring that they have the correct method or constructor signatures, and JetBrains Rider will grey out a redundant [InitializeOnLoad] attribute if the class doesn't have a static constructor, with a quick-fix to either quickly remove the attribute, or create the constructor.

  • and more...

External annotations

A lot of Unity-specific assemblies are annotated with External Annotations to improve code inspection when you make use of these assemblies.

  • Treating code marked with attributes from UnityEngine.dll, UnityEngine.Networking.dll and UnityEditor.dll as implicitly used.

  • Marking Component.gameObject and Object.name as not-nullable.

  • Debug.Assert marked as assertion method to help null-value analysis (for example "value cannot be null" after Debug.Assert(x != null)).

  • Debug.AssertFormat, LogFormat, and so on gets string formatting helper functionality.

  • Assertions.Assert methods marked as assertion methods to help null-value analysis.

  • EditorTestsWithLogParser.ExpectLogLineRegex gets regular expression helper functionality.

  • Various attributes now require the class they are applied to derive from a specific base type. For example, [CustomEditor] requires a base class of Editor.

  • Support for Unity 2017.2's modularised UnityEngine assemblies.

Support for .shader files

JetBrains Rider provides the initial support for ShaderLab syntax in .shader files, with limited support for Cg/HLSL blocks.

  • Syntax and syntax error highlighting for ShaderLab syntax. Note that you can change the default color scheme in File | Settings... | Editor | Color Scheme | ShaderLab.

  • Color Assistance:

    Coding assistance. Color assistance

  • JetBrains Rider provides simple completion based on words found in the current file.

    JetBrains Rider: Unity shader completion

  • Brace matching and highlighting, comment/uncomment Ctrl+Alt+/, and to-do explorer support.

    Unity shader to-do explorer

  • Code folding.

    JetBrains Rider: Unity shader folding

  • [Cg/HLSL] Syntax highlighting for CGPROGRAM/ CGINCLUDE blocks and .cginc files.

  • [Cg/HLSL] Simple word based completion in Cg/HLSL blocks.

    HLSL completion

Support for assembly definition files

asmdef files support

Assembly definition files (.asmdef) are used to separate project scripts into multiple assemblies in order to reduce compilation time. Unity will rebuild only required assemblies when you make changes in a script.

Rider provides support for .asmdef files: JSON schema validation, code completion, Find Usages, Rename refactoring, Navigation on references elements, and inspections/quick-fixes for self-reference and filename/assembly name mismatch. For more details on .asmdef files support, refer to the blog post.

Live templates

JetBrains Rider offers a couple of Unity-specific live templates:

  • sprop: a Unity property with a serialized backing field.

  • sfield: a Unity serialized field.

File templates

  • JetBrains Rider offers a number of file templates for new C# script, tests, and shader files:

    Unity file templates

Unity logs

Unity log window

When Rider is connected to the Unity editor, the Unity tool window becomes available. To open the window, select View | Tool Windows | Unity from the main menu or use the Unity-related Actions list on the Unity toolbar.

The Log tab of the Unity tool window brings Unity's Console into Rider. The tab shows Unity log entries and is updated as events are logged in Unity.

The Output part of the window on the right shows the content of the currently selected log entry. Rider makes the content interactive, so that you can navigate to any source file, class, method or property mentioned in the log entry.

Note that log entries can be filtered by event type: events from play or edit mode, warnings, errors, and messages.

Last modified: 11 December 2019