major reorg, now compiling mimosa with mimosa so can deploy to NPM as js not coffee, references #187, also fixes #207, issues with emblem template validation and template comment

Author: dbashford

.gitignore

@@ -1,17 +1 @@
-.DS_Store
-
-lib-cov
-*.seed
-*.log
-*.csv
-*.dat
-*.out
-*.pid
-*.gz
-
-pids
-logs
-results
-
-node_modules
-npm-debug.log
+node_modules

bin/mimosa

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-require('coffee-script');
 var path = require('path'),
     fs = require('fs');
 

lib/command/build.js

@@ -0,0 +1,63 @@
+var Cleaner, Watcher, build, configurer, logger, register,
+  _this = this;
+
+logger = require('logmimosa');
+
+configurer = require('../util/configurer');
+
+Watcher = require('../util/watcher');
+
+Cleaner = require('../util/cleaner');
+
+build = function(opts, foo, bar, baz, what) {
+  if (opts.debug) {
+    logger.setDebug();
+    process.env.DEBUG = true;
+  }
+  logger.info("Beginning build");
+  opts.build = true;
+  return configurer(opts, function(config, modules) {
+    var doBuild;
+
+    doBuild = function() {
+      config.isClean = false;
+      return new Watcher(config, modules, false, function() {
+        logger.success("Finished build");
+        return process.exit(0);
+      });
+    };
+    config.isClean = true;
+    return new Cleaner(config, modules, doBuild);
+  });
+};
+
+register = function(program, callback) {
+  return program.command('build').description("make a single pass through assets, compile them, and optionally package them").option("-o, --optimize", "run r.js optimization after building").option("-m, --minify", "minify each asset as it is compiled using uglify").option("-p, --package", "package code for distribution after the code has been built").option("-P, --profile <profileName>", "select a mimosa profile").option("-D, --debug", "run in debug mode").action(callback).on('--help', function() {
+    logger.green('  The build command will make a single pass through your assets and bulid any that need building');
+    logger.green('  and then exit.');
+    logger.blue('\n    $ mimosa build\n');
+    logger.green('  Pass an \'optimize\' flag and Mimosa will use requirejs to optimize your assets and provide you');
+    logger.green('  with single files for the named requirejs modules. ');
+    logger.blue('\n    $ mimosa build --optimize');
+    logger.blue('    $ mimosa build -o\n');
+    logger.green('  Pass an \'minify\' flag and Mimosa will use uglify to minify/compress your assets when they are compiled.');
+    logger.green('  You can provide exclude, files you do not want to minify, in the mimosa-config.  If you run \'minify\' ');
+    logger.green('  and \'optimize\' at the same time, optimize will not run the uglify portion of its processing which occurs as');
+    logger.green('  a separate step after everything has compiled and does not allow control of what gets uglified. Use \'optimize\'');
+    logger.green('  and \'minify\' together if you need to control which files get mangled by uglify (because sometimes uglify');
+    logger.green('  can break them) but you still want everything together in a single file.');
+    logger.blue('\n    $ mimosa watch --minify');
+    logger.blue('    $ mimosa watch -m\n');
+    logger.green('  Pass a \'package\' flag if you have installed a module (like mimosa-web-package) that is capable of');
+    logger.green('  executing packaging functionality for you after the building of assets is complete.');
+    logger.blue('\n    $ mimosa build --package');
+    logger.blue('    $ mimosa build -p\n');
+    logger.green('  Pass a \'profile\' flag and the name of a Mimosa profile to run with mimosa config overrides from a profile.');
+    logger.blue('\n    $ mimosa build --profile build');
+    return logger.blue('    $ mimosa build -P build');
+  });
+};
+
+module.exports = function(program) {
+  return register(program, build);
+};

lib/command/clean.js

