nodeboilerplate - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

boilerplate/app.js

@@ -5,7 +5,11 @@ var express = require('express'),
 
+// Load express configuration
 require(__dirname + '/config/env.js')(express, app);
+
+// Load routes
 require(__dirname + '/routes')(app);
 
+// Start the server
 app.listen(opts.port);
 console.log("Express server listening on port %d in %s mode",
             app.address().port, app.settings.env);

boilerplate/config/env.js

@@ -0,13 +1,27 @@
+var util = require(__dirname + '/../libs/util.js');
+
 module.exports = function (express, app) {
 
+    // Common configuration
     app.configure(function () {
+
+        // Configure jQuery template engine
         app.set('views', __dirname + '/../views');
         app.set('view engine', 'jqtpl');
         app.register('.jqtpl', require('jqtpl').express);
-        app.use(express.compiler({
+
+        // Make sure build folders exist
+        util.mkdir(__dirname + '/../build');
+        util.mkdir(__dirname + '/../build/css');
+
+        // Configure LESS compiler
+        app.use('/css', express.compiler({
             enable: ['less'],
-            src: __dirname + '/../src/',
-            dest: __dirname + '/../build/'
+            src: __dirname + '/../src/less',
+            dest: __dirname + '/../build/css'
         }));
+
         app.use(app.router);
+
+        // Create static file servers for the build and public folders
         app.use(express.static(__dirname + '/../build'));
@@ -17,2 +31,3 @@ app.use(express.static(__dirname + '/../public'));
 
+    // Development specific configuration
     app.configure('development', function () {
@@ -25,2 +40,3 @@ app.use(express.errorHandler({
 
+    // Production specific configuration
     app.configure('production', function () {
@@ -27,0 +43,0 @@ app.use(express.errorHandler());

boilerplate/config/opts.js

@@ -0,6 +1,7 @@
+// Argument parsing using the optimist module
 module.exports = require('optimist')
-        .usage('Usage: $0 --port [port]')
-        .alias('port', 'p')
-        .describe('port', 'Port number for the Express application.')
-        .default('port', 3000)
-        .argv;
+    .usage('Usage: $0 --port [port]')
+    .alias('port', 'p')
+    .describe('port', 'Port number for the Express application.')
+    .default('port', 3000)
+    .argv;

boilerplate/routes/index.js

@@ -6,3 +6,3 @@ module.exports = function (app) {
 var index = function (req, res) {
-  res.render('index', { title: 'Node Boilerplate' });
+    res.render('index', { title: 'Node Boilerplate' });
 };

package.json

 {
   "name": "nodeboilerplate",
   "description": "Boilerplate Node Application",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "Brian Stone",
@@ -6,0 +6,0 @@ "keywords": ["boilerplate", "nodeboilerplate", "template"],

README.md

@@ -22,2 +22,7 @@ Node Boilerplate
 
+Documentation
+-------------
+
+[Annotated Source](http://stonebk.github.com/nodeboilerplate/)
+
 Configuration
@@ -24,0 +29,0 @@ -------------

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19385

increased by151.79%

Number of package files

15

increased by25%

Lines of code

70

increased by66.67%

Number of lines in readme file

63

increased by8.62%

Worsened metrics

Number of low supply chain risk alerts

6

increased by50%

No dependency changes