SublimeLinter-contrib-sass-lint

This linter plugin for SublimeLinter provides an interface to sass-lint (Node.js). It will be used with files that have Sass and SCSS syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that sass-lint is installed on your system. To install sass-lint, do the following:

1. Install Node.js (and npm on Linux).

2. Install sass-lint globally by typing the following in a terminal:

   npm install -g sass-lint
   

Note: This plugin requires sass-lint 1.2.0 or later. Check your version with sass-lint --version.

Linter configuration

In order for sass-lint to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured sass-lint, you can proceed to install the SublimeLinter-contrib-sass-lint plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

2. When the plugin list appears, type sass-lint. Among the entries you should see SublimeLinter-contrib-sass-lint. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

You can configure sass-lint options with a .sass-lint.yml. If a .sass-lint.yml file is not found in the file hierarchy starting with the linted file, your home directory will also be searched. For more information, see the sass-lint page. Default configuration file can be found here.

Update SublimeLinter settings to check for a configurtaion file in your current project:

// SublimeLinter Settings - User
{
    "linters": {
        "sass": {
            "working_dir": "${file_path}"
        }
    }
}

Common issues

Remember to choose SCSS syntax (lower right corner of Sublime), not SASS. Else you might get errors like

Please check validity of the block starting from #1.

Cannot find that syntax? Install the package SCSS.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latest master.
3. Commit and push the topic branch.
4. Make a pull request.
5. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

• Indent is 4 spaces.
• Code should pass flake8 and pep257 linters.
• Vertical whitespace helps readability, don’t be afraid to use it.
• Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!