PhpStorm 9.0.0 Help

Transpiling TypeScript to JavaScript

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.

In addition to this, transpilation also can involve generation of 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.

Transpiling TypeScript using the Built-in Compiler

Configuring and Activating the Built-in TypeScript Compiler

Open the Settings dialog box
by choosing File | Settings
or pressing Ctrl+Alt+S
and
click Typescript under Languages & Frameworks.

On the TypeScript Compiler page that opens,
select the Enable TypeScript Compiler check box to activate the compiler.
When the check box is selected, the fields below on the page become active
and you can configure the behaviour of the compiler.

In the other fields of the TypeScript Compiler page, specify the following:

In the Node interpreter field,
specify the location of the Node.js executable file. In most cases, PhpStorm
detects the Node.js executable and fills in the field automatically.

In the Compiler version area, PhpStorm displays the default bundled version of the built-in compiler.

Alternatively, click the Browse button and configure a custom scope in the Scopes dialog box that opens.
For more details on scopes, see the pages Scopes and Scopes dialog.

In the Command line options field,
specify the command line options to be passed to the compiler.
See the list of acceptable options at TSC arguments.
Note that, the -w or --watch option (Watch input files) is irrelevant.

Select the Compile main file only check box
to have PhpStorm compile only a specific file and the files that are referenced from it and ignore all the other files in the project.
This may be helpful if you have a dedicated main.ts file which only references other files.

Select the Use output path check box
to have the built-in compiler store the generated JavaScript files and source map in a custom folder.
Specify the path to this folder explicitly or use one of the listed available macros in the format: $<macros_name>$.
The available macros are:

FileDir: the path to the folder where the file is stored.

FileRelativeDir: the path to the file directory relative to the project root.

FileDirRelativeToProjectRoot:
the path to the file directory relative to the project root.

FileDirRelativeToSourcePath:
the path to the file relative to the the source folder under the content root to the file belongs.

Select the Generate source maps check box
to generate 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.

To have the compiler "wake up" upon any change to a TypeScript file, select the Track changes check box.

When this check box is cleared, the built-in compiler ignores changes to TypeScript files. To re-activate the compiler,
open the TypeScript Compiler Tool Window (View | Tool Windows | TypeScript Compiler),
and click the Compile All button on the toolbar.

If you have not opened the TypeScript Compiler Tool Window yet and it is not available from the View menu,
choose Help | Find Action, then find and launch the TypeScript Compile All action from the list.

Transpiling the Code

Alternatively, use the buttons on the pane which PhpStorm displays when you open a TypeScript file.

To enable an already configured compiler, click Enable.

To configure a compiler, click Configure and specify the settings on the TypeScript Compiler page that opens.

To leave the compiler disabled and suppress showing the pane in the future, click Dismiss,
whereupon the compiler can be later activated only on the TypeScript Compiler page.

View the errors detected during compilation, compile separate files and the entire project in the TypeScript Compiler Tool Window.
If you have configured the compiler to track changes, which is the default behaviour, the tool window opens automatically
as soon as you start editing a TypeScript file.

If tracking changes is disabled and you have closed the tool window, to re-open it choose View | Tool WIndows | TypeScript Compiler.

Click the Compile Current File toolbar button
to run the compiler against the entire file opened in the active editor tab.
This approach is helpful if you do not want the compiler to wake up on any change as you edit your code
and for this purpose the Track Changes check box
on the TypeScript page of the Settings dialog box is cleared.

If you click this button from the Project Errors pane, after compilation PhpStorm switches to the Current Errors pane.

Click the Compile All toolbar button
to run the compiler against all the TypeScript files in the current project.
If you click this button from the Current Errors pane, after compilation PhpStorm switches to the Project Errors pane.

To clear the contents of the current pane, click the Clear All toolbar button .

To navigate to the fragment of code where an error occurred during compilation, select the error message in question
and choose Jump to Source on the context menu of the selection.

The compiler stores the generated output in a separate file. The JavaScript file has the name of the source TypeScript file and the extension js,
the source map file has the name of the source TypeScript file and the js.map extension.
In the Project Tree, the files are shown under the source TypeScript file
which is now displayed as a node.

Transpiling TypeScript using a File Watcher

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.

Before You Start

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.

If you are going to use the command line mode, make sure the following paths are added to the PATH variable:

The path to the parent folder of the Node.js executable file.

The path to the npm folder.

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

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:

Launch the embedded Terminal
by hovering your mouse pointer over in the lower left corner of PhpStorm and choosing Terminal from the menu
(see Working with Embedded Local Terminal for details).

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.

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.

Run NPM from PhpStorm using the Node.js and NPM page of the Settings dialog box.

Open the Settings dialog box
by choosing File | Settings
or pressing Ctrl+Alt+S
and
click Node.js and NPM under Languages&Frameworks.

On the packagePage page that opens, the Packages area shows all the engineDependent packages
that are currently installed on your computer, both at the global and at the project level.
Click .

In the Available Packages dialog box that opens, select the required package to install.

Select the Options check box and type -g in the text box next to it.

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:

Run the installation from the command line:

Launch the embedded Terminal
by hovering your mouse pointer over in the lower left corner of PhpStorm and choosing Terminal from the menu
(see Working with Embedded Local Terminal for details).

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.

Open the Settings dialog box by choosing File | Settings
or pressing Ctrl+Alt+S, see Accessing Settings for details. Then click Node.js and NPM under the Languages & Frameworks node.

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 .

In the Available Packages dialog box that opens, select the required package.

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.

To start creating a File Watcher, open the Settings dialog box by choosing
File | Settings
on the main menu, and then click File Watchers under the Tools node.
The File Watchers page that opens, shows the list of File Watchers that are already configured in the project.

Click the Add button or press Alt+Insert
and choose the TypeScript predefined template from the pop-up list.

In the Program text box, specify the path to the executable file tsc.cmd or tsc in the node_modules\.bin folder.

If you installed TypeScript in the current project, the file is stored in the node_modules\.bin folder under the project root.

In case of global installation, the executable file is stored in the node_modules\.bin folder in the user home.

Type the path manually or click the Browse button
and choose the file location in the dialog box that opens.

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+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.