How CSS and LESS files are preprocessed and how to debug them

What's in this topic

The topic describes how stylesheets are preprocessed and compiled to CSS in the Magento application. It provides the theoretical background a frontend developer needs to debug stylesheets effectively.

Terms used

Term Description

Root source files

The .less files from which the .css files included in layout are compiled. For example, in one of the layout files of the Magento Blank theme, the following .css files are included: 

    <head>
        <css src="css/styles-m.css" />
        <css src="css/styles-l.css" media="screen and (min-width: 768px)"/>
        <css src="css/print.css" media="print" />
    </head>
The root source files for the Blank theme:

LESS compilation modes

In the Magento application, the following modes of compiling .less files to CSS are implemented:

  1. Server-side LESS compilation.
    This is the default compilation mode, and is the only option in production application mode. In this case the compilation is performed on the server, using the LESS PHP library.
  2. Client-side LESS compilation.
    When your application is not in the production mode, you can set Magento to compile .less files in a browser, using the native less.js library

To set the compilation mode, do the following:

  1. In the Magento Admin, navigate to Stores > Configuration > ADVANCED > Developer.
  2. In the Store View drop-down field, select Default Config.
  3. Under Front-end development workflow, in the Workflow type field, select the compilation mode.
  4. To save the settings, click Save Config.
  5. Make sure that the same compilation mode is set for each configuration scope. That is, check the Front-end development workflow option having switched the Store View drop-down field to the website scope first, and then to the store view. Change the option to match the default config if it is different.

Server-side LESS compilation

The following paragraph describes how the LESS preprocessor works in server-side compilation mode. For each CSS file included in the layouts, LESS preprocessor does the following:

  1. Checks if the requested .css file is found. If it is found, the preprocessor stops its execution. Otherwise, it proceeds to the next step.
  2. Changes the extension of the requested file to .less and tries to find the file using the Magento fallback mechanism. If the .less file is not found, LESS preprocessor stops its execution. Otherwise, it proceeds to the next step.
  3. Reads .less file contents and resolves @magento_import and default LESS @import directives.
  4. Resolves all paths in .less files to relative paths in the system using the Magento fallback mechanism. All files resolved by the LESS preprocessor are copied to var/view_preprocessed/less. Imported files are processed recursively.
  5. All source files are passed to the PHP LESS compiler. The resulting compiled .css files are published to pub/static/frontend/<Vendor>/<theme>/<locale>.

Styles debugging in server-side compilation mode

In server-side LESS compilation mode, to have your changes applied, you need to do the following:

  1. Clear pub/static/frontend/<Vendor>/<theme>/<locale> by deleting the directory in the file system.
  2. Clear the var/cache and var/view_preprocessing directories by deleting the directory in the file system. (if they already existed there).

  3. Trigger static files compilation and publication. This can be done in one of the following ways:

Reloading the page only triggers compilation and publication of the styles used on this very page, and does not give you the information about the errors if any. So if you made changes in .less files used on many pages, and want to debug them, using the deployment tool is the better option.

Debugging using the static view files deployment tool

Once you save your changes and run the magento setup:static-content:deploy cli command from the <your_Magento_instance>/bin directory, the tool pre-processes (including compilation) and publishes the static view files.

All errors occurring during .less files compilation are handled by the oyejorge/less.php third party library.

Errors are caught as exceptions and written to the system log (by default it is var/log/system.log) and displayed on the screen. For each error, the following information is written:

  • The path to the processed file in the var/view_preprocessed directory.
  • The error description, including the path to file where the actual error occurred. It might be either the processed file, or the imported file.
  • The error line and the column number.
  • The content of the .less code in the previous and following lines.

Example of an error message:

Compilation from source: /var/www/magento2/app/design/adminhtml/Magento/backend/web/css/styles.less
variable @variable-x is undefined in file /var/www/magento2/var/view_preprocessed/css/adminhtml/Magento/backend/en_US/css/styles.less in styles.less on line 56, column 17
      margin-left: 0;
      width: 100%;
      height: @variable-x;
 }

 .menu-wrapper,
Debugging using Grunt

Alternatively, to streamline the process of applying and debugging styles customizations, in server-side compilation mode, you can

See the Compile LESS with Grunt topic for details how to install, configure and use Grunt.

Client-side LESS compilation

The client-side compilation flow is similar to server-side. The difference is in the set of files, published to pub/static on the last step. In the client-side mode, the following files are published to the pub/static/frontend/<Vendor>/<theme>/<locale> directory:

  • root source (.less) files with resolved @magento_import directive
  • symlinks to the root source file that do not contain @magento_import
  • symlinks to all other .less files imported recursively by the @magento_import and @import directives

