- Download and install the Node.js framework. The CoffeeScript 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
- 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.
Download and install the CoffeeScript transpiler. The easiest way is to use the Node Package Manager (npm), which is a part of Node.js.
- 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.
Do one of the following depending on your further plans:
npm install coffee-script
otherwise your breakpoints will not be recognised and processed correctly. Source maps are generated by the coffee-script-redux transpiling tool.
Type the following command at the command line prompt:
npm install coffee-script-redux
In either case, 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.
The executable files of both transpilers have the same name coffee.cmd (though luckily differ in contents). Therefore to have both tools available, you need to rename the executable of the one that was downloaded first or move it to another folder under Node.js.
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 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.
Click the Add button or press Alt+InsertAlt+Insert
and choose the predefined template from the pop-up list.
- If you are going to debug your code, choose CoffeeScript Source Map. As a result, the source maps will be created.
- In the Program text box, specify the path to the coffee.cmd file. Type the path manually or click the Browse button and choose the file location in the dialog box that opens.
- Proceed as described on page Using File Watchers.
Transpiling the CoffeeScript code
When you open a CoffeeScript 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 ( , ) 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 CoffeeScript 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 .coffee file which is now displayed as a node.
PhpStorm can perform static analyses of your CoffeeScript code without actually running a transpiler and display the predicted transpilation output in the dedicated read-only viewer.
- Open the desired CoffeeScript file in the editor, and right-click the editor background.