PhpStorm 6.0.1 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:

Installing and configuring a TypeScript transpiler
  1. Download and install the Node.js framework. The TypeScript transpiler is started through Node.js and the Node Package Manager (npm) is also the easiest way to download the 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. 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.

  3. Download and install the TypeScript transpiler. The easiest way is to use the Node Package Manager (npm), which is a part of Node.js.
    1. Switch to the directory where the Node Package Manager (npm) is stored or define a path variable for it so it is available from any folder.
    2. Type the following command at the command line prompt: 
      npm install typescript

      Note

      To run the Node Package Manager (npm) in the global mode, use the --global or -g key. For more details on Node Package Manager (npm) operation modes, see npm documentation.

    The tool is installed under Node.js so Node.js, which is required for starting the tool, will be specified in the path to it. For more information about installing the TypeScript transpiler, see https://npmjs.org/package/typescript.

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 and 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+InsertControl N or Control EnterControl N or Control EnterMeta 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 tsc.cmd file. 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, Shortcut Missing) 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 text box of the New Watcher dialog. Based on this setting, PhpStorm detects 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: