PyCharm 2018.2 Help

JavaScript

With PyCharm, you can develop modern web, mobile, and desktop applications with JavaScript and Node.js. PyCharm supports JavaScript and TypeScript programming languages, React and Angular frameworks and provides tight integration with various tools for web development.

On this page you will find a short Getting Started Guide that will walk you step by step from creating a web application to debugging and testing it.

Creating a new application

  1. Choose File | New | Project on the main menu or click Create New Project on the Welcome screen. The New Project dialog box opens.
  2. In the left-hand pane, choose any project type that is aimed for JavaScript application development, for example, Angular CLI, AngularJS, React App, or React Native.
  3. In the right-hand pane, specify the path to the folder where the project-related files will be stored.
  4. Expand More settings and specify other required project options.

Starting with an existing JavaScript application

If you are going to continue developing an existing JavaScript application, open it in PyCharm, choose the JavaScript version to use, and configure the libraries in it. Optionally download the required npm dependencies.

To open the application sources that are already on your machine

  • Click Open on the Welcome screen or choose File | Open on the main menu. In the dialog that opens, select the folder where your sources are stored.

To check out the application sources from your version control

  1. Click Check out from Version Control on the Welcome screen or choose VCS | Check out from Version Control on the main menu.
  2. Select your version control system from the list.
  3. In the VCS-specific dialog that opens, type your credentials and the repository to check out the application sources from.

Choosing the JavaScript language version

To get reliable and efficient coding assistance, you need to specify the language version that will be used in all JavaScript files of your application by default.

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), choose JavaScript under Languages and Frameworks. The JavaScript page opens.
  2. From the drop-down list, choose one of the supported JavaScript language versions:

Using multiple JavaScript versions

If you are working on an application that uses both ECMAScript 5.1 and a newer version of ECMAScript, or JSX, or Flow, the easiest way is to choose the highest language version for the whole project from the drop-down list on the JavaScript page. For example, if you use ES5.1 and JSX, enable JSX (since it is a superset of ES5.1 and ES6).

To configure different JavaScript language versions for different folders

  1. On the JavaScript page, click browseButton next to the JavaScript language version drop-down list. The JavaScript Language Versions dialog opens.
  2. Click icons general add svg and in the dialog that opens select the folder where you need a custom language version. PyCharm brings you back to the JavaScript Language Versions dialog where the selected folder is shown in the Path field.
  3. From the Language drop-down list, choose the language version for the files in the selected folder. In all the other JavaScript files in the project PyCharm will use the version chosen on the JavaScript page.
    ws_js_choose_language_version.png

Downloading npm dependencies

Before you start, install Node.js. If your application uses some tools, libraries, or frameworks, download the required packages.

To install a package in an empty project

  • Open the embedded Terminal (View | Tool Windows | Terminal or Alt+F12) and type npm install <package name> at the command prompt.

If you already have a package.json file in your project

  • Right-click the package.json file in the editor or in the Project tool window and choose Run 'npm install' on the context menu.

Configuring code completion for project dependencies

To provide code completion for project dependencies, PyCharm automatically creates a node_modules library. In PyCharm, a library is a file or a set of files whose functions and methods are added to PyCharm's internal knowledge in addition to the functions and methods that PyCharm retrieves from the project code that you edit. See Configuring JavaScript Libraries for details and examples.

Auto import in JavaScript

PyCharm can generate import statements for modules, classes, components, and any other symbols that are exported. If you are using ES6 in your project, PyCharm can add missing import statements on the fly, when you complete ES6 symbols.

For earlier JavaScript versions or when auto import on completion is disabled, PyCharm marks the symbol as unresolved and shows a tooltip:
ws_es6_autoimport_off_tooltip.png
On pressing Alt+Enter, PyCharm displays the suggested quick-fix:
ws_es6_autoimport_off.png
If there's more than one possible source of import, PyCharm shows a list of suggestions:
ws_js_import_quick_fix_multiple_choices.png

To add ES6 import statements on code completion

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click General under editor, and then click Auto Import. The Auto Import page opens.
  2. In the TypeScript/JavaScript area, select the Add ES6 imports on code completion checkbox.

Running JavaScript in browser

  1. In the editor, open the HTML file with the JavaScript reference. This HTML file does not necessarily have to be the one that implements the starting page of the application.
  2. Do one of the following:
    • Choose View | Open in Browser on the main menu or press Alt+F2. Then select the desired browser from the pop-up menu.
    • Hover your mouse pointer over the code to show the browser icons bar: browserIcons Click the icon that indicates the desired browser.

Debugging JavaScript

PyCharm provides a built-in debugger for your client-side JavaScript code that works with Chrome.
You can also debug your client-side JavaScript in Firefox, version 36 and higher. However it is strongly recommended that you use Chrome or any other browser of the Chrome family. With PyCharm, you can debug JavaScript applications running on the built-in server, on an external server, or on a remote server. For details, see Debugging JavaScript in Chrome and Debugging JavaScript in Firefox.

Last modified: 17 September 2018