PhpStorm 8.0.0 Web Help

TypeScript code is not processed by browsers that work with JavaScript code. Therefore to be executed, TypeScript code has to be translated into JavaScript. This operation is referred to as transpilation and the tools that perform it are called transpilers.

PhpStorm supports integration with the typescript tool. The TypeScript transpiler translates TypeScript code into JavaScript and creates source maps that set correspondence between lines in your TypeScript code and in the generated JavaScript code, otherwise your breakpoints will not be recognised and processed correctly.

In PhpStorm, transpiler configurations are called File Watchers. For each supported transpiler, PhpStorm provides a predefined File Watcher template. Predefined File Watcher templates are available at the PhpStorm level. To run a transpiler against your project files, you need to create a project-specific File Watcher based on the relevant template, at least, specify the path to the transpiler to use on your machine.

On this page:

Prerequisites
  1. Download and install Node.js. The framework is required for two reasons:
    • The TypeScript transpiler is started through Node.js.
    • NPM, which is a part of the framework, is also the easiest way to download the TypeScript transpiler.

    For details on using Node.js in PhpStorm, see the section Node.js

    Tip

    Alternatively, you can define Node.js as an external tool, as described in the section Configuring third-party tools. This approach is helpful, when you need facilities that are missing in the plugin, for example, the possibility to pass certain parameters as wildcards.

  2. If you are going to use the command line mode, make sure the following paths are added to the PATH variable:
    1. The path to the parent folder of the Node.js executable file.
    2. The path to the npm folder.

    This enables you to launch the TypeScript transpiler and npm from any folder.

  3. Install and enable the NodeJS repository plugin.

    The plugin is not bundled with PhpStorm, but it is available from the PhpStorm plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your PhpStorm projects. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

  4. Make sure the File Watchers plugin is enabled. The plugin is bundled with PhpStorm and activated by default. If it is not, enable the plugin. See Enabling and Disabling Plugins for details.

Installing the TypeScript transpiler

The easiest way to install the TypeScript transpiler is to use the Node Package Manager (npm), which is a part of Node.js.

Depending on the desired location of the TypeScript transpiler executable file, choose one of the following methods:

  • Install the transpiler globally at the PhpStorm level so it can be used in any PhpStorm project.
  • Install the transpiler in a specific project and thus restrict its use to this project.
  • Install the transpiler in a project as a development dependency.

In either installation mode, make sure that the parent folder of the TypeScript transpiler is added to the PATH variable. This enables you to launch the transpiler from any folder.

PhpStorm provides user interface both for global and project installation as well as supports installation through the command line.

Installing the TypeScript transpiler globally

Global installation makes the transpiler available at the PhpStorm level so it can be used in any PhpStorm project. Moreover, during installation the parent folder of the transpiler is automatically added to the PATH variable, which enables you to launch the transpiler from any folder. To install the transpiler globally, do one of the following:

  • Run the installation from the command line in the global mode:
    1. Switch to the directory where NPM is stored or define a PATH variable for it so it is available from any folder, see Installing NodeJs.
    2. Type the following command at the command line prompt:
      npm install -g typescript 
                                  

      The -g key makes the transpiler run in the global mode. Because the installation is performed through NPM, the TypeScript transpiler is installed in the npm folder. Make sure this parent folder is added to the PATH variable. This enables you to launch the transpiler from any folder.

      For more details on the NPM operation modes, see npm documentation. For more information about installing the TypeScript transpiler, see https://npmjs.org/package/typescript.

  • Run NPM from PhpStorm using the Node.js and NPM page of the Settings dialog box.
    1. Open the project settings and then click Node.js and NPM.
    2. On the Node.js and NPM page that opens, the Packages area shows all the Node.js-dependent packages that are currently installed on your computer, both at the global and at the project level. Click add.
    3. In the Available Packages dialog box that opens, select the typescript package.
    4. Select the Options check box and type -g in the text box next to it.
    5. Optionally specify the product version and click Install Package to start installation.
Installing the TypeScript transpiler in a project

Installing the transpiler in a specific project restricts its use to this project. To run project installation, do one of the following:

  • In the command line mode, switch to the project root folder and type the following command at the command line prompt:
    npm install typescript 
                    
  • Run NPM from PhpStorm using the Node.js and NPM page of the Settings dialog box.
    1. Open the project settings and click Node.js and NPM.
    2. On the Node.js and NPM page that opens, the Packages area shows all the Node.js-dependent packages that are currently installed on your computer, both at the global and at the project level. Click add.
    3. In the Available Packages dialog box that opens, select the typescript package.
    4. Optionally specify the product version and click Install Package to start installation.

Project level installation is helpful and reliable in template-based projects of the type Node Boilerplate or Node.js Express, which already have the node_modules folder. The latter is important because NPM installs the TypeScript transpiler in a node_modules folder. If your project already contains such folder, the TypeScript transpiler is installed there.

Projects of other types or empty projects may not have a node_modules folder. In this case npm goes upwards in the folder tree and installs the TypeScript transpiler in the first detected node_modules folder. Keep in mind that this detected node_modules folder may be outside your current project root.

Finally, if no node_modules folder is detected in the folder tree either, the folder is created right under the current project root and the TypeScript transpiler is installed there.

In either case, make sure that the parent folder of the TypeScript transpiler is added to the PATH variable. This enables you to launch the transpiler from any folder.

Creating a File Watcher

PhpStorm provides a common procedure and user interface for creating File Watchers of all types. The only difference is in the predefined templates you choose in each case.

  1. To start creating a File Watcher, open the Project Settings by choosing File | Settings on the main menu, and then click File Watchers. The File Watchers page that opens, shows the list of File Watchers that are already configured in the project.
  2. Click the Add button new.png or press Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterCommand N or Control EnterCommand N or Control Enter and choose the TypeScript predefined template from the pop-up list.
  3. In the Program text box, specify the path to the executable file (e.g. tsc.cmd). Type the path manually or click the Browse button browseButton.png and choose the file location in the dialog box that opens.
  4. Proceed as described on page Using File Watchers.

Transpiling the code

When you open a TypeScript file, PhpStorm checks whether an applicable file watcher is available in the current project. If such file watcher is configured but disabled, PhpStorm displays a pop-up window that informs you about the configured file watcher and suggests to enable it.

If an applicable file watcher is configured and enabled in the current project, PhpStorm starts it automatically upon the event specified in the New Watcher dialog.

  • If the Immediate file synchronization check box is selected, the File Watcher is invoked as soon as any changes are made to the source code.
  • If the Immediate file synchronization check box is cleared, the File Watcher is started upon save (File | Save All, Ctrl+SCtrl+SCtrl+SCtrl+SCtrl+X, Ctrl+SCtrl+SCtrl+S or Ctrl+Shift+SCtrl+SCommand SCommand SCommand S) or when you move focus from PhpStorm (upon frame deactivation).

The transpiler stores the generated output in a separate file. The file has the name of the source TypeScript file and the extension js or js.map depending on the transpiler type. The location of the generated files is defined in the Output paths to refresh text box of the New Watcher dialog. Based on this setting, PhpStorm detects the transpiler output. However, in the Project Tree, they are shown under the source .ts file which is now displayed as a node.

See Also

Procedures:

Reference:

Web Resources: