PhpStorm 6.0.1 Web Help

SASS, LESS, and SCSS code is not processed by browsers that work with JavaScript code. Therefore to be executed, transpiledLanguage 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 transpiler tools that translate SASS, LESS, and SCSS code to CSS.

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:

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. 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.
  2. 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.
  3. Click the Add button new.png or press Alt+InsertAlt+Insert. Depending on the tool you are going to use, choose the appropriate predefined template from the pop-up list:
    • LESS
    • SASS
    • SCSS
  4. In the Program text box, specify the path to the compiler executable file or archive depending on the chosen predefined template.
    • lessc.cmd for LESS If you installed the tool through the Node Package Manager, PhpStorm locates the required file itself at <node.js_home>/node_modules/bin/lessc.cmd and fills in the field automatically. Otherwise, type the path manually or click the Browse button browseButton.png and choose the file location in the dialog box that opens.
    • sass.bat for SASS
    • scss.bat for SCSS

    If you installed the SASS and SCSS tools through Ruby, PhpStorm locates the required files itself at <ruby_home>/bin/sass.bat <ruby_home>/bin/scss.bat respectively and fills in the field automatically. Otherwise, type the path manually or click the Browse button browseButton.png and choose the file location in the dialog box that opens.

  5. 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, ) or when you move focus from PhpStorm (upon frame deactivation).

PhpStorm creates a separate file with the generated output. The file has the name of the source SASS, LESS, or SCSS file and the extension css. The location of the generated files is defined in the Output Paths text box of the New Watcher dialog. However, in the Project Tree, they are shown under the source file which is now displayed as a node.

See Also

Procedures:

Reference:

External Links:

Web Resources: