Minor code cleanup, docs and other bits & pieces

Gruntfile.js

@@ -168,7 +168,7 @@ var path = require('path'),
                             "core/client/**/*.js"
                         ],
                         "except": [
-                            "!core/client/assets/**/*.js",
+                            "!core/**/vendor/**/*.js",
                             "!core/client/tpl/**/*.js"
                         ]
                     }

config.js

@@ -1,58 +1,43 @@
 // # Ghost Configuration
 
-/**
- * global module
- **/
 var path = require('path'),
-    config;
-
-/**
- * @module config
- * @type {Object}
- */
-config = {};
+    config  = {};
 
 // ## Admin settings
 
-/**
- * @property {string} defaultLang
- */
+// Default language
 config.defaultLang = 'en';
 
-/**
- * @property {boolean} forceI18n
- */
+// Force i18n to be on
 config.forceI18n = true;
 
-// ## Themes
-
-/**
- * @property {string} themeDir
- */
+// ## Themes & Plugins
 
-// Themes
+// Themes directory, relative to `content/`
 config.themeDir = 'themes';
 
 // Current active theme
-/**
- * @property {string} activeTheme
- */
 config.activeTheme = 'casper';
 
-
+// Current active plugins
 config.activePlugins = [
     'FancyFirstChar'
 ];
 
-// Default Navigation Items
-/**
- * @property {Array} nav
- */
-config.nav = [{
-    title: 'Home',
-    url: '/'
-}];
+// ## Default Navigation Items
+// Add new objects here to extend the menu output by {{nav}}
+config.nav = [
+    {
+        // Title is the text shown for this nav item
+        title: 'Home',
+        // Url can be a relative path, or external URL
+        url: '/'
+    }
+    // new items go here
+];
 
+// ## Environment
+// **Warning:** Only change the settings below here if you are sure of what you are doing!
 config.env = {
     testing: {
         database: {
@@ -80,6 +65,7 @@ config.env = {
         }
     },
 
+    // Default configuration
     development: {
         database: {
             client: 'sqlite3',
@@ -123,7 +109,5 @@ config.env = {
     }
 };
 
-/**
- * @property {Object} exports
- */
+// Export config
 module.exports = config;

core/client/views/settings.js

@@ -14,10 +14,6 @@
                 pane: options.pane,
                 model: this.model
             }));
-
-            this.$('input').iCheck({
-                checkboxClass: 'icheckbox_ghost'
-            });
         }
     });
 
@@ -93,6 +89,10 @@
         afterRender: function () {
             this.$el.attr('id', this.id);
             this.$el.addClass('active');
+
+            this.$('input').iCheck({
+                checkboxClass: 'icheckbox_ghost'
+            });
         },
         saveSuccess: function () {
             Ghost.notifications.addItem({
@@ -143,9 +143,8 @@
         },
 
         afterRender: function () {
-            this.$el.attr('id', this.id);
-            this.$el.addClass('active');
             this.$('.js-drop-zone').upload();
+            Settings.Pane.prototype.afterRender.call(this);
         }
     });
 
@@ -224,27 +223,22 @@
                     ne2password: ne2Password
                 },
                 success: function (msg) {
-
-                    self.addSubview(new Ghost.Views.NotificationCollection({
-                        model: [{
-                            type: 'success',
-                            message: msg.msg,
-                            status: 'passive',
-                            id: 'success-98'
-                        }]
-                    }));
+                    Ghost.notifications.addItem({
+                        type: 'success',
+                        message: msg.msg,
+                        status: 'passive',
+                        id: 'success-98'
+                    });
                     self.$('#user-password-old').val('');
                     self.$('#user-password-new').val('');
                     self.$('#user-new-password-verification').val('');
                 },
                 error: function (obj, string, status) {
-                    self.addSubview(new Ghost.Views.NotificationCollection({
-                        model: [{
-                            type: 'error',
-                            message: 'Invalid username or password',
-                            status: 'passive'
-                        }]
-                    }));
+                    Ghost.notifications.addItem({
+                        type: 'error',
+                        message: 'Invalid username or password',
+                        status: 'passive'
+                    });
                 }
             });
         },

core/ghost.js

@@ -1,7 +1,7 @@
 // # Ghost Module
-// Defines core methods required to build the frontend
+// Defines core methods required to build the application
 
-// ## Setup Prerequisites
+// Module dependencies
 var config = require('./../config'),
     when = require('when'),
     express = require('express'),
@@ -12,12 +12,11 @@ var config = require('./../config'),
     nodefn = require('when/node/function'),
     _ = require('underscore'),
     Polyglot = require('node-polyglot'),
-
     models = require('./server/models'),
-
     plugins = require('./server/plugins'),
-
     requireTree = require('./server/require-tree'),