Symlink is not created, and a copy of the processed file is published to pub/static instead, if the source file differs from the processed one. One of the reasons of this difference might be the usage of the @import directive without file extension in the source file. See <a href="#fedg_css-import>The @import directive usage</a> for more details.

Styles debugging in client-side compilation mode

Client-side LESS compilation is implemented using the native less.js library. The default configuration is set in lib/web/less/config.less.js; you can change it as needed.

You can find the detailed information about the configuration and other options of the less.js used in a browser at http://lesscss.org/usage/#using-less-in-the-browser.

In client-side compilation mode, most of the stylesheet customizations display immediately after you reload a page in a browser.

When you need to clean static view files

There are certain types of changes, that require you to clear the pub/static/frontend/<Vendor>/<theme>/<locale> directory and trigger the compilation and publication processes anew.

This is required in the following cases:

  • If you change the root source files that contain the @magento_import directive, or the @import directive where the imported file is specified without extension.
  • If you rename, remove, or add a .less file imported with a @magento_import or @import directive but you did not correct the directives accordingly.

To clear the pub/static/frontend/<Vendor>/<theme>/<locale> directory, delete the directory in the file system, and reload the store pages in a browser to trigger compilation and publication.

The @import directive rules of usage

You can import local and remote .less and .css files in your .less Magento stylesheets by using the standard LESS @import directive. According to the @import syntax, specifying the file extension for the imported file is not mandatory. For example, the following notation is allowed:

@import 'source/lib/_lib';
@import (css) 'styles';

But in process of resolving the file path, Magento adds the .less extension for the imported files in all @import entrees. So in the processed files, the statements from the previous example will look like following:

@import 'source/lib/_lib.less';
@import (css) 'styles.less';

As a result, the processed files are different from the source files. So in the client-side compilation mode or when using grunt commands, Magento cannot use symlinks to the source files. Instead it uses the copies of processed files, and they are published to the pub/static directory. In case of importing CSS resources, this also results in not finding and not importing the required files.

Importing remote CSS files

If you need to import a remote CSS file in your .less source, use url() notation. For example, to import a Google font, use the following notation:

@import url('//fonts.googleapis.com/css?family=Titillium+Web:400,300,200,600.css');

This way Magento will skip the @import directive while resolving paths to the local resources.

The @magento_import directive

@magento_import is a Magento-specific LESS directive that allows including multiple files by a name pattern. It is used to include files with the same name from the different locations, for example, different modules. The standard @import directive includes a single file, which is found according to the static files fallback.

@magento_import can be used in the root source files of a theme only.

@magento_import rules of usage

To include a .less file using the @magento_import directive:

  1. To avoid any conflicts with the original LESS syntax, @magento_import must be commented out with two slashes. Otherwise, the LESS preprocessor ignores it.

    Example:

    //  Comment in a LESS document

//  Standard LESS import directive
//  ---------------------------------------------

@import 'source/_reset';
@import '_styles';

//
//  Custom Magento LESS import directives
//  ---------------------------------------------

//@magento_import 'source/_module.less'; // Theme modules
//@magento_import 'source/_widgets.less'; // Theme widgets
//@magento_import 'source/_extend.less'; // Extend for minor customization

  2. @magento_import must contain the file path. The path is specified relatively to the file, where the directive is called and put in either single ('') or double quotes ("").

    The best practice is to specify the file extension in the path, though technically you can omit this.

@magento_import processing

In the scope of static resources preprocessing, the built-in LESS preprocessor does the following:

  1. Searches for all @magento_import directives.
  2. Replaces the original @magento_import directives with the standard @import directives. The latter specify the paths to the particular files that correspond to the pattern specified in @magento_import.

Example of how @magento_import is used and processed in <Magento_Blank_theme_dir>/web/css/styles-l.less:

Before After
In <Magento_Blank_theme_dir>/web/css/styles-l.less there's a following directive: 
 ..
//@magento_import 'source/_widgets.less'; // Theme widgets
..
In the processed file, this results in the following: 
@import '../Magento_Catalog/css/source/_widgets.less';
@import '../Magento_Cms/css/source/_widgets.less';
@import '../Magento_Reports/css/source/_widgets.less';
@import '../Magento_Sales/css/source/_widgets.less';
 // Theme widgets
Edit this page on GitHub
Give us feedback

相关主题：

Magento电商 github source