Compile LESS files to CSS
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-contrib-less --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-contrib-less');
This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.
Run this task with the grunt less
command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
Type: String
Array
Function
Default: Directory of input file.
Specifies directories to scan for @import directives when parsing. Default value is the directory of the source, which is probably what you want.
If you specify a function the source filepath will be the first argument. You can return either a string or an array of paths to be used.
Type: String
Default: ""
A path to add on to the start of every URL resource.
Type: Boolean
Default: false
Compress output by removing some whitespaces.
Type: Array
Default: null
Allows passing plugins.
Type: Boolean
Default: true
Enforce the CSS output is compatible with Internet Explorer 8.
For example, the data-uri function encodes a file in base64 encoding and embeds it into the generated CSS files as a data-URI. Because Internet Explorer 8 limits data-uri
s to 32KB, the ieCompat option prevents less
from exceeding this.
Type: Integer
Default: null
Set the parser's optimization level. The lower the number, the less nodes it will create in the tree. This could matter for debugging, or if you want to access the individual nodes in the tree.
Type: Boolean
Default: false
Force evaluation of imports.
Type: Boolean
Default: false
When enabled, math is required to be in parenthesis.
Type: Boolean
Default: false
When enabled, less will validate the units used (e.g. 4px/2px = 2, not 2px and 4em/2px throws an error).
Type: Boolean
Default: false
Read @import'ed files synchronously from disk.
Type: String
Default: false
Configures -sass-debug-info support.
Accepts following values: comments
, mediaquery
, all
.
Type: Boolean
Default: false
Rewrite URLs to be relative. false: do not modify URLs.
Type: Object
Default: none
Define custom functions to be available within your LESS stylesheets. The function's name must be lowercase. In the definition, the first argument is the less object, and subsequent arguments are from the less function call. Values passed to the function are types defined within less, the return value may be either one of them or primitive. See the LESS documentation for more information on the available types.
Type: Boolean
Default: false
Enable source maps.
Type: String
Default: none
Write the source map to a separate file with the given filename.
Type: String
Default: none
Override the default URL that points to the source map from the compiled CSS file.
Type: String
Default: none
Sets the base path for the less file paths in the source map.
Type: String
Default: none
Adds this path onto the less file paths in the source map.
Type: Boolean
Default: false
Puts the map (and any less files) as a base64 data uri into the output css file.
Type: Boolean
Default: false
Puts the less files into the map instead of referencing them.
Type: Object
Default: none
Overrides global variables. Equivalent to --modify-vars='VAR=VALUE'
option in less.
Type: String
Default: none
less: {
development: {
options: {
paths: ['assets/css']
},
files: {
'path/to/result.css': 'path/to/source.less'
}
},
production: {
options: {
paths: ['assets/css'],
plugins: [
new (require('less-plugin-autoprefix'))({browsers: ["last 2 versions"]}),
new (require('less-plugin-clean-css'))(cleanCssOptions)
],
modifyVars: {
imgPath: '"http://mycdn.com/path/to/images"',
bgColor: 'red'
}
},
files: {
'path/to/result.css': 'path/to/source.less'
}
}
}
sourceMappingURL
to be the same as the CSS if not specified, #322. Rethrow the compilation error after printing the message, #315.cleancssOptions
as an option. When possible, includes filename for failed writes. Ensure banner only outputs on the first file in a series.banner
and urlArgs
LESS options. Fixes npm 2 peerDependencies issues.modifyVars
to work when less file ends with a comment.paths
option now accepts a function. Replaced deprecated grunt.util
methods. Removes deprecated grunt.lib.contrib
.sourceMapBasepath
accepts a function. Update copyright to 2014. Update .gitattributes. Update less.js to v1.7.0. Prevent CRLF in the repo. Adds modify-vars option. Changed to async stack call. Fixes data-uri test. Normalize line endings on tests.sourceMapURL
.outputSourceFiles
.sourceMapFilename
, sourceMapBasepath
and sourceMapRootpath
.strictUnits
option. Support sourceMap
option. Add customFunctions
option for defining custom functions within LESS. Output the source file name on error. yuicompress
option now cleancss (Less changed underlying dependency)strictMath
option. Support rootpath
parse option.relativeUrls
option.report
option for minification and gzip results.syncImport
.ieCompat
.this.files
API.dumpLineNumbers
.Task submitted by Tyler Kellen
This file was generated on Wed Mar 08 2017 11:27:07.