+
+// Variables
     themePath = path.resolve(__dirname + '../../content/themes'),
     pluginPath = path.resolve(__dirname + '../../content/plugins'),
     themeDirectories = requireTree(themePath),
@@ -79,16 +78,12 @@ Ghost = function () {
         // Holds the persistent notifications
         instance.notifications = [];
 
+        // Holds the available plugins
         instance.availablePlugins = {};
 
         app = express();
-
         polyglot = new Polyglot();
 
-        // functionality
-        // load Plugins...
-        // var f = new FancyFirstChar(ghost).init();
-
         _.extend(instance, {
             app: function () { return app; },
             config: function () { return config; },
@@ -120,6 +115,7 @@ Ghost = function () {
     return instance;
 };
 
+// Initialise the application
 Ghost.prototype.init = function () {
     var self = this;
 
@@ -130,6 +126,7 @@ Ghost.prototype.init = function () {
     }, errors.logAndThrowError);
 };
 
+// Maintain the internal cache of the settings object
 Ghost.prototype.updateSettingsCache = function (settings) {
     var self = this;
 
@@ -154,12 +151,14 @@ Ghost.prototype.updateSettingsCache = function (settings) {
 
 // ## Template utils
 
+// Compile a template for a handlebars helper
 Ghost.prototype.compileTemplate = function (templatePath) {
     return nodefn.call(fs.readFile, templatePath).then(function (templateContents) {
         return hbs.handlebars.compile(templateContents.toString());
     }, errors.logAndThrowError);
 };
 
+// Load a template for a handlebars helper
 Ghost.prototype.loadTemplate = function (name) {
     var self = this,
         templateFileName = name + '.hbs',
@@ -181,38 +180,12 @@ Ghost.prototype.loadTemplate = function (name) {
     return deferred.promise;
 };
 
-/**
- * @param  {string}   name
- * @param  {Function} fn
- * @return {method}  hbs.registerHelper
- */
+// Register a handlebars helper for themes
 Ghost.prototype.registerThemeHelper = function (name, fn) {
     hbs.registerHelper(name, fn);
 };
 
-/**
- * @param  {string}   name
- * @param  {Function} fn
- * @return {*}
- */
-Ghost.prototype.registerTheme = function (name, fn) {
-    return this;
-};
-
-/**
- * @param  {string}   name
- * @param  {Function} fn
- * @return {*}
- */
-Ghost.prototype.registerPlugin = function (name, fn) {
-    return this;
-};
-
-/**
- * @param  {string}   name
- * @param  {integer}  priority
- * @param  {Function} fn
- */
+// Register a new filter callback function
 Ghost.prototype.registerFilter = function (name, priority, fn) {
     // Curry the priority optional parameter to a default of 5
     if (_.isFunction(priority)) {
@@ -226,11 +199,7 @@ Ghost.prototype.registerFilter = function (name, priority, fn) {
     this.filterCallbacks[name][priority].push(fn);
 };
 
-/**
- * @param  {string}   name
- * @param  {integer}  priority
- * @param  {Function} fn
- */
+// Unregister a filter callback function
 Ghost.prototype.unregisterFilter = function (name, priority, fn) {
     // Curry the priority optional parameter to a default of 5
     if (_.isFunction(priority)) {
@@ -245,12 +214,7 @@ Ghost.prototype.unregisterFilter = function (name, priority, fn) {
     }
 };
 
-/**
- * @param  {string}   name     [description]
- * @param  {*}   args
- * @param  {Function} callback
- * @return {method} callback
- */
+// Execute filter functions in priority order
 Ghost.prototype.doFilter = function (name, args, callback) {
     var callbacks = this.filterCallbacks[name];
 
@@ -279,11 +243,7 @@ Ghost.prototype.doFilter = function (name, args, callback) {
     callback(args);
 };
 
-/**
- * Initialise plugins.  Will load from config.activePlugins by default
- * 
- * @param {Array} pluginsToLoad
- */
+// Initialise plugins.  Will load from config.activePlugins by default
 Ghost.prototype.initPlugins = function (pluginsToLoad) {
     pluginsToLoad = pluginsToLoad || config.activePlugins;
 
@@ -295,11 +255,7 @@ Ghost.prototype.initPlugins = function (pluginsToLoad) {
     }, errors.logAndThrowError);
 };
 
-/**
- * Initialise Theme
- *
- * @param  {Object} app
- */
+// Initialise Theme or admin
 Ghost.prototype.initTheme = function (app) {
     var self = this;
     return function initTheme(req, res, next) {
@@ -329,4 +285,4 @@ Ghost.prototype.initTheme = function (app) {
 // TODO: Expose the defaults for other people to see/manipulate as a static value?
 // Ghost.defaults = defaults;
 
-module.exports = Ghost;
+module.exports = Ghost;