whitespace, trailing space, and doc fixes

bin/roots

@@ -28,4 +28,3 @@ if (!args.quiet) {
 
 // pass the arguments to the cli module
 cli.execute(args, notifier.packageFile)
-

docs/conf.py

@@ -32,7 +32,7 @@
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
- 
+
 # The suffix of source filenames.
 source_suffix = '.rst'
 

docs/configuration.rst

@@ -46,7 +46,7 @@ An array containing `minimatch <https://github.com/isaacs/minimatch>`_ strings t
 
 **dump_dirs**
 
-Array of directories that will have their contents dumped into the output folder rather than compiling into the folder they are in. 
+Array of directories that will have their contents dumped into the output folder rather than compiling into the folder they are in.
 *default: ``['views', 'assets']``*
 
 **env**

docs/environments.rst

@@ -22,7 +22,7 @@ To compile with an environment, you can pass an ``--env`` or ``-e`` flag to the
 If you are using the javascript api, you can pass an ``env`` option to the ``Roots`` constructor as such:
 
 .. code-block:: javascript
-  
+
   var Roots = require('roots');
   var project = new Roots(__dirname, { env: 'production' })
 

docs/extensions.rst

@@ -228,7 +228,7 @@ There is one more hook you can use that will fire only when all the files in a g
 
     module.exports = ->
       class FooBar
-        
+
         category_hooks: ->
           after: (ctx, category) ->
             console.log "finished up with #{category}!"
@@ -263,7 +263,7 @@ For example, if you were making an extension that collected all the contents of
   nodefn = require('when/node/function')
   path = require('path')
   fs = require('fs')
-  
+
   module.exports (opts) = ->
 
     class JSConcat
@@ -296,7 +296,7 @@ What we have here is a simple extension that concatenates js files into a single
   nodefn = require('when/node/function')
   path = require('path')
   fs = require('fs')
-  
+
   module.exports (opts) = ->
     contents = ''
 

lib/api/compile.coffee

@@ -1,10 +1,10 @@
-fs       = require 'fs'
-W        = require 'when'
-nodefn   = require 'when/node'
-guard    = require 'when/guard'
-keys     = require 'when/keys'
+fs = require 'fs'
+W = require 'when'
+nodefn = require 'when/node'
+guard = require 'when/guard'
+keys = require 'when/keys'
 sequence = require 'when/sequence'
-mkdirp   = require 'mkdirp'
+mkdirp = require 'mkdirp'
 
 FSParser = require '../fs_parser'
 Compiler = require '../compiler'
@@ -18,23 +18,20 @@ class Compile
 
   ###*
    * Creates a new instance of the compile class.
-   * 
    * - makes a new fs parser instance
    * - makes a new compiler instance
    * - makes a new instance of each extension, with error detection.
    *   this must happen every compile pass to clear lingering context
-   * 
-   * @param  {Function} roots - instance of the base roots class
+   * @param {Function} roots - instance of the base roots class
   ###
-  
+
   constructor: (@roots) ->
     @extensions = @roots.extensions.instantiate()
     @fs_parser = new FSParser(@roots, @extensions)
     @compiler = new Compiler(@roots, @extensions)
 
   ###*
    * Compiles the project. This process includes the following steps:
-   *
    * - execute user before hooks if present
    * - parse the project, sort files into categories
    * - create the folder structure
@@ -59,7 +56,6 @@ class Compile
 
   ###*
    * Calls any user-provided before hooks with the roots context.
-   *
    * @private
   ###
 
@@ -68,7 +64,6 @@ class Compile
 
   ###*
    * Calls any user-provided after hooks with the roots context.
-   *
    * @private
   ###
 
@@ -77,12 +72,10 @@ class Compile
 
   ###*
    * Checks to ensure the requested hook(s) is/are present, then calls them,
-   * whether there was an array of hooks provided or just a single hook.
-   *
-   * @private
-   * 
-   * @param  {Array|Function} hook - a function or array of functions
+     whether there was an array of hooks provided or just a single hook.
+   * @param {Array|Function} hook - a function or array of functions
    * @return {Promise} promise for resolved hooks
+   * @private
   ###
 
   hook_method = (hook) ->
@@ -99,8 +92,7 @@ class Compile
 
   ###*
    * If present, runs an async-compatible `setup` function in each extension,
-   * ensuring that any asynchrnonous setup the extension needs is completed.
-   * 
+     ensuring that any asynchrnonous setup the extension needs is completed.
    * @return {Promise} a promise that the extension setup is finished
   ###
 
@@ -109,11 +101,10 @@ class Compile
     W.map(req_setup, ((ext) -> ext.setup()))
 
   ###*
-   * Creates the nested folder structure for a project. First, creates an array
-   * of just the output paths, then creates the base public folder, then
-   * sequentially walks through the folders and creates them all.
-   * 
-   * @param  {Object} ast - roots ast
+   * Creates the nested folder structure for a project. First, creates an
+     array of just the output paths, then creates the base public folder, then
+     sequentially walks through the folders and creates them all.
+   * @param {Object} ast - roots ast
   ###
 
   create_folders = (ast) ->
@@ -125,28 +116,26 @@ class Compile
 
   ###*
    * Files are processed by category, and each category can be processed in
-   * One of two ways: parallel or ordered. Parallel processed categories will
-   * crunch through their files as quickly as possible, starting immediately.
-   * Ordered categories will parallel compile all the files in the category, but
-   * wait until one category is finished before moving to the next one.
-   *
-   * An example use for each of these is client templates and dynamic content.
-   * With client templates, they do not depend on any other compile process so
-   * they are a great fit for parallel. For dynamic content, the front matter must
-   * be parsed then available in normal templates, which means all dynamic content
-   * must be finished parsing before normal content starts. For this reason, dynamic
-   * content has to be ordered so it is placed before the normal compiles.
-   *
-   * So what this function does is first distinguishes ordered or parallel for each
-   * extension, then pushes a compile task for that extension onto the appropriate
-   * stack. The compile task just grabs the files from the category and runs them
-   * each through the compiler's `compile` method. Then when they are finished, it
-   * runs the after category hook.
-   *
-   * Once the ordered and parallel stacks are full of tasks, they are run. Ordered
-   * gets sequenced so they run in order, and parallel runs (surprise) in parallel.
-   * 
-   * @param  {Object} ast - roots ast
+     One of two ways: parallel or ordered. Parallel processed categories will
+     crunch through their files as quickly as possible, starting immediately.
+     Ordered categories will parallel compile all the files in the category,
+     but wait until one category is finished before moving to the next one. An
+     example use for each of these is client templates and dynamic content.
+     With client templates, they do not depend on any other compile process so
+     they are a great fit for parallel. For dynamic content, the front matter
+     must be parsed then available in normal templates, which means all
+     dynamic content must be finished parsing before normal content starts.
+   * For this reason, dynamic content has to be ordered so it is placed before
+     the normal compiles. So what this function does is first distinguishes
+     ordered or parallel for each extension, then pushes a compile task for
+     that extension onto the appropriate stack. The compile task just grabs
+     the files from the category and runs them each through the compiler's
+     `compile` method. Then when they are finished, it runs the after category
+     hook.
+   * Once the ordered and parallel stacks are full of tasks, they are run.
+     Ordered gets sequenced so they run in order, and parallel runs (surprise)
+     in parallel.
+   * @param {Object} ast - roots ast
   ###
 
   process_files = (ast) ->
@@ -179,16 +168,14 @@ class Compile
       parallel: W.all(parallel)
 
   ###*
-   * Sometimes extensions prevent file writes and leave behind empty
-   * folders. The client templates extension is a good example. No matter
-   * how it happens, there should not be any empty folders in the output,
-   * so this method gets rid of them if they exist.
-   *
+   * Sometimes extensions prevent file writes and leave behind empty folders.
+     The client templates extension is a good example. No matter how it
+     happens, there should not be any empty folders in the output, so this
+     method gets rid of them if they exist.
    * The way this is done is *very* hacky, but it is the speediest way. It
-   * tries to delete every folder, and if it succeeds, it means the folder was
-   * empty, as trying to remove a directory with contents throws an error (which
-   * we ignore using an empty callback).
-   * 
+     tries to delete every folder, and if it succeeds, it means the folder was
+     empty, as trying to remove a directory with contents throws an error
+     (which we ignore using an empty callback).
    * @private
   ###
 

lib/api/new.coffee

@@ -1,12 +1,12 @@
-path           = require 'path'
-fs             = require 'fs'
+path = require 'path'
+fs = require 'fs'
 {EventEmitter} = require('events')
-exec           = require('child_process').exec
-nodefn         = require 'when/node'
-sprout         = require 'sprout'
-global_config  = require '../global_config'
-_              = require 'lodash'
-npm            = require 'npm'
+exec = require('child_process').exec
+nodefn = require 'when/node'
+sprout = require 'sprout'
+global_config = require '../global_config'
+_ = require 'lodash'
+npm = require 'npm'
 
 ###*
  * @class New
@@ -19,23 +19,25 @@ class New extends EventEmitter
     @base_url = 'https://github.com/roots-dev/base.git'
 
   ###*
-   * Main method, given a path to where the project should be and some (optional)
-   * additional options, creates a new project template. If no template is provided,
-   * uses the roots default template, which is installed if not present. Once the
-   * template is created, installs dependencies if a package.json is present.
-   *
-   * @param  {Object} opts - Arguments object, takes the following:
-   *                       - path: path to nonexistant folder where project should be
-   *                       - template: name of the template to use for the project
-   *                       - options: overrides for template config
-   *                       - defaults: default values for template config
+   * Main method, given a path to where the project should be and some
+     (optional) additional options, creates a new project template. If no
+     template is provided, uses the roots default template, which is installed
+     if not present. Once the template is created, installs dependencies if a
+     package.json is present.
+   * @param {Object} opts - Arguments object, takes the following:
+   * @param {string} opts.path - path to nonexistant folder where project
+     should be
+   * @param {string} opts.template - name of the template to use for the
+     project
+   * @param {Object} opts.options - overrides for template config
+   * @param {Object} opts.defaults - default values for template config
   ###
 
   exec: (opts) ->
-    @path      = opts.path     || throw new Error('missing path')
-    @template  = opts.template || global_config().get('default_template')
-    @overrides = opts.options  || {}
-    @defaults  = opts.defaults || {}
+    @path = opts.path || throw new Error('missing path')
+    @template = opts.template || global_config().get('default_template')
+    @overrides = opts.options || {}
+    @defaults = opts.defaults || {}
 
     @pkg = path.join(@path, 'package.json')
     @defaults.name = opts.name
@@ -52,8 +54,7 @@ class New extends EventEmitter
 
   ###*
    * Uses sprout.init to create a project template, emits events, and installs
-   * dependencies if necessary.
-   * 
+     dependencies if necessary.
    * @private
   ###
 
@@ -68,9 +69,8 @@ class New extends EventEmitter
     .done((=> @emit('done', @path)), ((err) => @emit('error', err)))
 
   ###*
-   * Tests whether a project has a package.json file and therefore needs to have
-   * dependencies installed.
-   *
+   * Tests whether a project has a package.json file and therefore needs to
+     have dependencies installed.
    * @private
    * @return {Boolean} whether a package.json file exists in the template
   ###
@@ -80,7 +80,6 @@ class New extends EventEmitter
 
   ###*
    * Uses npm to install a project's dependencies.
-   *
    * @private
    * @return {Promise} a promise for installed deps
   ###

lib/api/template.coffee

@@ -1,8 +1,8 @@
-sprout        = require 'sprout'
-_             = require 'lodash'
-W             = require 'when'
+sprout = require 'sprout'
+_ = require 'lodash'
+W = require 'when'
 global_config = require '../global_config'
-fs            = require 'fs'
+fs = require 'fs'
 
 exports.add = sprout.add.bind(sprout) # TODO: prepend all templates with "roots-"
 exports.remove = sprout.remove

lib/api/watch.coffee

@@ -1,6 +1,6 @@
-chokidar  = require 'chokidar'
+chokidar = require 'chokidar'
 minimatch = require 'minimatch'
-_         = require 'lodash'
+_ = require 'lodash'
 
 ###*
  * @class Watcher
@@ -13,8 +13,8 @@ class Watcher
 
   ###*
    * Compile the project, once done, watch it for further changes.
-   * 
-   * @return {Object} chokidar [https://github.com/paulmillr/chokidar] instance
+   * @return {Object} chokidar [https://github.com/paulmillr/chokidar]
+     instance
   ###
 
   exec: ->
@@ -30,13 +30,11 @@ class Watcher
     return _.extend(@roots, { watcher: watcher })
 
   ###*
-   * Given a path, returns true or false depending on whether it should be ignored
-   * or not.
-   *
-   * @private
-   * 
-   * @param  {String} p - absolute file path
+   * Given a path, returns true or false depending on whether it should be
+     ignored or not.
+   * @param {String} p - absolute file path
    * @return {Boolean} whether the file should be ignored or not
+   * @private
   ###
 
   ignore = (p) ->

lib/cli/clean.coffee

@@ -1,4 +1,4 @@
-path  = require 'path'
+path = require 'path'
 Roots = require '../'
 rimraf = require 'rimraf'
 

lib/cli/compile.coffee

@@ -1,4 +1,4 @@
-path  = require('path')
+path = require('path')
 Roots = require('../')
 
 module.exports = (args, cli)->