Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fluffywaffles/gulp-load-subtasks
A globular gulp subtask loader
https://github.com/fluffywaffles/gulp-load-subtasks
gulp subtask
Last synced: about 2 months ago
JSON representation
A globular gulp subtask loader
- Host: GitHub
- URL: https://github.com/fluffywaffles/gulp-load-subtasks
- Owner: fluffywaffles
- Created: 2015-10-06T23:29:14.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:25:16.000Z (about 2 years ago)
- Last Synced: 2024-08-10T10:37:48.292Z (5 months ago)
- Topics: gulp, subtask
- Language: JavaScript
- Homepage:
- Size: 548 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hullo from Gulp Load Subtasks!
[](https://travis-ci.org/fluffywaffles/gulp-load-subtasks)
### What is this and why?
Do you have a long gulpfile?
Do you wish you could split it up into modules?
Modules, like, grouped task files; like, test.tasks.js and build.tasks.js.
Wouldn't that be nice?
If you'd like that, you're in luck! _That's_ what Gulp Load Subtasks does!
:tada: **Easy, not-so-ugly, auto-loaded subtasks!** :tada:
### How to install:
```js
npm i --save-dev gulp-load-subtasks
```
### Alternatives and Comparison:
* [gulp-hub](https://github.com/frankwallis/gulp-hub)
* Multiple gulpfiles, not multiple modules
* No globbing (?)
* No coffee/livescript support (?)
* Lets you have multiples of the same task and will run them all together
* **Intention**: run Gulp tasks from multiple projects at once
* [require-dir](https://github.com/aseemk/requireDir)
* No globbing
* Requires the directory's modules into an object
* No coffee/livescript support (?)
* **Intention**: ability to require a directory into any Node environment
* **gulp-load-subtasks** (You are here!)
* Supports globbing
* Opinionated
* Fully supports coffee/livescript tasks, gulpfiles
* Works with and is heavily inspired by
[gulp-load-plugins](https://github.com/jackfranklin/gulp-load-plugins)
* **Intention**: ability to import sets of related tasks into any Gulp
environment
### Basics
In its simplest form, gulp-load-subtasks can be passed some directory ('dir', relative to cwd) and it will find all files matching 'dir/\*\*/\*.tasks.js' and load those tasks. Here's that example in code:
```js
require('gulp-load-subtasks')('dir')
```
You can pass optional additional arguments that will be passed on to all subtask functions,
such as a plugin object from gulp-load-plugins.
You can also access `loadSubtasks` from your gulp-load-plugins object!
Example using gulp-load-plugins:
```js
var gulp = require('gulp')
, $ = require('gulp-load-plugins')()
// pass the plugins along so that your tasks can use them
$.loadSubtasks('dir', $)
```
You can also use gulp-load-subtasks with CoffeeScript and LiveScript!
Just change your require statement to
```coffee
# in gulpfile.coffee
(require 'gulp-load-subtasks/coffee')('dir')
```
```ls
# in gulpfile.ls
(require 'gulp-load-subtasks/livescript')('dir')
```
and it will load `dir/**/*.tasks.coffee` or `dir/**/*.tasks.ls` by default
instead.
#### Basic Example (with directory structure)
_Directory structure:_
```
+ gulpfile.js
|
+ tasks/
+ a.tasks.js
+ b.tasks.js
```
_tasks/a.tasks.js:_
```js
module.exports = function (gulp) {
gulp.task('subtaskA1', function () {
// do things... A1
})
gulp.task('subtaskA2', function () {
// do things... A2
})
}
```
_tasks/b.tasks.js_
```js
module.exports = function (gulp, $) {
gulp.task('subtaskB', function () {
// do things... B
// use plugins!
gulp.src('*.sass')
.pipe($.sass())
.pipe(gulp.dest('sassy-css-goes-here'))
})
}
```
_gulpfile.js:_
```js
var gulp = require('gulp')
, $ = require('gulp-load-plugins')()
$.loadSubtasks('tasks')
// OR path can be a glob
$.loadSubtasks('tasks/**/*.js')
// Pass in your plugins
$.loadSubtasks('tasks', $)
// Actually pass whatever you want, gulp can chug it /badpun
$.loadSubtasks('tasks', $, "hi mom", { a: "b" }, ...)
// You can now refer to the tasks defined in a.tasks.js and b.tasks.js!
gulp.task('default', [ 'subtaskA1', 'subtaskB' ])
```