https://github.com/craigchilds94/gulp-boilerplate
Custom Gulp tasks packaged as a gulp "plugin"
https://github.com/craigchilds94/gulp-boilerplate
Last synced: 4 months ago
JSON representation
Custom Gulp tasks packaged as a gulp "plugin"
- Host: GitHub
- URL: https://github.com/craigchilds94/gulp-boilerplate
- Owner: CraigChilds94
- License: mit
- Created: 2015-04-22T11:35:38.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-01-07T17:36:58.000Z (over 8 years ago)
- Last Synced: 2024-12-06T21:12:56.335Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 39.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-boilerplate
Some custom Gulp tasks packaged as a gulp "plugin"
### Add dependency to package.json
```
"dependencies": {
"gulp": "^3.8.10",
"gulp-boilerplate": "CraigChilds94/gulp-boilerplate"
}
```
### Example usage
Specify some options and pass them to the task function. Any present will overwrite the default options which can be found in `index.js` by the task name on the `settings` object. Example: `settings.deploy` would hold the default options for the deploy task. Below is an example of how to apply the `boilerplate.deploy` task to your `gulpfile`.
```js
var gulp = require('gulp');
var boilerplate = require('gulp-boilerplate')(gulp);
var options = {
deploy: {
files: [
'**/*',
'!{_deploy,_deploy/**}',
'!{vendor,vendor/**}',
'!{assets,assets/**}',
'!{node_modules,node_modules/**}',
'!package.json',
'!.editorconfig',
'!gulpfile.js',
'!composer.json',
'!composer.lock',
'!README.md'
],
destination: '_deploy'
},
};
gulp.task('deploy', boilerplate.deploy(options.deploy));
```
You can find an example `gulpfile.js` and `package.json` in the [example](/example) folder. This example relies on the default options which are set in `index.js`.