Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/urish/gulp-add-src

Add more 'src' files at any point in the pipeline (gulp plugin)
https://github.com/urish/gulp-add-src

Last synced: about 2 months ago
JSON representation

Add more 'src' files at any point in the pipeline (gulp plugin)

Awesome Lists containing this project

README

        

gulp-add-src
============

Add more 'src' files at any point in the pipeline

Copyright (C) 2014, Uri Shaked and contributors

[![Build Status](https://travis-ci.org/urish/gulp-add-src.png?branch=master)](https://travis-ci.org/urish/gulp-add-src)

Installation
------------

`npm install gulp-add-src --save-dev`

Usage
-----
Works like `gulp.src`, but you can put it anywhere in your pipeline and it will append the given files
to the pipeline.

Example:
```js
var gulp = require('gulp');
var addsrc = require('gulp-add-src');
var coffee = require('gulp-coffee');
var uglify = require('gulp-uglify');

gulp.task('build', function () {
return gulp.src('files/coffee/*.coffee') // start with the .coffee files in the project
.pipe(coffee()) // compiles coffee script
.pipe(addsrc('files/js/*.js')) // we use addsrc to add our .js files to the mix
.pipe(uglify()) // we minify everything
.pipe(gulp.dest('dist')); // and write to dist
});
```

If you want add SRC to begining of the SRC array, you can use `addsrc.prepend`.
Or if you want to add SRC to end of the SRC array, you can use `addsrc.append`.
Respectively instead of addsrc.

Example use addsrc.append and addsrc.prepend:
```js
var gulp = require('gulp');
var addsrc = require('gulp-add-src');
var coffee = require('gulp-coffee');
var uglify = require('gulp-uglify');

gulp.task('build.angular', function () {
return gulp.src('files/coffee/*.coffee') // start with the .coffee files in the project
.pipe(coffee()) // compiles coffee script
.pipe(addsrc.prepend('files/js/constants.js')) // we use `addsrc.prepend` to add our .js files to begining of the SRC array
.pipe(addsrc.append('files/js/conflict.js')) // we use `addsrc.append` to add our .js files to end of the SRC array
.pipe(uglify()) // we minify everything
.pipe(gulp.dest('dist')); // and write to dist
});
```

As an example, this would be useful if you wanted to merge your `bower` scripts with your app scripts. You'd need your `bower` scripts to maintain their order (the `bower` scripts themselves) and make sure they come before your app scripts. In this case, you'd use `addsrc.prepend`.

Because of the unpredicabilty of `addsrc` alone, it's recommended to use one of the append/prepend variants. The original is only left in place for legacy reasons.

License
----

Released under the terms of MIT License:

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.