Using AngularJS
PyCharm provides integration with the AngularJS framework also known as Angular 1. This support involves:
- AngularJS-aware code completion for
ng
directives (also including custom directives), controller and application names, and code insights for data bindings inside curly-brace expressions{{}}
. - AngularJS-specific navigation:
- A collection of AngularJS built-in live templates.
- Quick documentation look-up by pressing Ctrl+Q, see Viewing Inline Documentation for details.
- AngularJS ui-router diagram.
Before you start
- Install the Node.js runtime environment.
- Make sure the AngularJS plugin is installed and enabled. The AngularJS plugin is bundled with PyCharm and activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins. The NodeJS plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
Introduction
You can get AngularJS support in a PyCharm project in the following ways:
- Open an existing project with AngularJS sources.
- Generate an AngularJS-specific project stub from the PyCharm Welcome Screen. PyCharm generates the AngularJS-specific project structure with all the required configuration files based on the AngularJS seed project
- Create a Pure Python project, and then install AngularJS in it either manually, by downloading the AngularJS framework, or using the Bower package manager. If you choose manual installation, you will need to configure AngularJS as a PyCharm JavaScript library. If you use Bower, PyCharm will do this configuration automatically, without any steps from your side.
Creating an AngularJS project using a seed project
- Choose on the main menu or click the Create New Project button on the Welcome screen. The New Project Dialog dialog box opens.
- In the left-hand pane, choose AngularJS.
- In the right-hand pane, in the Location text box, specify the path to the project folder where the project-related files will be stored.
- When you click Create, PyCharm generates the AngularJS-specific project structure with all the required configuration files based on the AngularJS seed project
- Download the AngularJS dependencies that contain the AngularJS code and the tools that support development and testing: launch the embedded Terminal ( or by hovering your mouse pointer over in the lower left corner of PyCharm and choosing Terminal from the menu and type
npm install
at the command line prompt. Learn more about the installation of dependencies in the Install Dependencies section of thereadme.md
file.
Configuring AngularJS support in a project
If you already have AngularJS 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 an External JavaScript library.
If you do not have any previously downloaded AngularJS sources, , and then install AngularJS in it either manually, by downloading the AngularJS framework, or using the Bower package manager.
Creating an empty PyCharm project
- Choose on the main menu or click the Create New Project button on the Welcome screen. The New Project Dialog dialog box opens.
- In the left-hand pane, choose Pure Python project.
- In the Location text box, specify the path to the project folder where the project-related files will be stored.
- When you click Create, PyCharm creates and opens a pure Python project.
Configuring AngularJS coding assistance in an empty project manually
- Download the AngularJS framework at http://angularjs.org/.
- Open the pure Python project where you will use AngularJS.
- Configure AngularJS as a PyCharm JavaScript library, to let PyCharm recognize AngularJS-specific structures and provide full coding assistance:
- Open the Settings/Preferences dialog box, and click JavaScript Libraries.
- In the Libraries area, click the Add button.
- In the New Library dialog box that opens, specify the name of the library.
- Click the Add button next to the list of library files and choose Attach Files or Attach Directory on the context menu, depending of whether you need separate files or an entire folder.
- Select the
Angular.js
orAngular.min.js
, or an entire directory in the dialog box that opens. PyCharm returns to the New Library dialog box where the Name read-only field shows the name of the selected files or folder. - In the Type field, specify which version you have downloaded and are going to add.
- If you added
Angular.js
, choose Debug. This version is helpful in the development environment, especially for debugging. - If you added the minified
Angular.min.js
, choose Release. This version is helpful in the production environment because the file size is significantly smaller.
- If you added
Installing AngularJS in an empty project through Bower
- Open the pure Python project where you will use AngularJS.
- Download, install, and configure Node.js as described in Configuring Node.js Interpreters.
- Install Bower as described in Using Bower Package Manager.
- Launch the embedded Terminal ( or by hovering your mouse pointer over in the lower left corner of PyCharm and choosing Terminal from the menu and type
bower install angular
at the command line prompt to install the package in the current project.
You can also install the angular
package on the Bower page of the Settings/Preferences dialog as described in Installing and Removing Bower Packages.
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 on 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 on the context menu.