Add config options to allow consistent bundle file content ordering. F…

…ixes #25

examples/full/bundle.config.js

@@ -130,6 +130,53 @@ module.exports = {
         rev: prodLikeEnvs,
         maps: false // {(boolean)} disable sourcemaps
       }
+    },
+    'ordered-bundle': {
+      scripts: [
+        {
+          src: './ordered_bundle/bower_components/jquery.js',
+          minSrc: './ordered_bundle/bower_components/jquery.min.js'
+        },
+        './ordered_bundle/vendor/*.js',
+        './ordered_bundle/content/*.coffee',
+        './ordered_bundle/content/*.js'
+      ],
+      styles: [
+        {
+          src: './ordered_bundle/bower_components/bootstrap.css',
+          minSrc: './ordered_bundle/bower_components/bootstrap.min.css'
+        },
+        './ordered_bundle/vendor/*.css',
+        './ordered_bundle/content/*.less',
+        './ordered_bundle/content/*.css'
+      ],
+      options: {
+        useMin: prodLikeEnvs,
+        order: {
+          scripts: [
+            '**/always-first.js',  // from /content
+            '**/jquery*.js',       // depending on env, this could be streaming min or non-min file so use trailing *
+            '**/lodash.js',        // from /vendor
+            '**/file1.js',         // compiled from file1.coffee
+            '**/file2.js',         // compiled from file2.coffee
+            '!**/always-last.js',  // everything else except always-last.js
+            '**/always-last.js'    // from /content
+          ],
+          styles: [
+            '**/always-first.css',  // from /content
+            '**/bootstrap*.css',    // depending on env, this could be streaming min or non-min file so use trailing *
+            '**/vendor.css',        // from /vendor
+            '**/file1.css',         // compiled from file1.less
+            '**/file2.css',         // compiled from file2.less
+            '!**/always-last.css',  // everything else except always-last.css
+            '**/always-last.css'    // from /content
+          ]
+        },
+        transforms: {
+          scripts: transformHelper.coffee(),
+          styles: transformHelper.less()
+        }
+      }
     }
   },
   copy: [

examples/full/manifest.json

@@ -17,5 +17,9 @@
   "main": {
     "scripts": "<script src='/public/main-a2f0720d62.js' type='text/javascript'></script>",
     "styles": "<link href='/public/main-56c9e7f7a2.css' media='all' rel='stylesheet' type='text/css'/>"
+  },
+  "ordered-bundle": {
+    "styles": "<link href='/public/ordered-bundle-421fc9b36f.css' media='all' rel='stylesheet' type='text/css'/>",
+    "scripts": "<script src='/public/ordered-bundle-cbd3c3edb4.js' type='text/javascript'></script>"
   }
 }

examples/full/ordered_bundle/bower_components/bootstrap.css

@@ -0,0 +1,3 @@
+.bootstrap {
+  background-color: orange;
+}

examples/full/ordered_bundle/bower_components/bootstrap.min.css

@@ -0,0 +1 @@
+.bootstrap-min {background-color: coral;}

examples/full/ordered_bundle/bower_components/jquery.js

@@ -0,0 +1 @@
+console.log("jquery");

examples/full/ordered_bundle/bower_components/jquery.min.js

@@ -0,0 +1 @@
+console.log("jquery.min");

examples/full/ordered_bundle/content/always-first.css

@@ -0,0 +1,3 @@
+.always-first {
+  background-color: red;
+}

examples/full/ordered_bundle/content/always-first.js

@@ -0,0 +1 @@
+console.log("first");

examples/full/ordered_bundle/content/always-last.css

@@ -0,0 +1,3 @@
+.always-last {
+  background-color: green;
+}

examples/full/ordered_bundle/content/always-last.js

@@ -0,0 +1 @@
+console.log("last");

examples/full/ordered_bundle/content/file1.coffee

@@ -0,0 +1 @@
+fileName = 'file1.coffee'

examples/full/ordered_bundle/content/file1.less

@@ -0,0 +1,3 @@
+.file1-less {
+  background-color: purple;
+}

examples/full/ordered_bundle/content/file2.coffee

@@ -0,0 +1 @@
+fileName = 'file2.coffee'

examples/full/ordered_bundle/content/file2.less

@@ -0,0 +1,3 @@
+.file2-less {
+  background-color: yellow;
+}

examples/full/ordered_bundle/content/for-the-middle.css

@@ -0,0 +1,3 @@
+.something-in-the-middle {
+  background-color: blue;
+}

examples/full/ordered_bundle/content/for-the-middle.js

@@ -0,0 +1 @@
+console.log("something in the middle");

examples/full/ordered_bundle/vendor/lodash.js

@@ -0,0 +1 @@
+console.log("lodash");

examples/full/ordered_bundle/vendor/vendor.css

@@ -0,0 +1,3 @@
+.vendor {
+  background-color: wheat;
+}

examples/guarantee-content-order/README.md

