npm install spasdk
Add to the scope:
var spasdk = require('spasdk');
Name | Description |
---|---|
PATH_ROOT | read-only absolute path to main application directory (where package.json is located) |
PATH_APP | relative to PATH_ROOT directory with files ready to be deployed |
PATH_SRC | relative to PATH_ROOT directory with source files to generate development and release application files |
PATH_CFG | relative to PATH_ROOT directory with configuration files for tasks and application itself |
PACKAGE | read-only absolute path to the application package.json file |
Some to these variables can be redefined in run-time:
PATH_CFG=some_other_dir gulp
The directory contains all application configuration files.
File gulp.js
can redefine default configuration options for all gulp tasks.
For example:
module.exports = {
default: {
notifications: {
popup: {
fail: false
}
}
},
jade: {
default: {
source: 'sources/pug/main.pug'
},
develop: {
target: 'dst/debug.html'
},
release: false,
test: {}
},
sass: false
};
This will apply the following changes:
- disable failure popup notifications for all profiles and all tasks
- set
sources/pug/main.pug
as the main entry point (instead of defaultsrc/jade/main.jade
) for all Jade profiles - set
dst/debug.html
as the intended output file (instead of defaultapp/develop.html
) for Jadedevelop
profile only - remove Jade
release
profile - add new Jade
test
profile filled with options fromdefault
profile - completely disable all SASS tasks
To make sure all options are correct it's possible to print the current config set:
gulp jade:config
If you have any problems or suggestions please open an issue according to the contribution rules.
spasdk
is released under the GPL-3.0 License.