@@ -0,0 +1,63 @@
+var Cleaner, clean, configurer, fs, logger, register, wrench,
+  _this = this;
+
+fs = require('fs');
+
+wrench = require('wrench');
+
+logger = require('logmimosa');
+
+Cleaner = require('../util/cleaner');
+
+configurer = require('../util/configurer');
+
+clean = function(opts) {
+  var _this = this;
+
+  if (opts.debug) {
+    logger.setDebug();
+    process.env.DEBUG = true;
+  }
+  opts.clean = true;
+  return configurer(opts, function(config, modules) {
+    if (opts.force) {
+      if (fs.existsSync(config.watch.compiledDir)) {
+        logger.info("Forcibly removing the entire directory [[ " + config.watch.compiledDir + " ]]");
+        wrench.rmdirSyncRecursive(config.watch.compiledDir);
+        return logger.success("[[ " + config.watch.compiledDir + " ]] has been removed");
+      } else {
+        return logger.success("Compiled directory already deleted");
+      }
+    } else {
+      config.isClean = true;
+      return new Cleaner(config, modules, function() {
+        logger.success("[[ " + config.watch.compiledDir + " ]] has been cleaned.");
+        return process.exit(0);
+      });
+    }
+  });
+};
+
+register = function(program, callback) {
+  return program.command('clean').option("-f, --force", "completely delete your compiledDir").option("-P, --profile <profileName>", "select a mimosa profile").option("-D, --debug", "run in debug mode").description("clean out all of the compiled assets from the compiled directory").action(callback).on('--help', function() {
+    logger.green('  The clean command will remove all of the compiled assets from the configured compiledDir. After');
+    logger.green('  the assets are deleted, any empty directories left over are also removed. Mimosa will also remove any');
+    logger.green('  Mimosa copied assets, like template libraries. It will not remove anything that did not originate');
+    logger.green('  from the source directory.');
+    logger.blue('\n    $ mimosa clean\n');
+    logger.green('  In the course of development, some files get left behind that no longer have counterparts in your');
+    logger.green('  source directories.  If you have \'mimosa watch\' turned off when you delete a file, for instance,');
+    logger.green('  the compiled version of that file will not get removed from your compiledDir, and \'mimosa clean\'');
+    logger.green('  will leave it alone because it does not recognize it as coming from mimosa.  If you want to ');
+    logger.green('  forcibly remove the entire compiledDir, use the \'force\' flag.');
+    logger.blue('\n    $ mimosa clean -force');
+    logger.blue('    $ mimosa clean -f\n');
+    logger.green('  Pass a \'profile\' flag and the name of a Mimosa profile to run with mimosa config overrides from a profile.');
+    logger.blue('\n    $ mimosa clean --profile build');
+    return logger.blue('    $ mimosa clean -P build');
+  });
+};
+
+module.exports = function(program) {
+  return register(program, clean);
+};

lib/command/config.js

@@ -0,0 +1,42 @@
+var buildConfig, copyConfig, fs, logger, path, register;
+
+path = require('path');
+
+fs = require('fs');
+
+logger = require('logmimosa');
+
+buildConfig = require('../util/config-builder');
+
+copyConfig = function(opts) {
+  var configText, currPath;
+
+  if (opts.debug) {
+    logger.setDebug();
+    process.env.DEBUG = true;
+  }
+  currPath = path.join(path.resolve(''), "mimosa-config.coffee");
+  if (fs.existsSync(currPath)) {
+    logger.warn("A mimosa-config.coffee already exists in this directory.  Will not overwrite.  Please navigate to a directory that does not contain a mimosa-config.");
+  } else {
+    configText = buildConfig();
+    logger.debug("Writing config file to " + currPath);
+    fs.writeFileSync(currPath, configText, 'ascii');
+    logger.success("Copied default config file into current directory.");
+  }
+  return process.exit(0);
+};
+
+register = function(program, callback) {
+  var _this = this;
+
+  return program.command('config').option("-D, --debug", "run in debug mode").description("copy the default Mimosa config into the current folder").action(callback).on('--help', function() {
+    logger.green('  The config command will copy the default Mimosa config to the current directory.');
+    logger.green('  There are no options for the config command.');
+    return logger.blue('\n    $ mimosa config\n');
+  });
+};
+
+module.exports = function(program) {
+  return register(program, copyConfig);
+};

lib/command/external.js

@@ -0,0 +1,40 @@
+var Cleaner, Watcher, configurer, logger, modules;
+
+modules = require('../modules');
+
+configurer = require('../util/configurer');
+
+Watcher = require('../util/watcher');
+
+Cleaner = require('../util/cleaner');
+
+logger = require('logmimosa');
+
+module.exports = function(program) {
+  var mod, _i, _len, _ref, _results;
+
+  _ref = modules.modulesWithCommands();
+  _results = [];
+  for (_i = 0, _len = _ref.length; _i < _len; _i++) {
+    mod = _ref[_i];
+    _results.push(mod.registerCommand(program, function(buildFirst, callback) {
+      var _this = this;
+
+      return configurer({}, function(config, mods) {
+        if (buildFirst) {
+          config.isClean = true;
+          return new Cleaner(config, mods, function() {
+            config.isClean = false;
+            return new Watcher(config, mods, false, function() {
+              logger.success("Finished build");
+              return callback(config);
+            });
+          });
+        } else {
+          return callback(config);
+        }
+      });
+    }));
+  }
+  return _results;
+};

lib/command/module/config.js

