Configure JavaScript libraries
node_modules for keeping Node.js packages listed in the
dependenciesobject of your project package.json. For more information, refer to Configuring node_modules library.External Libraries for storing downloaded TypeScript definition files or libraries referenced via CDN links as well as Node.js Core nodules or any custom third-party libraries.
note
RubyMine 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.
tip
TypeScript community stubs are also known as TypeScript definition files, or TypeScript declaration files, or DefinitelyTyped stubs, or just d.ts files.
Place the caret at the
importorrequirestatement with this library or framework, press AltEnter, and choose Install TypeScript definitions for better type information:
RubyMine downloads the type definitions for the library and adds them to the list of libraries on the JavaScript. Libraries page:
Alternatively, open your package.json, place the caret at the package to download a type definition for, press AltEnter, and select Install '@types/<package name>'.
Press CtrlAlt0S to open the IDE settings and then select .
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.
Press CtrlAlt0S to open the IDE settings and then select .
The Libraries page shows a list of available libraries.
Clear the Enabled checkbox next to the required library, and click Manage Scopes. The JavaScript Libraries. Usage Scope dialog opens.
In the JavaScript Libraries Usage Scopes dialog, click the Add button (
) 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.For each added file or a folder, from the Library list, select the library that you are configuring.
Press CtrlAlt0S to open the IDE settings and then select .
The Libraries page shows a list of available libraries.
Clear the Enabled checkboxes next to HTML and Node.js Core items.
Click Manage Scopes. The JavaScript Libraries Usage Scopes dialog opens.
To configure the scope for the HTML library, click
.
In the dialog that opens, select the folders with the client-side code and click Open.
You return to the JavaScript Libraries Usage Scopes dialog where the selected folders are added to the list.
From the Library list next to each folder, select HTML.
To configure the scope for the Node.js Core library, click
again, add the folders with the server-side code, and for each of them select Node.js Core from the Libraries list.
Now RubyMine resolves items from the HTML and Node.js Core libraries and suggests them in completion only in files from these chosen project folders.
Place the caret at the CDN link to the library, press AltEnter, and choose Download library from the list:
The library is downloaded to RubyMine cache (but not into your project), and a popup with an information message appears:
On the JavaScript Libraries page, the downloaded library is added to the list:
In the Project tool window, the library is shown under the External Libraries node:
By default, RubyMine marks the downloaded library as Global, which means that you can enable and re-use it in any other RubyMine 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.
Download the required framework file.
Press CtrlAlt0S to open the IDE settings and then select .
On the Libraries page, click Add.
In the New Library dialog, specify the name of the external JavaScript library.
Click the Add button (
), and select Attach Files or Attach Directories from the list.
In the file browser, select the file or folder with the downloaded framework.
When you click OK, you return to the Libraries page where the new library is added to the list.
In the Project tool window, the library is shown under the External Libraries node.
Open the file in the editor, press CtrlShift0A, and select Use JavaScript Library from the list.
RubyMine displays a list with the available configured libraries. The libraries associated with the current file are marked with a tick.
To remove the current file from the scope of a library, clear the tick next to this library.
To associate a library with the current file, set a tick next to this library.
Thanks for your feedback!