jdiehl / brackets-less-autocompile

Automatic compilation of LESS files for Brackets
93 stars 36 forks source link

LESS AutoCompile

LESS AutoCompile is an extension for the code editor Brackets that adds automatic compilation of LESS files upon saving.

Installation

LESS AutoCompile is installed from the Brackets Extension Manager. Please restart Brackets after installing the extension.

Manual Installation

  1. Install NodeJS
  2. Find your extension folder: Choose Help > Show Extensions Folder (or open it manually)
  3. Drill down to the user folder
  4. Check out the extension from GitHub into the user folder
  5. Run npm i in the root folder of the extension
  6. Run npm i in the node folder of the extension

Compile Options

LESS compile options can be set in the first line of the edited file:

// out: ../dist/app.css, compress: true, strictMath: true

The following compile options are available:

Other less compiler options might also work but are untested at this point. See Grunt LESS for a complete list of possible options.

Project-wide Compile Options

You can tell the extension to always compile a specific set of files in a project independent of the edited file by creating a configuration file called .brackets.json or compile.json in your project's root folder:

{ "less": [ "path/to/file1.less", "path/to/file2.less" ] }

All file paths must be relative to the project's root folder. To disable less-autocompile for a project, specify an empty list of files:

{ "less": [] }

FAQ

What should I do if files are not compiled?

  1. Make sure "Lint Files on Save" is enabled.
  2. Make sure the file compiles using less on the command line.
  3. Check the Brackets developer console and the node console for any errors.

If you cannot resolve the problem by yourself post an issue here and include the files you are trying to compile and the output of both consoles.

How can I redirect the output to a separate file?

Add the following line to the head of your less file:

// out: new-file.css

How can I supress compiling this less file / compile a different less file than the one being edited?

Add a reference to the master.less file to the head of the imported less file:

// main: master.less

How can I supress the compilation of a single less file

Set out to null

// out: null

Acknowledgements

License

The MIT License (MIT)

Copyright (c) 2013 Jonathan Diehl

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.