PyCharm 2018.1 Help


PyCharm integrates with Angular also known as Angular 2. This platform makes it easy to build web, mobile, or desktop applications.

Before you start

  1. Install Node.js and configure it as a local Node.js interpreter.
  2. Install and enable the NodeJS repository plugin on the Plugins page as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

Creating a new Angular application

You can use the angular-cli package or create an empty PyCharm project and install Angular in it.

Angular CLI is the recommended way to start building a new Angular application. Angular CLI should be installed globally so it can be used in any PyCharm project.

To install Angular CLI globally

  • Open the built-in PyCharm Terminal (Alt+F12) and type npm install -g @angular/cli at the command prompt.

To create an 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 Angular CLI.
  3. In the right-hand pane:
    1. Specify the path to the folder where the project-related files will be stored.
    2. In the Node Interpreter field, specify the Node.js interpreter to use. Choose a configured interpreter from the drop-down list or choose Add to configure a new one
    3. In the Angular CLI field, specify the path to the angular-cli package.
  4. When you click Create, PyCharm generates an Angular-specific project with all the required configuration files.

To create an empty PyCharm project

  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 Empty Project.
  3. Specify the path to the folder where the project-related files will be stored.
  4. When you click Create, PyCharm creates and opens an empty project.

To install Angular in an empty project

  1. Open the empty project where you will use Angular.
  2. Open the embedded Terminal (View | Tool Windows | Terminal) and type npm install @angular/core at the command prompt. That will install the core Angular package with the critical runtime parts of the framework. You may also need to install other packages that are parts of Angular, see the list of packages.

Starting with an existing Angular application

To continue developing an existing Angular application, open it in PyCharm and download the required 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.

To download the dependencies

  • Click Run 'npm install' in the pop-up window:

Generating Angular structures

In an Angular CLI project, you can have specific structures generated automatically.

  1. On the main menu, choose File | New | Angular CLI.
  2. In the pop-up list that opens, click the relevant type of structure.
  3. In the dialog box that opens, specify the name of the structure to be generated and the path to it relative to the src/app folder of your project. If you want to generate a structure in a separate folder, create this folder first. This does not apply to components, which are by default generated in separate folders unless the --flat option is specified.

    If necessary, specify additional options, for example, --flat to have a new component generated directly in the specified location without creating a separate folder.

Using Angular language service

PyCharm integrates with the Angular language service developed by the Angular team to improve code analysis and completion for Angular-TypeScript projects. Note that the Angular language service works only with the projects that use Angular 2.3.1 or higher and TypeScript version compatible with it. Also make sure you have a tsconfig.json file in your project.

To install the @angular/language-service package

  1. Open the Terminal tool window (View | Tool Windows | Terminal or Alt+F12).
  2. Change the current folder to the project root and at the command prompt run npm install @angular/language-service –save-dev.

The Angular language service is activated by default so PyCharm starts it automatically together with the TypeScript service and shows all the errors and warnings in your TypeScript and HTML files both in the editor and in the TypeScript Tool Window.

To toggle the status of the service

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click Typescript under Languages and Frameworks. The TypeScript page opens.
  2. Select the TypeScript Language Service checkbox and then select or clear the Angular Language Service checkbox.

Using Angular Material Design components

PyCharm recognizes Angular Material components and attributes and provides coding assistance for them:

  • Completion for components
  • Completion for attributes
  • Navigation between a component or an attribute and its declaration (Ctrl+B or Go To | Declaration on the context menu).

To install Angular Material

Last modified: 23 July 2018

See Also