grunt-contrib-less v3.0.0
Compile LESS files to CSS
Getting Started
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.
Less task
Run this task with the grunt less
command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
Options
paths
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.
rootpath
Type: String
Default: ""
A path to add on to the start of every URL resource.
compress
Type: Boolean
Default: false
Compress output by removing some whitespaces.
plugins
Type: Array
Default: null
Allows passing plugins.
optimization
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.
strictImports
Type: Boolean
Default: false
Force evaluation of imports.
strictMath
Type: Boolean
Default: false
When enabled, math is required to be in parenthesis.
strictUnits
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).
syncImport
Type: Boolean
Default: false
Read @import'ed files synchronously from disk.
dumpLineNumbers
Type: String
Default: false
Configures -sass-debug-info support.
Accepts following values: comments
, mediaquery
, all
.
relativeUrls
Type: Boolean
Default: false
Rewrite URLs to be relative. false: do not modify URLs.
customFunctions
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.
sourceMap
Type: Boolean
Default: false
Enable source maps.
sourceMapFilename
Type: String
Default: none
Write the source map to a separate file with the given filename.
sourceMapURL
Type: String
Default: none
Override the default URL that points to the source map from the compiled CSS file.
sourceMapBasepath
Type: String
Default: none
Sets the base path for the less file paths in the source map.
sourceMapRootpath
Type: String
Default: none
Adds this path onto the less file paths in the source map.
sourceMapFileInline
Type: Boolean
Default: false
Puts the map (and any less files) as a base64 data uri into the output css file.
outputSourceFiles
Type: Boolean
Default: false
Puts the less files into the map instead of referencing them.
modifyVars
Type: Object
Default: none
Overrides global variables. Equivalent to --modify-vars='VAR=VALUE'
option in less.
banner
Type: String
Default: none
process
Type: Function(content, destinationPath)
Default: none
Attributes: content, destinationPath
Allows to parse the CSS content to be written to destinationPath to flow through a self defined function.
Usage Examples
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'
}
}
}
Release History
- 2021-02-21βββv3.0.0βββUpdated to Less 4. ieCompat option removed.
- 2021-02-20βββv2.1.0βββDependency updates. New process option to modify the written CSS.
- 2018-05-25βββv2.0.0βββUpdate less to ^3.0.0
- 2017-03-08βββv1.4.1βββFix
sourceMappingURL
to be the same as the CSS if not specified, #322. Rethrow the compilation error after printing the message, #315. - 2016-07-21βββv1.4.0βββUpdate async and less to ~2.7.1.
- 2016-04-07βββv1.3.0βββUpdate lodash and async dependecies.
- 2016-02-01βββv1.2.0βββUpdate to less ~2.6.0. Removed peerDependency from package.json.
- 2015-11-09βββv1.1.0βββUpdate to less ~2.5.0.
- 2014-12-23βββv1.0.0βββUpdate to less 2.1.0.
- 2014-10-23βββv0.12.0βββAdded
cleancssOptions
as an option. When possible, includes filename for failed writes. Ensure banner only outputs on the first file in a series. - 2014-07-29βββv0.11.4βββFix
banner
andurlArgs
LESS options. Fixes npm 2 peerDependencies issues. - 2014-06-20βββv0.11.3βββUpdate to Less ~1.7.2.
- 2014-06-01βββv0.11.2βββLock to less 1.7.0.
- 2014-05-26βββv0.11.1βββFix
modifyVars
to work when less file ends with a comment. - 2014-03-19βββv0.11.0βββCustom functions can return types defined by less.
paths
option now accepts a function. Replaced deprecatedgrunt.util
methods. Removes deprecatedgrunt.lib.contrib
. - 2014-03-01βββv0.10.0βββ
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. - 2014-01-07βββv0.9.0βββBump to less 1.6.
- 2013-12-06βββv0.8.3βββSupport
sourceMapURL
. - 2013-11-14βββv0.8.2βββSupport
outputSourceFiles
. - 2013-10-24βββv0.8.1βββSupport
sourceMapFilename
,sourceMapBasepath
andsourceMapRootpath
. - 2013-10-22βββv0.8.0βββUpgrade to LESS 1.5. Support
strictUnits
option. SupportsourceMap
option. AddcustomFunctions
option for defining custom functions within LESS. Output the source file name on error.yuicompress
option now cleancss (Less changed underlying dependency) - 2013-08-08βββv0.7.0βββDowngrade no source files warning to only in verbose mode.
- 2013-08-08βββv0.6.5βββSupport
strictMath
option. Supportrootpath
parse option. - 2013-07-09βββv0.6.4βββSupport
relativeUrls
option. - 2013-07-06βββv0.6.3βββAdd
report
option for minification and gzip results. - 2013-07-03βββv0.6.2βββsupport
syncImport
. - 2013-06-12βββv0.6.1βββSupport
ieCompat
. - 2013-06-09βββv0.6.0βββBump less to 1.4.0.
- 2013-05-23βββv0.5.2βββImprove error handling.
- 2013-04-25βββv0.5.1βββGracefully handle configuration without sources.
- 2013-02-15βββv0.5.0βββFirst official release for Grunt 0.4.0.
- 2013-01-23βββv0.5.0rc7βββUpdating grunt/gruntplugin dependencies to rc7. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions. Remove experimental wildcard destination support. Switching to
this.files
API. - 2012-10-18βββv0.3.2βββAdd support for
dumpLineNumbers
. - 2012-10-12βββv0.3.1βββRename grunt-contrib-lib dep to grunt-lib-contrib.
- 2012-09-24βββv0.3.0βββGlobal options depreciated. Revert normalize linefeeds.
- 2012-09-16βββv0.2.2βββSupport all less options. Normalize linefeeds. Default path to dirname of src file.
- 2012-09-10βββv0.2.0βββRefactored from grunt-contrib into individual repo.
Task submitted by Tyler Kellen
This file was generated on Sun Feb 21 2021 11:29:25.