Skip to content

Latest commit

 

History

History
137 lines (109 loc) · 4.76 KB

README.md

File metadata and controls

137 lines (109 loc) · 4.76 KB
Raw

#gulp-include NPM version Travis build

Makes inclusion of files a breeze.
Enables functionality similar to that of snockets / sprockets or other file insertion compilation tools.

Made for gulp 3

Features

  • Concatenate files with full control
  • Respects indentation whitespace
  • Uses globs for simple path control
  • Works recursively (files can include files that can include files, and so on)

Warning: if you are updating from 1.x.x to 2.x.x, please read this readme to get up to date on the behavior of gulp-include

Installation

npm install gulp-include

Usage

Example gulpfile.js:

var gulp          = require("gulp"),
    include       = require("gulp-include");

gulp.task("scripts", function() {
  console.log("-- gulp is running task 'scripts'");

  gulp.src("src/js/main.js")
    .pipe(include())
      .on('error', console.log)
    .pipe(gulp.dest("dist/js"));
});

gulp.task("default", ["scripts"]);

Options

  • extensions (optional)

    • Takes a String or an Array of extensions.
      eg: "js" or ["js", "coffee"]
    • If set, all directives that does not match the extension(s) will be ignored

  • includePaths (optional)

    • Takes a String or an Array of paths.
      eg: __dirname + "/node_modules" or [__dirname + "/assets/js", __dirname + "/bower_components"]
    • If set, gulp-include will use these folders as base path when searching for files.

  • hardFail (optional)

    • Boolean, false by default
    • Set this to true if you want gulp-include to throw errors if a file does not match an include directive.
    • If set to false gulp include will not fail, but display warnings in the console.

  • separateInputs (optional)

    • Boolean, true by default
    • Set this to false if you want to process each input file independent, when executing "require" logic. So, if file required several times inside one file (or inside required by it files), then dublicates will be ignored. But when another file will begin processing, all information about required files from previuos file will be discarded.

Example options usage:

gulp.src("src/js/main.js")
  .pipe(include({
    extensions: "js",
    hardFail: true,
    includePaths: [
      __dirname + "/bower_components",
      __dirname + "/src/js"
    ]
  }))
  .pipe(gulp.dest("dist/js"));

Include directives

gulp-include uses directives similar to sprockets or snockets. A directive is a comment in your files that gulp-include recognizes as a command.

Example directives:

//=require vendor/jquery.js
//=require vendor/**/*.js
//=include relative/path/to/file.js
/*=include relative/path/to/file.css */
#=include relative/path/to/file.coffee
<!--=include relative/path/to/file.html -->

The contents of the referenced file will replace the file.

require vs. include

A file that is included with require will only be included if it has not been included before. Files included with include will always be included.
For instance, let's say you want to include jquery.js only once, and before any of your other scripts in the same folder.

//=require vendor/jquery.js
//=require vendor/*.js

Note: This also works recursively. If for instance, for the example above, if another file in the folder vendor is also including jquery.js with the require-directive it will be ignored.

Changelog

For release notes see CHANGELOG.md.

Licence

(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.