PhpStorm 2017.3 Help

Sass and SCSS in Compass Projects

PhpStorm supports development in projects structured in compliance with the Compass framework. This framework uses Sass and SCSS extensions of CSS.

Preparing for Compass development

The Compass framework is installed through the Ruby Gem manager, therefore you need to install Ruby first.

  1. Download and install Ruby.
  2. Specify a path variable for the folder where the Ruby executable file and the gem.bat file are stored. This lets you launch Ruby and Gem Manager from any folder and ensures that Ruby is successfully launched during compilation.
  3. Install and enable the Sass Support plugin. The plugin is not bundled with PhpStorm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
  4. Install Compass.
    1. The installation is performed in the command line mode. To start the built-in Terminal, hover your mouse pointer over show tool window bars in the lower left corner of the IDE, then choose Terminal from the menu (see Working with Embedded Local Terminal for details).
    2. Type the following command at the command prompt:
      gem install compass

      The tool is installed to the folder where Ruby executable file and the gem.bat file are stored.

Setting up a Compass project

You can have a project set up according to the Compass requirements in two ways: create a new Compass project or create an empty project and introduce a Compass-specific structure in it. In either case, a project is set up through command line commands. Of course, you can set up a Compass project externally and then open it in PhpStorm.

During project set-up, a conf.rb configuration file is generated. You will need to specify the location of this file when integrating Compass with PhpStorm.

  • To set up the Compass-specific structure in an existing project:
    1. Open the desired project in PhpStorm.
    2. Open the built-in Terminal by hovering your mouse pointer over show tool window bars in the lower left corner of PhpStorm and choosing Terminal from the menu.
    3. At the command prompt, type:
      compass init
  • To create a Compass project from scratch:
    1. Open the desired project in PhpStorm.
    2. Open the built-in Terminal by hovering your mouse pointer over show tool window bars in the lower left corner of PhpStorm and choosing Terminal from the menu.
    3. Switch to the folder that will be the parent for the new project folder. Type the following command:
      cd <parent folder name>
    4. At the command prompt, type:
      compass create <the name of the project to be created>

Integrating Compass with PhpStorm

To develop a Compass-specific project in PhpStorm, you need to specify the Compass executable file compass and the project configuration file config.rb. You can do it either through the Compass Support page of the Settings dialog box or on the fly using an intention action that opens the Compass Support dialog box.

  1. Open the Compass page or dialog box by doing one of the following:
    • Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing File | Settings for Windows and Linux or PhpStorm | Preferences for macOS, and click Compass under Languages & Frameworks.
      1. In a .sass or .scss file, type the following import statement:
        @import 'compass'
      2. Click the red bulb icon or press Alt+Enter. Then choose Configure Compass from the suggestion list.
      The Compass Support dialog box opens.
  2. To activate Compass support, select the Enable Compass support checkbox.
  3. In the Compass executable file text box, specify the location of the compass executable file under the Ruby installation. Type the path manually, for example, C:\Ruby200-x64\bin\compass, or choose it from the drop-down list, or click the Browse button browseButton and choose the location of the compass file in the dialog box that opens.
  4. In the Config path field, specify the location of the project Compass configuration file config.rb. Type the path manually, for example, C:\my_projects\\compass_project\config.rb, or choose it from the drop-down list, or click the Browse button browseButton and choose the location of the compass file int he dialog box that opens.

    The Compass configuration file config.rb is generated during project set-up through compass create or compass init commands.

Creating a Compass Sass or a Compass SCSS compiler

Sass and SCSS are not processed by browsers that work with CSS code. Therefore to be executed, Sass or SCSS code has to be translated into CSS. This operation is referred to as compilation and the tools that perform it are called compilers.

PhpStorm integrates with a compiler that translates Sass and SCSS code from a Compass project without changing the Compass-specific project structure. To use the compiler in PhpStorm, you need to configure it as a File Watcher. For each supported compiler, PhpStorm provides a predefined File Watcher template. To run a compiler in your project, create a project-specific File Watcher based on the relevant template.

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. See Enabling and Disabling Plugins for details.
  2. To start creating a File Watcher, open the Settings/Preferences dialog box by choosing File | Settings for Windows and Linux or PhpStorm | Preferences for macOS 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.
  3. Click the Add button new.png or press Alt+Insert and choose the compass sass or compass scss predefined template from the pop-up list.
  4. In the Program text box, specify the path to the executable file:
    • compass.bat for Windows
    • compass for Unix and macOS
    Type the path manually or click the Browse button browseButton.png and choose the file location in the dialog box that opens.
  5. In the Arguments text box, type one of the following depending on the operating system used:
    • For macOS:
      • compile $ProjectFileDir$ to process an entire directory
      • compile $ProjectFileDir$ $FilePath$ to process a single file
    • For Windows:
      • compile $UnixSeparators($ProjectFileDir$)$ to process an entire directory
      • compile $UnixSeparators($FilePath$)$ to process a single file
    • For Linux (Ubuntu):
      • compile $ProjectFileDir$ to process an entire directory
      • compile $ProjectFileDir$ $FilePath$ to process a single file
  6. Proceed as described on page Using File Watchers.

Running a Compass Sass or Compass SCSS compiler

When you open a Sass or SCSS 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 Auto-save edited files to trigger the watcher checkbox is selected, the File Watcher is invoked as soon as any changes are made to the source code.
  • If the Auto-save edited files to trigger the watcher checkbox is cleared, the File Watcher is started upon save (File | Save All, Ctrl+S) 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 or SCSS file and the extension css. The location of the generated files is defined in the Output paths to refresh 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.

Last modified: 29 March 2018

See Also