Sass and SCSS in Compass applications
Before you start
Install and enable the File Watchers plugin on the Plugins page as described in Installing plugins from repository.
Installing Compass
Starting with a Compass application in RubyMine
If you have no Compass application yet, you can create it or add Compass support to an existing RubyMine project. In either case, a conf.rb configuration file is generated.
Create a new Compass application
Add Compass to an existing RubyMine project
Open the application sources that are already on your machine
Check out the application sources from your version control
-
Click Get from Version Control on the Welcome screen or select from the main menu.
-
In the invoked dialog, select your version control system from the list and specify the repository to check out the application sources from.
Activate Compass-aware support in your application
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.Select the Enable Compass support checkbox, and specify the paths to the Compass executable file and to the conf.rb configuration file.
Compiling Sass and SCSS
To compile your code on the fly, you need to configure the compiler as a RubyMine File Watcher.
Create a File Watcher
In the Settings/Preferences dialog Ctrl+Alt+S, click File Watchers under Tools. The File Watchers page that opens shows the list of already configured File Watchers.
Click 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.
-
In the Program field, specify the path to the executable file:
compass.bat for Windows
compass for Unix and macOS
-
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
-
compile $ProjectFileDir$
to process an entire directory -
compile $ProjectFileDir$ $FilePath$
to process a single file
-
compile $ProjectFileDir$
to process an entire directory -
compile $ProjectFileDir$ $FilePath$
to process a single file
-
-
Proceed as described in File Watchers.
Compiling the code
When you open a file, RubyMine checks whether an applicable file watcher is available in the current project. If such file watcher is configured but disabled, RubyMine 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, RubyMine 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 ( , Ctrl+S) or when you move focus from RubyMine (upon frame deactivation).
RubyMine 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.