JetBrains Rider
 
2023.1
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
You are viewing the documentation for an earlier version of JetBrains Rider.
  1. Languages and frameworks
  2. JavaScript
  3. Configure JavaScript libraries

Configure JavaScript libraries

Last modified: 09 June 2023

Required plugin:

Javascript and TypeScript -  The plugin is bundled with JetBrains Rider and enabled by default.

In context of the language and the IDE, a library is a file or a set of files. Functions and methods of these files are added to JetBrains Rider's internal knowledge in addition to the functions and methods that JetBrains Rider retrieves from the project code that you edit. In the scope of a project, its libraries by default are write-protected.

JetBrains Rider reserves two predefined auto-generated library folders:

note

JetBrains Rider uses libraries only to enhance coding assistance (that is, code completion, syntax highlighting, navigation, and documentation lookup). Note that a library is not a way to manage your project dependencies.

Using TypeScript community stubs (TypeScript definition files)

tip

TypeScript community stubs are also known as TypeScript definition files, or TypeScript declaration files, or DefinitelyTyped stubs, or just d.ts files.

In JetBrains Rider, DefinitelyTyped stubs can be configured and used as libraries, which is in particular helpful in the following cases:

  • To improve code completion, resolve symbols for a library or a framework that is too sophisticated for JetBrains Rider static analysis, and add type information for such symbols.

  • To resolve globally defined symbols from test frameworks.

The example below shows a piece of code from an Express application where the post() function is not resolved:

ws_js_configure_libraries_node_express_symbols_not_resolved_without_d_ts.png

JetBrains Rider successfully resolves post() after you install the suggested TypeScript definition file:

ws_js_configure_libraries_node_express_symbols_resolved_with_d_ts.png

JetBrains Rider lets you download TypeScript definition files right from the editor, using an intention action, or you can do it on the Settings: JavaScript Libraries page.

Download TypeScript definitions using an intention action

  • Position the caret at the require statement with this library or framework, press Alt+Enter, and choose Install TypeScript definitions for better type information:

    ws_js_libs_download_ts_definitions_intention_action.png

    JetBrains Rider downloads the type definitions for the library and adds them to the list of libraries on the JavaScript. Libraries page:

    Type definitions library added to the list

Download TypeScript definitions in the Settings/Preferences dialog

  1. Press Ctrl+Alt+S to open the IDE settings and select Languages & Frameworks | JavaScript | Libraries.

  2. On the Libraries page that opens, click Download and in the Download Library dialog that opens, select the required library, and click Download and Install.

    Add TypeScript definition file

JetBrains Rider shows the downloaded type definitions in the Project tool window, under the External Libraries node.

Downloaded type definitions are shown under the External libraries node

Optionally

Configuring Node.js Core library

To get code completion and reference resolution for fs, path, http, and other core modules that are compiled into the Node.js binary, you need to configure the Node.js Core module sources as a JavaScript library.

Configure Node.js Core

  1. Press Ctrl+Alt+S to open the IDE settings and select Languages & Frameworks | Node.js.

  2. Select the Coding assistance for Node.js checkbox.

    Note that the Node.js Core library is version-specific. So if you change the version of your Node.js on the Node.js page, you need to select the checkbox again. After that JetBrains Rider creates a new library for this new version.

Configuring node_modules library

To provide code completion for project dependencies, JetBrains Rider creates a node_modules library automatically so Node.js modules are kept in your project but no inspections are run against them, which improves performance.

ws_js_node_modules_added_settings.png

In the Project tool window, the node_modules is also marked as a library:

ws_js_configure_libraries_node_modules_marked_as_library_root.png

However, the node_modules library contains only the modules that are listed in the dependencies object of your project package.json file. JetBrains Rider does not include the dependencies of dependencies into the node_modules library but actually excludes them from the project.

Configuring the scope of a library

From time to time you may notice that JetBrains Rider suggests irrelevant completion, for example, Node.js APIs in your client-side code. This happens because by default JetBrains Rider uses a library for completion in the entire project folder. JetBrains Rider lets you tune code completion by configuring scopes for libraries.