@@ -0,0 +1,44 @@
+# Guarantee Bundle Content Order
+
+The bundle config supports ordering the src files via `gulp-order` syntax (e.g. wildcards, etc). See here for details on syntax: https://github.com/sirlantis/gulp-order
+
+To use simply add your ordering array to the `order` option:
+
+```js
+module.exports = {
+  bundle: {
+    main: {
+      scripts: [
+        {
+          src: './vendor/second.js',
+          minSrc: './vendor/second.min.js'
+        },
+        './a/*.coffee',
+        './content/**/*.coffee',
+        './content/**/*.js'
+      ]
+      options: {
+        order: {
+          scripts: [
+            '**/always-first.js', // from /content
+            '**/second*.js',      // depending on env, this could be streaming min or non-min file so use trailing *
+            '**/third.js',        // compiled from third.coffee
+            '**/fourth.js',       // compiled from fourth.coffee
+            '!**/always-last.js', // everything else except always-last.js
+            '**/always-last.js'   // from /content
+          ]
+        },
+        transforms: {
+          scripts: transformHelper.coffee()
+        }
+      }
+    }
+  }
+};
+
+```
+
+### Examples
+
+* This example [`bundle.config.js`](bundle.config.js#L25)
+* full example [`bundle.config.js`](../full/bundle.config.js#L155)

examples/guarantee-content-order/a/fourth.coffee

@@ -0,0 +1 @@
+fileName = 'fourth'

examples/guarantee-content-order/a/fourth.less

@@ -0,0 +1,3 @@
+.fourth {
+  background-color: purple;
+}

examples/guarantee-content-order/bundle.config.js

@@ -0,0 +1,51 @@
+var transformHelper = require('../../index.js').transformHelper;
+
+module.exports = {
+  bundle: {
+    'ordered-bundle': {
+      scripts: [
+        {
+          src: './vendor/second.js',
+          minSrc: './vendor/second.min.js'
+        },
+        './a/*.coffee',
+        './content/**/*.coffee',
+        './content/**/*.js'
+      ],
+      styles: [
+        {
+          src: './vendor/second.css',
+          minSrc: './vendor/second.min.css'
+        },
+        './a/*.less',
+        './content/**/*.less',
+        './content/**/*.css'
+      ],
+      options: {
+        order: {
+          scripts: [
+            '**/always-first.js', // from /content
+            '**/second*.js',      // depending on env, this could be streaming min or non-min file so use trailing *
+            '**/third.js',        // compiled from third.coffee
+            '**/fourth.js',       // compiled from fourth.coffee
+            '!**/always-last.js', // everything else except always-last.js
+            '**/always-last.js'   // from /content
+          ],
+          styles: [
+            '**/always-first.css',  // from /content
+            '**/second*.css',       // depending on env, this could be streaming min or non-min file so use trailing *
+            '**/third.css',         // compiled from third.less
+            '**/fourth.css',        // compiled from fourth.less
+            '!**/always-last.css',  // everything else except always-last.css
+            '**/always-last.css'    // from /content
+          ]
+        },
+        useMin: 'production',
+        transforms: {
+          scripts: transformHelper.coffee(),
+          styles: transformHelper.less()
+        }
+      }
+    }
+  }
+};

examples/guarantee-content-order/content/always-last.css

@@ -0,0 +1,3 @@
+.always-last {
+  background-color: green;
+}

examples/guarantee-content-order/content/always-last.js

@@ -0,0 +1 @@
+console.log('last');

examples/guarantee-content-order/content/fifth.css

@@ -0,0 +1,3 @@
+.fifth {
+  background-color: blue;
+}

examples/guarantee-content-order/content/fifth.js

@@ -0,0 +1 @@
+console.log('fifth');

examples/guarantee-content-order/content/sub/folder/always-first.css

@@ -0,0 +1,3 @@
+.always-first {
+  background-color: red;
+}

examples/guarantee-content-order/content/sub/folder/always-first.js

@@ -0,0 +1 @@
+console.log('first');

examples/guarantee-content-order/content/third.coffee

@@ -0,0 +1 @@
+fileName = 'third'

examples/guarantee-content-order/content/third.less

@@ -0,0 +1,3 @@
+.third {
+  background-color: yellow;
+}

examples/guarantee-content-order/gulpfile.js

@@ -0,0 +1,17 @@
+var gulp = require('gulp'),
+  del = require('del'),
+  bundle = require('../../index');
+
+gulp.task('bundle', ['clean'], function () {
+  return gulp.src('./bundle.config.js')
+    .pipe(bundle())
+    .pipe(gulp.dest('./dist'));
+});
+
+gulp.task('clean', function (cb) {
+  del([
+    './dist'
+  ], cb);
+});
+
+gulp.task('default', ['bundle']);

examples/guarantee-content-order/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "guarantee-content-order",
+  "version": "1.0.0",
+  "description": "",
+  "main": "bundle.config.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "del": "^1.2.0",
+    "gulp": "^3.9.0"
+  }
+}

examples/guarantee-content-order/vendor/second.css

@@ -0,0 +1,3 @@
+.second {
+  background-color: orange;
+}

examples/guarantee-content-order/vendor/second.js

@@ -0,0 +1 @@
+console.log('second');

examples/guarantee-content-order/vendor/second.min.css

@@ -0,0 +1 @@
+.second-min {background-color: coral;}

examples/guarantee-content-order/vendor/second.min.js

@@ -0,0 +1 @@
+console.log('second.min');

lib/init-option-defaults.js

@@ -11,4 +11,5 @@ module.exports = function (bundle) {
   bundle[BundleKeys.OPTIONS].pluginOptions['gulp-minify-css'] = bundle[BundleKeys.OPTIONS].pluginOptions['gulp-minify-css'] || {};
   bundle[BundleKeys.OPTIONS].pluginOptions['gulp-uglify'] = bundle[BundleKeys.OPTIONS].pluginOptions['gulp-uglify'] || {};
   bundle[BundleKeys.OPTIONS].pluginOptions['gulp-concat'] = bundle[BundleKeys.OPTIONS].pluginOptions['gulp-concat'] || {};
+  bundle[BundleKeys.OPTIONS].order = bundle[BundleKeys.OPTIONS].order || {};
 };