The asset pipeline bundled in Sails is a set of Grunt tasks configured with conventional defaults designed to make your project more consistent and productive. The entire frontend asset workflow is completely customizable, while it provides some default tasks out of the box. Sails makes it easy to configure new tasks to fit your needs.
Here are a few things that the default Grunt configuration in Sails does to help you out:
- Automatic LESS compilation
- Automatic JST compilation
- Automatic Coffeescript compilation
- Optional automatic asset injection, minification, and concatenation
- Creation of a web ready public directory
- File watching and syncing
- Optimization of assets in production
Default Grunt Task Behavior.
Below are the Grunt tasks that are included in your Sails project as well as a small description of exactly what each does in your project. Also included are a link to the usage docs for each task.
This grunt task is configured to clean out the contents in the
.tmp/public/of your sails project.
Compiles coffeeScript files from
dev task config Copies all directories and files, except coffeescript and less files, from the sails assets folder into the
build task config Copies all directories and files from the .tmp/public directory into a www directory.
Minifies css files and places them into
Precompiles Underscore templates to a
Compiles LESS files into CSS. Only the
assets/styles/importer.lessis compiled. This allows you to control the ordering yourself, i.e. import your dependencies, mixins, variables, resets, etc. before other stylesheets.
<link>tags for css files. Also automatically links an output file containing precompiled templates using a
<script>tag. A much more detailed description of this task can be found here, but the big takeaway is that script and stylesheet injection is only done in files containing
<!--STYLES--><!--STYLES END-->tags. These are included in the default views/layout.ejs file in a new Sails project. If you don't want to use the linker for your project, you can simply remove those tags.
A grunt task to keep directories in sync. It is very similar to grunt-contrib-copy but tries to copy only those files that have actually changed. It specifically synchronizes files from the
.tmp/public/, overwriting anything that's already there.
Runs predefined tasks whenever watched file patterns are added, changed or deleted. Watches for changes on files in the
assets/folder, and re-runs the appropriate tasks (e.g. less and jst compilation). This allows you to see changes to your assets reflected in your app without having to restart the Sails server.