browserify support

Author: kethinov

.gitignore

@@ -20,4 +20,4 @@ jsdoc
 
 nbproject
 
-.jscodehints
+.jscodehints

README.md

@@ -42,6 +42,7 @@ Table of contents
 - [License](https://github.com/kethinov/roosevelt#license)
 
 
+
 Why use Roosevelt?
 ===
 
@@ -56,6 +57,7 @@ Reasons for this include:
 - [LESS](http://lesscss.org) and [Closure Compiler](https://developers.google.com/closure/compiler) preconfigured out of the box to intelligently minify your external facing CSS and JS files.
 
 
+
 Create and run a Roosevelt app
 ===
 
@@ -181,6 +183,7 @@ Default directory structure
 - `.gitignore`: a standard file which contains a list of files and folders to ignore if your project is in a  git repo.
 
 
+
 Default .gitignore
 ---
 
@@ -193,6 +196,7 @@ Some notable things ignored by default and why:
 - `node_modules`: This folder will be auto-generated when you run the `npm install` step to set up your app. Since some modules you might include later in your app can be platform-specific and are compiled for your OS during the install step, it's generally <a href='https://npmjs.org/doc/faq.html'>not recommended</a> to commit the `node_modules` folder to git.
 
 
+
 Configure your app with parameters
 ===
 
@@ -244,6 +248,7 @@ App behavior parameters
   - Default: `{}`
 
 
+
 HTTPS parameters
 ---
 
@@ -268,6 +273,7 @@ HTTPS parameters
   - Default: `false`
 
 
+
 MVC parameters
 ---
 
@@ -284,13 +290,15 @@ MVC parameters
   - Default: `mvc/controllers`
 
 
+
 Utility library parameters
 ---
 
 - `libPath`: Relative path on filesystem to where your optional utility library files are located. Defaults to `lib` if not set.
 - `libPathNodeModulesSymlink`: Name of the symlink to make in `node_modules` pointing to your `lib` directory. Set to `false` to disable making this symlink. Defaults to `lib` if not set.
 
 
+
 Error page parameters
 ---
 
@@ -302,6 +310,7 @@ Error page parameters
   - Default: `503.js`
 
 
+
 Statics parameters
 ---
 
@@ -320,8 +329,15 @@ Statics parameters
   - Default: `.build/css`
 - `jsPath`: Subdirectory within `staticsRoot` where your JS files are located. By default this folder will not be made public, but is instead meant to store unminified JS source files which will be minified and stored elsewhere when the app is started.
   - Default: `js`
+- `bundledJsPath`: Subdirectory within `staticsRoot` where you would like [browserify](http://browserify.org) to deposit bundled JS files it produces (if you use browserify).
+  - Default: `js/.bundled`
+- `browserifyBundles`: Declare [browserify](http://browserify.org) bundles: one or more files in your `jsPath` for [browserify](http://browserify.org) to bundle via its [bundle method](https://github.com/substack/node-browserify#browserifyfiles--opts).
+  - Default: `[]`
+  - Example declaring one bundle: `[{outputFile: "bundle.js", files: ["landingPage.js", "main.js", "etc.js"], params: {someOpt: "someValue"}}]`
+  - Example declaring multiple bundles: `[{outputFile: "bundle1.js", files: ["landingPage.js", "main.js", "etc.js"], params: {someOpt: "someValue"}}, {outputFile: "bundle2.js", files: ["somethingElse.js", "anotherThing.js", "etc.js"]}, etc...]`
+  - Note: `params` is optional. If it is not set, these default params will be sent: `{paths: yourJsPath}`
 - `jsCompiler`: Which JS minifier, if any, to use. Must also be marked as a dependency in your app's package.json. Set to `none` to use no JS minifier.
-  - Default: `{nodeModule: 'roosevelt-closure', params: {compilationLevel: 'ADVANCED'}}`.
+  - Default: `{nodeModule: "roosevelt-closure", params: {compilationLevel: 'ADVANCED'}}`.
   - Also by default the module [roosevelt-closure](https://github.com/kethinov/roosevelt-closure) is marked as a dependency in package.json.
 - `jsCompilerWhitelist`: Whitelist of JS files to compile as an array. Leave undefined to compile all files. Supply a `:` character after each file name to delimit an alternate file path and/or file name for the minified file.
   - Default: `undefined`
@@ -330,6 +346,7 @@ Statics parameters
   - Default: `.build/js`
 
 
+
 Public folder parameters
 ---
 
@@ -349,6 +366,7 @@ Public folder parameters
   - Default: `false`
 
 
+
 Events
 ---
 
@@ -381,6 +399,7 @@ Event list
   - `res`: The [response object](http://expressjs.com/api.html#res.status) created by Express.
 
 
+
 Making controller files
 ===
 
@@ -473,6 +492,7 @@ In addition to exposing a number of variables to Express and providing the MVC i
 - Includes the [method-override](https://github.com/expressjs/method-override) middleware.
 
 
+
 Warning: Roosevelt is beta software!
 ===
 

lib/jsBundler.js

@@ -0,0 +1,49 @@
+// js bundler
+
+require('colors');
+
+var browserify = require('browserify'),
+    fs = require('fs'),
+    fse = require('fs-extra');
+
+module.exports = function(app, callback) {
+  var params = app.get('params'),
+      promises = [];
+
+  // make js directory if not present
+  if (!fs.existsSync(app.get('jsPath'))) {
+    fse.mkdirsSync(app.get('jsPath'));
+    console.log(('📁  ' + (app.get('package').name || 'Roosevelt') + ' making new directory ' + app.get('jsPath').replace(app.get('appDir'), '')).yellow);
+  }
+
+  // make js bundled output directory if not present
+  if (params.browserifyBundles.length && !fs.existsSync(params.bundledJsPath)) {
+    fse.mkdirsSync(params.bundledJsPath);
+    console.log(('📁  ' + (app.get('package').name || 'Roosevelt') + ' making new directory ' + app.get('appDir') + params.bundledJsPath.replace(app.get('appDir'), '')).yellow);
+  }
+
+  params.browserifyBundles.forEach(function(bundle) {
+    promises.push(function(bundle) {
+      return new Promise(function(resolve, reject) {
+        //console.log(app.get('staticsRoot') + app.get('jsPath'));
+        browserify(bundle.files, bundle.params ? bundle.params : {
+          paths: [app.get('jsPath')]
+        }).bundle(function(err, jsCode) {
+          if (err) {
+            console.error(('❌  ' + (app.get('appName') || 'Roosevelt') + ' failed to write new JS file ' + app.get('appDir') + params.bundledJsPath + '/' + bundle.outputFile + ' due to syntax errors in the source JavaScript\nError: ' + err.message).red);
+            throw err;
+          }
+          else {
+            console.log(('📝  ' + (app.get('appName') || 'Roosevelt') + ' writing new JS file ' + app.get('appDir') + params.bundledJsPath + '/' + bundle.outputFile).green);
+            fs.writeFileSync(params.bundledJsPath + '/' + bundle.outputFile, jsCode, 'utf8');
+          }
+          resolve();
+        });
+      });
+    }(bundle));
+  });
+
+  Promise.all(promises).then(function() {
+    callback();
+  });
+};

lib/jsCompiler.js

@@ -16,6 +16,7 @@ module.exports = function(app, callback) {
       promises = [];
 
   if (params.jsCompiler === 'none') {
+    callback();
     return;
   }
 
@@ -26,12 +27,8 @@ module.exports = function(app, callback) {
   catch (err) {
     console.error(('❌  ' + (app.get('appName') || 'Roosevelt') + ' failed to include your JS compiler! Please ensure that it is declared properly in your package.json and that it has been properly insalled to node_modules.').red);
     console.error(err);
-  }
-
-  // make js directory if not present
-  if (!fs.existsSync(app.get('jsPath'))) {
-    fse.mkdirsSync(app.get('jsPath'));
-    console.log(('📁  ' + (app.get('package').name || 'Roosevelt') + ' making new directory ' + app.get('jsPath').replace(app.get('appDir'), '')).yellow);
+    callback();
+    return;
   }
 
   // make js compiled output directory if not present

lib/sourceParams.js

@@ -39,6 +39,9 @@ module.exports = function(app) {
     multipart: params.multipart || pkg.rooseveltConfig.multipart || {'multiples': true},
     maxLagPerRequest: params.maxLagPerRequest || pkg.maxLagPerRequest || 2000,
     shutdownTimeout: params.shutdownTimeout || pkg.shutdownTimeout || 30000,
+    bodyParserUrlencodedParams: params.bodyParserUrlencodedParams || pkg.rooseveltConfig.bodyParserUrlencodedParams || { extended: true },
+    bodyParserJsonParams: params.bodyParserJsonParams || pkg.rooseveltConfig.bodyParserJsonParams || {},
+
     // https behavior - generally no defaults, user-defined
     https: params.https || pkg.rooseveltConfig.https || false,
     httpsOnly: params.httpsOnly || pkg.rooseveltConfig.httpsOnly || false,
@@ -49,16 +52,15 @@ module.exports = function(app) {
     ca: params.ca || pkg.rooseveltConfig.ca || null, // string or array of strings (file paths)
     requestCert: params.requestCert || pkg.rooseveltConfig.requestCert || false,
     rejectUnauthorized: params.rejectUnauthorized || pkg.rooseveltConfig.rejectUnauthorized || false,
-    bodyParserUrlencodedParams: params.bodyParserUrlencodedParams || pkg.rooseveltConfig.bodyParserUrlencodedParams || { extended: true },
-    bodyParserJsonParams: params.bodyParserJsonParams || pkg.rooseveltConfig.bodyParserJsonParams || {},
+
     // mvc
     modelsPath: params.modelsPath || pkg.rooseveltConfig.modelsPath || 'mvc/models',
     modelsNodeModulesSymlink: params.modelsNodeModulesSymlink || pkg.rooseveltConfig.modelsNodeModulesSymlink || 'models',
     viewsPath: params.viewsPath || pkg.rooseveltConfig.viewsPath || 'mvc/views',
     viewEngine: params.viewEngine || pkg.rooseveltConfig.viewEngine || 'html: teddy',
     controllersPath: params.controllersPath || pkg.rooseveltConfig.controllersPath || 'mvc/controllers',
 
-    // Utility lib
+    // utility lib
     libPath: params.libPath || pkg.rooseveltConfig.libPath || 'lib',
     libPathNodeModulesSymlink: params.libPathNodeModulesSymlink || pkg.rooseveltConfig.libPathNodeModulesSymlink || 'lib',
 
@@ -75,6 +77,8 @@ module.exports = function(app) {
     cssCompiledOutput: params.staticsRoot + (params.cssCompiledOutput || pkg.rooseveltConfig.cssCompiledOutput || '.build/css'),
     cssCompilerWhitelist: params.cssCompilerWhitelist || pkg.rooseveltConfig.cssCompilerWhitelist || undefined,
     jsPath: params.staticsRoot + (params.jsPath || pkg.rooseveltConfig.jsPath || 'js'),
+    bundledJsPath: params.staticsRoot + (params.bundledJsPath || pkg.rooseveltConfig.bundledJsPath || 'js/.bundled'),
+    browserifyBundles: params.browserifyBundles || pkg.rooseveltConfig.browserifyBundles || [],
     jsCompiler: params.jsCompiler || pkg.rooseveltConfig.jsCompiler || {nodeModule: 'roosevelt-closure', params: {compilationLevel: 'ADVANCED'}},
     jsCompiledOutput: params.staticsRoot + (params.jsCompiledOutput || pkg.rooseveltConfig.jsCompiledOutput || '.build/js'),
     jsCompilerWhitelist: params.jsCompilerWhitelist || pkg.rooseveltConfig.jsCompilerWhitelist || undefined,

package.json

@@ -2,29 +2,30 @@
   "name": "roosevelt",
   "description": "Roosevelt MVC web framework",
   "author": "Eric Newport <kethinov@gmail.com>",
-  "version": "0.7.5",
+  "version": "0.7.6",
   "homepage": "https://github.com/kethinov/roosevelt",
   "license": "CC-BY-4.0",
   "main": "roosevelt.js",
   "readmeFilename": "README.md",
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=6.0.0"
   },
   "engineStrict": true,
   "dependencies": {
     "body-parser": "^1.0.0",
+    "browserify": "^14.0.0",
     "colors": "^1.0.0",
     "compression": "^1.0.0",
     "cookie-parser": "^1.3.0",
     "express": "^4.0.0",
+    "express-minify-html": "^0.9.0",
     "formidable": "^1.0.0",
+    "fs-extra": "^1.0.0",
+    "html-validator": "^2.2.0",
     "method-override": "^2.0.0",
     "morgan": "^1.0.0",
     "parent-require": "^1.0.0",
-    "fs-extra": "^1.0.0",
-    "serve-favicon": "^2.3.0",
-    "express-minify-html": "^0.9.0",
-    "html-validator": "^2.2.0"
+    "serve-favicon": "^2.3.0"
   },
   "devDependencies": {
     "eslint": "^3.5.0"

roosevelt.js

@@ -119,7 +119,11 @@ module.exports = function(params) {
     preprocessCss();
 
     function preprocessCss() {
-      require('./lib/preprocessCss')(app, compileJs);
+      require('./lib/preprocessCss')(app, bundleJs);
+    }
+
+    function bundleJs() {
+      require('./lib/jsBundler')(app, compileJs);
     }
 
     function compileJs() {