gulp-deporder

Gulp DepOrder plugin

This plugin will reorder JavaScript or CSS files in the stream based on comments at the top of files. This is useful for automatically ordering files before concatenating them without a full-blown dependency system like requirejs.

The plugin attempts to reorder as little as possible so you can manually order large sets of files and only use the comments to fine tune.

How to use

Gulp

For JavaScript files:

var deporder = require('gulp-deporder');
var concat = require('gulp-concat');
 
gulp.task('scripts', function() {
    return gulp.src('./lib/*.js')
        .pipe(deporder())
        .pipe(concat('all.js'))
        .pipe(gulp.dest('./dist/'))
});

For CSS files:

var deporder = require('gulp-deporder');
var concat = require('gulp-concat');
 
gulp.task('styles', function() {
    return gulp.src('./lib/*.css')
        .pipe(deporder())
        .pipe(concat('all.css'))
        .pipe(gulp.dest('./dist/'))
});

JavaScript

There is several ways to specify dependencies: First is single-line: // requires: foo.js bar.js Second is multi-line if you have lot of dependencies:

/* requires:
foo.js
bar.js
*/

CSS

Since CSS doesn't support single-line comments, you should only use multi-line comments:

/* requires:
foo.css
bar.css
*/

Write less, do more

You also need know, that all examples above uses requires: foo.js, but you can also use it without trailing "s", like require: foo.js or even without colon like requires foo.js or require foo.js. And, of course, in multi-line style you can use spaces to indent your dependencies, like:

/* require
  foo/bar.js
      bar/foo.js
*/

All of those spaces will be cleaned and dependencies are processed correctly.

LICENSE

(MIT License)

Copyright (c) 2014 Michael Kleehammer [e-mail]

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.