Default tasks
Overview
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 providing 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
- Cache busting
- Optional automatic asset injection, minification, and concatenation
- Creation of a web ready public directory
- File watching and syncing
- Transpilation of client-side JavaScript in production to allow use of >=ES6 syntax while maintaining broad browser compatibility
- Optimization of assets in production
Default Grunt tasks
Below is a list of the Grunt tasks that are included by default in new Sails projects:
clean
This grunt task is configured to clean out the contents in the
.tmp/public/of your Sails project.
hash
Creates and adds an unique hash to the end of a filename for cache busting.
concat
Concatenates JavaScript and CSS files, and saves concatenated files in
.tmp/public/concat/directory.
copy
dev task config
Copies all directories and files, except coffeescript and less files, from the sails assets folder into the
.tmp/public/directory.
build task config
Copies all directories and files from the .tmp/public directory into a www directory.
cssmin
Minifies CSS files and places them into
.tmp/public/min/directory.
less
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).
sails-linker
Automatically inject
<script>tags for JavaScript files and<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<!--SCRIPTS--><!--SCRIPTS END-->and/or<!--STYLES--><!--STYLES END-->tags. These are included in the default views/layouts/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.
sync
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
assets/folder to.tmp/public/, overwriting anything that's already there.
babel
This grunt task is configured to transpile any >=ES6 syntax in your front-end Javascript files into code compatible with older browsers.
uglify
Minifies client-side JavaScript assets. Note that by default, this task will "mangle" all of your function and variable names (either by changing them to a much shorter name, or stripping them entirely). This is usually desirable as it makes your code significantly smaller, but in some cases can lead to unexpected results (particularly when you expect an object's constructor to have a certain name). To turn off or modify this behavior, use the
mangleoption when setting up this task.
watch
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 compilation). This allows you to see changes to your assets reflected in your app without having to restart the Sails server.
For a better experience on sailsjs.com, update your browser.
Concepts
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2024 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.