JetBrains Rider 2020.2 Help

Spell Checking with ReSpeller

One important task of code inspection is spell checking, which JetBrains Rider performs with ReSpeller — its integrated spell-checking engine. ReSpeller will look for spelling mistakes in identifiers, comments, and string literals. When it detects a potential spelling mistake or a typo, it will let you know in the same way as other code issues —in design time or when you run code inspection is specific scope.

Spell checking is enabled by default, but you can disable it by clearing the corresponding checkbox on the Editor | Spelling | ReSpeller page of JetBrains Rider settings Ctrl+Alt+S.

Similarly to other highlighted issues, you can press Alt+Enter and choose Replace with… to choose one of the ReSpeller's suggestions.

JetBrains Rider: Detecting and fixing typos

If you use the ReSpeller's quick-fix to fix a typo in an identifier, the Rename refactoring will be invoked automatically to ensure consistency of the change across your code base.

ReSpeller dictionaries

JetBrains Rider comes with a built-in dictionary for English (United States), but it allows you to install and use Hunspell /MySpell dictionaries for other languages. A lot of dictionaries can be found on https://github.com/wooorm/dictionaries.

Install custom dictionaries

  1. Install the Hunspell plugin.

  2. Press Ctrl+Alt+S or choose File | Settings (Windows and Linux) or JetBrains Rider | Preferences (macOS) from the menu , then choose Editor | Spelling | ReSpeller on the left.

  3. Add the desired Hunspell/MySpell dictionaries — click Add and pick a Hunspell dictionary file .dic. Note that you also need to have the affix file of the dictionary (named the same as the dictionary file but with the .aff extension) next to the dictionary file.

  4. You can also go to the child page, ReSpeller, and specify which kinds of identifiers and strings should be spell-checked and which should not.

  5. 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.

When you install a custom dictionary, JetBrains Rider saves a full path to the dictionary file in settings.
If you share your solution via VCS, you can share custom dictionaries by putting dictionary files in the VCS directory and making the paths in the settings file relative.

Share custom dictionaries

  1. Put the desired dictionary files in your solution directory. For example, you can create a Dictionaries subdirectory in the solution root and put the files there.

  2. Add the dictionaries in settings as described above, make sure to save changes in the 'Solution team-shared' settings layer.

  3. In the solution root folder, find and open the team-shared settings file <SolutionName>.sln.DotSettings.

  4. In the settings file, find all entries that define dictionaries — they start with <s:Boolean x:Key="/Default/InstalledDictionaries— and specify relative paths for them.

    For example, if you put German dictionary files German.dic and German.aff in the Dictionaries subdirectory in the solution root, then the entry for the dictionary will look as follows in the settings file:

    <s:Boolean x:Key="/Default/InstalledDictionaries/=_005CDictionaries_005CGerman_002Edic/@EntryIndexedValue">True</s:Boolean>

    The path format in settings uses the following symbol substitutions:

    • _003A for :

    • _005C for \

    • _002E for .

  5. Make sure that <SolutionName>.sln.DotSettings file and all dictionary files are committed to your VCS.

You can extend the installed dictionaries with other words, which will be stored using the settings layers or Directory-Based Settings together with other preferences. There are two ways to add user words:

  • When your caret is on a highlighted spelling issue in the editor, choose Add to user dictionary from the Alt+Enter menu. The word will be saved using the smart save logic, but you can also expand the submenu to choose a specific settings layer:

    JetBrains Rider: adding user words for spell checking
    The options marked with [R#] will save the word in settings layers, which are compatible with ReSharper. The options marked with [Rider] will save the word in Directory-Based Settings, which are compatible with IntelliJ-Platform-based IDEs.

  • On the Editor | Spelling | ReSpeller page of JetBrains Rider settings Ctrl+Alt+S, use the User words field to configure a newline-separated list of words to be ignored by the spell-checker.

Configure ReSpeller inspections

By default, ReSpeller inspections are enabled in many of JetBrains Rider’s supported languages. You can enable/disable individual inspections and change their severity levels by searching for typo on the Editor | Inspection Severity page of JetBrains Rider settings Ctrl+Alt+S.

Last modified: 21 August 2020