Sass and SCSS in Compass Applications
AppCode integrates with the Compass framework so your Sass or SCSS stylesheets in Compass applications are compiled into CSS on the fly.
Before you start
- Open the embedded Terminal ( or ⌥F12) and type
gem install compassat the command prompt. Compass is installed in the folder where Ruby executable file and the
gem.batfile are stored.
Starting with a Compass application in AppCode
If you have no Compass application yet, you can create it or add Compass support to an existing AppCode project. In either case, a conf.rb configuration file is generated.
To create a new Compass application
- Open the embedded Terminal ( or ⌥F12), and type
compass create <the name of the application to be created>at the command prompt.
To add Compass to en existing AppCode project
- Open the folder with the code where you want to use Compass (click Open on the Welcome screen or choose on the main menu). Learn more from Opening, Reopening and Closing Projects.
- Open the embedded Terminal ( or ⌥F12), and type:
cd <application folder> compass init
To open the application sources that are already on your machine
- Click Open on the Welcome screen or choose on the main menu. In the dialog that opens, select the folder where your sources are stored.
To check out the application sources from your version control
- Click Check out from Version Control on the Welcome screen or choose on the main menu.
- Select your version control system from the list.
- In the VCS-specific dialog that opens, type your credentials and the repository to check out the application sources from.
To activate Compass-aware support in your application
- Open the Compass page:
- In the Settings/Preferences dialog (⌘,), and click Stylesheets under Languages and Frameworks, and then click Compass.
.scssfile, click the red bulb next to the
@import 'compass'statement or press ⌥⏎, 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 AppCode File Watcher.
To create a File Watcher
- In the Settings/Preferences dialog (⌘,), and then click File Watchers under Tools. The File Watchers page that opens, shows the list of File Watchers that are already configured in the project.
- Click or press ⌘N. 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 text box, specify the path to the
Type the path manually or click Browse and choose the file location in the dialog box that opens.
Compiling the code
When you open a file, AppCode checks whether an applicable file watcher is available in the current project. If such file watcher is configured but disabled, AppCode 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, AppCode 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 ( , ⌘S) or when you move focus from AppCode (upon frame deactivation).
AppCode 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.