Makes inclusion of files a breeze.
Enables functionality similar to that of snockets / sprockets or other file insertion compilation tools.
Made for gulp 3
By wiledal with help from juanghurtado
First, install gulp-include
as a dev dependency:
npm install --save-dev gulp-include
Then, add your include-comments to your file.
People who have experience with sprockets
or snockets
will feel at home.
An include-comment looks like this:
//= include relative/path/to/file.js
or
#= require_tree relative/path/to/folder
or even
/*
= include relative/path/to/file.js
= require relative/path/to/file2.js
= include_tree relative/path/to/folder
*/
gulp-include
does not care about whitespace, as long as the comment-line starts with a newline followed =
and contains include
, require
or include_tree
, require_tree
.
The example below compiles a several coffee-files and js-files into a single js-file:
app.coffee
:
`
//= require vendor/jquery.js
//= require vendor/modernizr.js
`
#= require controllers/AppController.coffee
#= require_tree views
class Main extends AppController
constructor: ->
console.log "This is main!"
window.main = new Main()
Note: The example above uses backsticks (`) to allow gulp-coffee
to compile inline javascript
gulpfile.js
:
var gulp = require('gulp'),
include = require('gulp-include'),
coffee = require('gulp-coffee');
gulp.task("scripts", function() {
gulp.src('src/js/app.coffee')
.pipe( include() )
.pipe( coffee() )
.pipe( gulp.dest("dist/js") )
});
gulp.task("default", "scripts");
extensions
(optional)- Takes a
String
or anArray
of extensions, eg:"js"
or["js", "coffee"]
- If set, all inclusions that does not match the extension(s) will be ignored
- Takes a
- Updated regex directive to not collide with other requireing plugins, like browserify (cwacek)
- Changed replace-method to fix issue when requiring a file that contained special characters (juanghurtado)
- Added
require_tree
/include_tree
(Thanks to juanghurtado!) - Method now takes an
extensions
param for controlling what types of files to include
- Basic include
(MIT License)
Copyright (c) 2014 Hugo Wiledal
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.