lesshint

lesshint

lesshint is a tool to aid you in writing clean and consistent Less.

• Requirements
• Installation
• Configuration
• CLI usage
• Known issues

Important information

This is the final project for a associate degree, because of this pull requests cannot be accepted until mid-June 2015.

However, I (jwilsson) will need your help to decide which options that should be available for each linter and which option that should be the default value. For each linter that I add, I'll open a corresponding issue where a discussion/vote will take place for which options that should be included and which one should be the default. Therefore, I highly recommend users of this tool to not trust the defaults until a 1.0 release since some default values will change. In short, be extremely specific about which options you specify, don't trust the defaults just yet.

Please feel free to submit bug reports and other forms of feedback. That's greatly appreciated!

Requirements

Node.js 0.10 (or later) or io.js 1.0 (or later).

Installation

Run the following command from the command line (add -g to install globally):

npm install lesshint

Configuration

lesshint is customizable and we highly recommend you to look at the available options to tailor it to your needs.

Start by creating a .lesshintrc file in your project root and add your settings to it. It will be automatically loaded and merged with the default values.

Each option is then specifed by it's own JSON object, for example:

"fileExtensions": [".less", ".css"],

"excludedFiles": ["vendor.less"],

"spaceAfterPropertyColon": {
    "enabled": true,
    "style": "one_space" // Comments are allowed
}

Options

fileExtensions

Array of file extensions to check. Either an array of extensions or "*" to allow all files. For example:

"fileExtensions": [".less", ".css"] // Allow ".less" and ".css" files. Can be passed with or without a dot.

"fileExtensions": "*" // Allow all files

excludedFiles

Array of minimatch glob patterns or a file to exclude. For example:

"excludedFiles": ["vendor/*.less"] // Ignore all files in "vendor/"

"excludedFiles": ["vendor.less"] // Ignore a file named "vendor.less"

CLI usage

Run lesshint from the command-line by passing one or more files/directories to recursively scan.

lesshint src/less/ lib/style.less

Available Flags	Description
-c/--config	Specify the configuration file to use (will be merged with defaults).
-e/--exclude	A minimatch glob pattern or a file to exclude form being linted.
-V/--version	Show version.

Known issues

We are aware of some instances where some Less features won't be properly parsed. In those cases the whole file will simply be ignored by lesshint.

• Not all forms of :extend() rules are supported. Related issue.
• Using variables in @media directives are not supported. Related issue.