@@ -0,0 +1,52 @@
+var config, getModule, logger, register;
+
+logger = require('logmimosa');
+
+config = function(name, opts) {
+  var mod, text;
+
+  if (name == null) {
+    return logger.error("Must provide a module name, ex: mimosa mod:config mimosa-moduleX");
+  }
+  mod = getModule(name);
+  if (mod == null) {
+    mod = getModule("mimosa-" + name);
+  }
+  if (mod != null) {
+    if (mod.placeholder) {
+      text = mod.placeholder();
+      logger.green("" + text + "\n\n");
+    } else {
+      logger.info("Module [[ " + name + " ]] has no configuration");
+    }
+  } else {
+    return logger.error("Could not find module named [[ " + name + " ]]");
+  }
+  return process.exit(0);
+};
+
+getModule = function(name) {
+  var err;
+
+  try {
+    return require(name);
+  } catch (_error) {
+    err = _error;
+    return logger.debug("Did not find module named [[ " + name + " ]]");
+  }
+};
+
+register = function(program, callback) {
+  var _this = this;
+
+  return program.command('mod:config [name]').option("-D, --debug", "run in debug mode").description("Print out the configuration snippet for a module to the console").action(callback).on('--help', function() {
+    logger.green('  The mod:config command will print out the default commented out CoffeeScript snippet ');
+    logger.green('  for the given named Mimosa module. If there is already a mimosa-config.coffee in the');
+    logger.green('  current directory, Mimosa will not copy the file in.');
+    return logger.blue('\n    $ mimosa mod:config [nameOfModule]\n');
+  });
+};
+
+module.exports = function(program) {
+  return register(program, config);
+};

lib/command/module/init.js

@@ -0,0 +1,76 @@
+var copySkeleton, fs, init, logger, path, register, wrench;
+
+path = require('path');
+
+fs = require('fs');
+
+wrench = require('wrench');
+
+logger = require('logmimosa');
+
+init = function(name, opts) {
+  var moduleDirPath;
+
+  if (name == null) {
+    return logger.error("Must provide a module name, ex: mimosa mod:init mimosa-moduleX");
+  }
+  if (name.indexOf('mimosa-') !== 0) {
+    return logger.error("Your Mimosa module name isn't prefixed with 'mimosa-'.  To work properly with Mimosa, " + "modules must be prefixed with 'mimosa-', ex: 'mimosa-moduleX'.");
+  }
+  moduleDirPath = path.resolve(name);
+  return fs.exists(moduleDirPath, function(exists) {
+    if (exists) {
+      logger.warn("Directory/file already exists at [[ " + moduleDirPath + " ]], will not overwrite it.");
+      return process.exit(0);
+    } else {
+      return copySkeleton(name, opts.coffee, moduleDirPath);
+    }
+  });
+};
+
+copySkeleton = function(name, isCoffee, moduleDirPath) {
+  var lang, npmignore, packageJson, skeletonPath;
+
+  lang = isCoffee ? "coffee" : 'js';
+  skeletonPath = path.join(__dirname, '..', '..', '..', 'skeletons', 'module', lang);
+  wrench.copyDirSyncRecursive(skeletonPath, moduleDirPath, {
+    excludeHiddenUnix: false
+  });
+  npmignore = path.join(moduleDirPath, 'npmignore');
+  if (fs.existsSync(npmignore)) {
+    fs.renameSync(npmignore, path.join(moduleDirPath, '.npmignore'));
+  }
+  packageJson = path.join(moduleDirPath, 'package.json');
+  return fs.readFile(packageJson, 'ascii', function(err, text) {
+    text = text.replace('???', name);
+    return fs.writeFile(packageJson, text, function(err) {
+      var readme;
+
+      readme = path.join(moduleDirPath, 'README.md');
+      return fs.readFile(readme, 'ascii', function(err, text) {
+        text = text.replace(/\?\?\?/g, name);
+        return fs.writeFile(readme, text, function(err) {
+          logger.success(("Module skeleton successfully placed in " + name + " directory. The first thing you'll") + (" want to do is go into " + name + path.sep + "package.json and replace the placeholders."));
+          return process.exit(0);
+        });
+      });
+    });
+  });
+};
+
+register = function(program, callback) {
+  var _this = this;
+
+  return program.command('mod:init [name]').option("-D, --debug", "run in debug mode").option("-c, --coffee", "get a coffeescript version of the skeleton").description("create a Mimosa module skeleton in the named directory").action(callback).on('--help', function() {
+    logger.green('  The mod:init command will create a directory for the name given, and place a starter');
+    logger.green('  module skeleton into the directory.  If a directory for the name given already exists');
+    logger.green('  Mimosa will place the module skeleton inside of it.');
+    logger.blue('\n    $ mimosa mod:init [nameOfModule]\n');
+    logger.green('  The default skeleton is written in JavaScript.  If you want a skeleton delivered');
+    return logger.green('  in CoffeeScript add a \'coffee\' flag.');
+  });
+};
+
+module.exports = function(program) {
+  return register(program, init);
+};