PyCharm 2019.2 Help

AngularJS

AngularJS also known as Angular 1 is a framework for developing single page web applications. PyCharm suggests AngularJS-aware completion options for predefined and custom ng directives and for controller and application names, as well as code insights for data bindings inside curly-brace expressions {{}}. You can use built-in AngularJS live templates and navigate between the name of a controller in HTML and its definition in JavaScript or between ngView or &routeProvider and the template. For AngularJS entities, use the Go To Symbol navigation.

Creating a new AngularJS application

You can use the AngularJS seed project or create an empty PyCharm project and install AngularJS in it either manually, by downloading the AngularJS framework, or with the Bower package manager.

To create an application using the seed project

  1. Select File | New | Project from the main menu or click Create New Project on the Welcome screen. The New Project dialog opens.

  2. In the left-hand pane, choose AngularJS.

  3. In the right-hand pane, specify the path to the folder where the project-related files will be stored.

  4. When you click Create, PyCharm generates the AngularJS-specific project structure with all the required configuration files based on the AngularJS seed project

To download AngularJS dependencies, do one of the following:

  • In the embedded Terminal Alt+F12, type:

    npm install

  • Select Run 'npm install' from the context menu of the package.json file in your project root.

To create an empty PyCharm project

  1. Select File | New | Project from the main menu or click Create New Project on the Welcome screen. The New Project dialog 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 and configure AngularJS in an empty project manually

  1. Download the AngularJS framework at http://angularjs.org/.

  2. Open the pure Python project where you will use AngularJS.

  3. Configure AngularJS as a PyCharm JavaScript library, to let PyCharm recognize AngularJS-specific structures and provide full coding assistance:

    1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Languages and Frameworks | JavaScript | Libraries. The JavaScript Libraries page opens.

    2. In the Libraries area, click the Add button.

    3. In the New Library dialog that opens, specify the name of the library.

    4. Click the Add button next to the list of library files and select Attach Files or Attach Directory from the context menu, depending of whether you need separate files or an entire folder.

    5. Select the Angular.js, or Angular.min.js, or an entire directory in the dialog that opens. PyCharm returns to the New Library dialog where the Name read-only field shows the name of the selected files or folder.

    6. In the Type field, specify which version you have downloaded and are going to add.

      • If you added Angular.js, select Debug. This version is helpful in the development environment, especially for debugging.

      • If you added the minified Angular.min.js, select Release. This version is helpful in the production environment because the file size is significantly smaller.

    Learn more from Configuring JavaScript Libraries.

To install AngularJS in an empty project through Bower

  1. Open the pure Python project where you will use AngularJS.

  2. Install Bower as described in Bower.

  3. In the embedded Terminal Alt+F12, type bower install angular to install the package as a project dependency.

Starting with an existing AngularJS application

If you already have Angular sources in your project (for example, in the bower_components folder), just open your project and start working. If these sources are excluded from project, then you only need to configure AngularJS as a JavaScript library.

To check out the application sources from your version control

  1. Click Check out from Version Control on the Welcome screen or select VCS | Check out from Version Control from 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 popup:

Opening an Angular application and downloading the dependencies from package.json

Using AngularJS Router state diagrams

You can see a diagram illustrating the relations between views, states, and templates in AngularJS applications that use ui-router.

To generate and view a diagram

Open the desired file in the editor, and then choose Diagrams | Show AngularJS ui-router State Diagram from the context menu. PyCharm generates a diagram and shows it in a separate editor tab.

To navigate from an element in the diagram to the code that implements this element

Select it and choose Jump to Source from the context menu.

Last modified: 21 August 2019

See Also