Configure the scope of a library

  1. Press Ctrl+Alt+S to open the IDE settings and select Languages & Frameworks | JavaScript | Libraries.

    The Libraries page shows a list of available libraries.

  2. Clear the Enabled checkbox next to the required library, and click Manage Scopes.The JavaScript Libraries. Usage Scope dialog opens.

  3. In the JavaScript Libraries Usage Scopes dialog, click the Add button (app.general.add.png) and select the files or folders that you want to include in the library scope. In the JavaScript Libraries Usage Scopes dialog, the Path field shows selected files or folders.

  4. For each added file or a folder, from the Library list, select the library that you are configuring.

Example: Configuring the scope for HTML and Node.js Core libraries

When working on a full-stack JavaScript application in JetBrains Rider, you often notice that code completion suggests some Node.js API in your client-side code and DOM API in the Node.js code. This happens because the HTML library with DOM API and the Node.js Core library with Node.js API are by default enabled in the whole project. To get rid of irrelevant completion suggestions, you need to configure the scope for these libraries.

Configure the scopes of the HTML and Node.js Core libraries

  1. Press Ctrl+Alt+S to open the IDE settings and select Languages & Frameworks | JavaScript | Libraries.

    The Libraries page shows a list of available libraries.

    ws_html_node_libs.png

  2. Clear the Enabled checkboxes next to HTML and Node.js Core items.

  3. Click Manages Scopes.

  4. To configure the scope for the HTML library, click app.general.add.png, select the folders with the client-side code, and then choose HTML from the Library list.

  5. To configure the scope for the Node.js Core library, click app.general.add.png again, select the folders with the server-side code, and choose Node.js Core from the Libraries list.

    Now JetBrains Rider resolves items from the HTML and Node.js Core libraries and suggests them in completion only in files from these chosen project folders.

    https://resources.jetbrains.com/help/img/rider/2023.1/ws_manage_lib_scope.png
    Gif

In the same way, you can configure the scope of the automatically created node_modules library, see Configuring node_modules library.

Configuring a library added via a CDN link

When a library .js file is referenced through a CDN link, it is available for the runtime but is invisible for JetBrains Rider. To add the objects from such library .js file to completion lists, download the file and configure it as an external library.

Download a library

  • Position the caret at the CDN link to the library, press Alt+Enter, and choose Download library from the list:

    Intention action: download CDN library

    The library is downloaded to JetBrains Rider cache (but not into your project) and a popup with an information message appears:

    CDN library added

    On the JavaScript Libraries page, the downloaded library is added to the list and enabled it in the scope of the current project:

    CDN library added to the list

    In the Project tool window, the library is shown under the External Libraries node:

    Downloaded CDN library is shown under the External Libraries node

Change the visibility of a library

  • By default, JetBrains Rider marks the downloaded library as Global, which means that you can enable and re-use it in any other JetBrains Rider project. To change this default setting, select the downloaded library in the list, click Edit, and choose Project in the Edit Library dialog that opens.

    ws_js_configure_libraries_change_visibility.png

Configuring a custom third-party JavaScript library

Suppose you have a JavaScript framework file in your project or elsewhere on your machine and you want JetBrains Rider to treat it as a library and not just as your project code that you edit.

Configure a custom library

  1. Download the required framework file.

  2. Press Ctrl+Alt+S to open the IDE settings and select Languages & Frameworks | JavaScript | Libraries.

  3. On the Libraries page, click Add.

  4. In the New Library dialog, specify the name of the external JavaScript library.

  5. Click the Add button (app.general.add.png), and select Attach Files or Attach Directories from the list.

    Configure custom library: Add files/folders

    In the file browser, select the file or folder with the downloaded framework.

    Configure custom library: library added

    When you click OK, you return to the Libraries page where the new library is added to the list.

    The new custom library is added to the list

  6. In the Project tool window, the library is shown under the External Libraries node.

    A custom library is shown under the external Libraries node

Optionally

  • By default, the library is Global, which means that you can attach it to any other project. To suppress re-using a library, choose Project in the New Library dialog.

  • By default, the library is enabled in the scope of the whole current project. You can change this default setting as described in Configuring the scope of a library.

  • In the Documentation URLs area, specify the path to the official documentation of the library or framework. JetBrains Rider will open this URL when you press Shift+F1 on a symbol from this library.

Viewing the libraries associated with a file

Deleting a library