AppCode 2017.2 Help

Compiling Sass, Less, and SCSS to CSS

On this page:

Introduction

Sass, Less, and SCSS code is not processed by browsers that work with CSS code. Therefore to be executed, Sass, Less, 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.

AppCode integrates with compilers that translate Sass, Less, and SCSS code into CSS. To use integration in AppCode, you need to configure compiler as a File Watcher. For each supported compiler, AppCode provides a predefined File Watcher template. Predefined File Watcher templates are available at the AppCode level. To run a compiler in a project, create a project-specific File Watcher based on the relevant template.

Before you start

  1. Make sure the Less Support, Sass Support, and CSS Support plugins are activated. The plugins are activated by default. If the plugins are disabled, enable them on the Plugins page as described in Enabling and Disabling Plugins.
  2. Install and enable the NodeJS repository plugin as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
  3. Download and install the Node.js runtime environment.
  4. Configure the Node.js interpreter in AppCode:
    1. Open the AppCode Preferences by choosing AppCode | Preferences, and click Node.js and NPM under Languages & Frameworks.
    2. On the Node.js and NPM page that opens, specify the location of the desired Node.js interpreter.

Installing the Sass/SCSS compiler

  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.
  3. Type the following command at the command prompt:
    gem install sass

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

Installing the Less compiler

The easiest way to install the Less compiler is to use the Node Package Manager (npm), which is a part of Node.js. See Installing and Removing External Software Using Node Package Manager for details.

Depending on the desired location of the Less compiler executable file, choose one of the following methods:

  • Install the compiler globally at the AppCode level so it can be used in any AppCode project.
  • Install the compiler in a specific project and thus restrict its use to this project.
  • Install the compiler in a project as a development dependency.

In either installation mode, make sure that the parent folder of the Less compiler is added to the PATH variable. This enables you to launch the compiler from any folder.

AppCode provides user interface both for global and project installation as well as supports installation through the command line.

Installing the Less compiler globally

Global installation makes a compiler available at the AppCode level so it can be used in any AppCode project. Moreover, during installation the parent folder of the compiler is automatically added to the PATH variable, which enables you to launch the compiler from any folder.

  • Run the installation from the command line in the global mode:
    1. Open the embedded Terminal (View | Tool Windows | Terminal) and switch to the directory where NPM is stored or define a PATH variable for it so it is available from any folder, see Installing NodeJs.
    2. Type the following command at the command prompt:
      npm install -g less

      The -g key makes the compiler run in the global mode. Because the installation is performed through NPM, the Less compiler is installed in the npm folder. Make sure this parent folder is added to the PATH variable. This enables you to launch the compiler from any folder.

      For more details on the NPM operation modes, see npm documentation. For more information about installing the Less compiler, see https://npmjs.org/package/less.

  • Run NPM from AppCode using the Node.js and NPM page of the Preferences dialog box.
    1. Open the AppCode Preferences by choosing AppCode | Preferences, and click Node.js and NPM under Languages & Frameworks.
    2. On the Node.js and NPM page that opens, the Packages area shows all the Node.js-dependent packages that are currently installed on your computer, both at the global and at the project level. Click new.
    3. In the Available Packages dialog box that opens, select the required package to install.
    4. Select the Options checkbox and type -g in the text box next to it.
    5. Optionally specify the product version and click Install Package to start installation.

Installing the Less compiler in a project

Local installation in a specific project restricts the use of a compiler to this project.

  • Run the installation from the command line:
    1. Open the embedded Terminal (View | Tool Windows | Terminal) and switch to the project root folder.
    2. At the command prompt, type npm install less.

Project level installation is helpful and reliable in template-based projects of the type Node Boilerplate or Node.js Express, which already have the node_modules folder. The latter is important because NPM installs the Less compiler in a node_modules folder. If your project already contains such folder, the Less compiler is installed there.

Projects of other types or empty projects may not have a node_modules folder. In this case npm goes upwards in the folder tree and installs the Less compiler in the first detected node_modules folder. Keep in mind that this detected node_modules folder may be outside your current project root.

Finally, if no node_modules folder is detected in the folder tree either, the folder is created right under the current project root and the Less compiler is installed there.

In either case, make sure that the parent folder of the Less compiler is added to the PATH variable. This enables you to launch the compiler from any folder.

Creating a file watcher

AppCode 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. Install and enable the File Watchers repository plugin.

    The plugin is not bundled with AppCode, but it is available from the plugin repository. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

  2. To start creating a File Watcher, open the Settings/Preferences dialog box by choosing AppCode | Preferences on the main menu, and then click File Watchers under the Tools node. The that opens, shows the list of File Watchers that are already configured in the project.
  3. Click the Add button new.png or press N/A. 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, AppCode 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, AppCode 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.

Compiling the code

When you open a Less, Sass, or SCSS 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 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, N/A) 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, Less, 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: 13 December 2017
Referencing XML Schemas and DTDsCompiling Stylus to CSS

See Also

Reference:

External Links: