PhpStorm
 
2022.3
Shortcuts: Windows
Get PhpStorm
  1. Web Technologies
  2. Style sheets
  3. Sass and SCSS in Compass applications

Sass and SCSS in Compass applications

Last modified: 06 October 2022

Required plugins:

Compass -  Install the plugin on the Settings | Plugins page, tab Marketplace.

File Watchers -  The plugin is bundled with PhpStorm and enabled by default.

warning

Since PhpStorm 2020.1, Compass support in the IDE has been deprecated.

However, Compass support is still available through the Compass plugin, which can be installed on the Settings | Plugins page as described in Installing plugins from JetBrains repository.

With Compass support in PhpStorm, your Sass or SCSS Style Sheets in Compass applications are compiled into CSS automatically.

Before you start

Installing Compass

Creating a new Compass application

If you have no Compass application yet, you can create it or add Compass support to an empty PhpStorm project. In either case, a conf.rb configuration file is generated.

Activate Compass-aware support in your application

  1. Open a .sass or .scss file, click the red bulb next to the @import 'compass' statement or press Alt+Enter, and then choose Configure Compass from the suggestion list.

    tip

    Alternatively, in the Settings dialog (Ctrl+Alt+S), go to Languages & Frameworks | Style Sheets | Compass.

  2. Select the Enable Compass support checkbox, and specify the paths to the Compass executable file and to the conf.rb configuration file.

Starting with an existing Compass application

Open the application sources that are already on your machine

  • Click Open on the Welcome screen or select File | Open Directory from the main menu. In the dialog that opens, select the folder where your sources are stored.

Check out the application sources from your version control

  1. Click Get from VCS on the Welcome screen.

    Alternatively, select File | New | Project from Version Control or Git | Clone… from the main menu.

    Instead of Git in the main menu, you may see any other Version Control System that is associated with your project. For example, Mercurial or Perforce.

  2. In the dialog that opens, select your version control system from the list and specify the repository to check out the application sources from. See Check out a project (clone) for details.

Compiling Sass and SCSS

To compile your code automatically, you need to configure a Compass Sass or Compass SCSS File Watcher which will track changes to your files and run the compiler.

tip

You can also use the compiler from the command line or configure it as a third-party tool, see Configuring Third-Party Tools for details.

When you open a 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 popup 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 the compiler 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).

Learn more from File Watchers.

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 field of the New Watcher dialog. However, in the Project Tree, they are shown under the source file which is now displayed as a node.

Create a File Watcher

  1. In the Settings dialog (Ctrl+Alt+S), click File Watchers under Tools. The File Watchers page that opens shows the list of already configured File Watchers.

  2. Click Add button or press Alt+Insert. Depending on the tool you are going to use, choose the compass sass or compass scss predefined template from the list. The New Watcher dialog opens.

  3. In the Program field, specify the path to the executable file:

    • compass.bat for Windows

    • compass for Unix and macOS

  4. In the Arguments field, type one of the following depending on the operating system used:

    • compile $UnixSeparators($ProjectFileDir$)$ to process an entire directory

    • compile $UnixSeparators($FilePath$)$ to process a single file

  5. Proceed as described in File Watchers.

See also

Procedures

Reference

External Links