Added test for build module. Added tiny event-based logger. Small cleanups

Author: raphaelokon

bin/build.js

@@ -24,12 +24,12 @@ function build(config, options) {
 	if (options && options.patternsOnly) { // 1
 		debug(`patternlab→build: Building only patterns now into ${config.paths.public.root}`);
 		return patternLab.patternsonly(function () {
-			debug(`patternlab→build: Yay, your patterns were successfully built ☺`);
+			console.log(`patternlab→build: Yay, your patterns were successfully built ☺`); // eslint-disable-line
 		}, config.cleanPublic);
 	} else { // 2
 		debug(`patternlab→build: Building your project now into ${config.paths.public.root}`);
 		return patternLab.build(function () {
-			debug(`patternlab→build: Yay, your PatternLab project was successfully built ☺`);
+			console.log(`patternlab→build: Yay, your PatternLab project was successfully built ☺`); // eslint-disable-line
 		}, config.cleanPublic);
 	}
 }

bin/generator.js

@@ -93,7 +93,7 @@ function replaceConfigPaths(config, projectDir, sourceDir, publicDir, exportDir)
 	_.map(conf.paths.source, (value, key) => { conf.paths.source[key] = value.replace(/^\.\/source/g, path.join(projectDir, sourceDir)) });
 	_.map(conf.paths.public, (value, key) => { conf.paths.public[key] = value.replace(/^\.\/public/g, path.join(projectDir, publicDir)) });
 	conf.styleguide = 'node_modules/styleguidekit-assets-default/dist/';
-	conf.patternlabFiles =  'node_modules/styleguidekit-mustache-default/views/';
+	conf.patternlabFiles = 'node_modules/styleguidekit-mustache-default/views/';
 	conf.patternExportDirectory = path.join(projectDir, exportDir);
 	return conf;
 }
@@ -107,7 +107,7 @@ function replaceConfigPaths(config, projectDir, sourceDir, publicDir, exportDir)
  * @param {string} exportDir - The export root directory path.
  * @return {void}
  */
-const scaffold = (projectDir, sourceDir, publicDir, exportDir) => wrapAsync(function* () {
+const scaffold = (projectDir, sourceDir, publicDir, exportDir) => wrapAsync(function*() {
 	/**
 	 * Create mandatory files structure
 	 * 1. Create project source directory
@@ -117,7 +117,7 @@ const scaffold = (projectDir, sourceDir, publicDir, exportDir) => wrapAsync(func
 	yield Promise.all([
 		mkdirsAsync(path.resolve(projectDir, path.normalize(sourceDir))), // 1
 		mkdirsAsync(path.resolve(projectDir, path.normalize(publicDir))), // 2
-		mkdirsAsync(path.resolve(projectDir, path.normalize(exportDir))), // 3
+		mkdirsAsync(path.resolve(projectDir, path.normalize(exportDir)))  // 3
 	]);
 });
 

bin/init.js

@@ -302,11 +302,11 @@ const init = options => wrapsAsync(function*() {
 
 		// Finally :>
 		if (!edition && !starterkit) {
-			debug(`patternlab→init: You haven't picked an edition nor a starterkit. PatternLab won't work without those. Please add them manually.`)
+			console.log(`patternlab→init: You haven't picked an edition nor a starterkit. PatternLab won't work without those. Please add them manually.`); // eslint-disable-line
 		} else {
-			debug(`patternlab→init: Additional packages installed - ${edition ? 'edition: ' + edition : ''} ${starterkit ? ', starterkit: ' + starterkit.name : ''}`);
+			console.log(`patternlab→init: Additional packages installed - ${edition ? 'edition: ' + edition : ''} ${starterkit ? ', starterkit: ' + starterkit.name : ''}`); // eslint-disable-line
 		}
-		debug(`patternlab→init: Yay ☺. PatternLab Node was successfully initialised in ${projectDir}`);
+		console.log(`patternlab→init: Yay ☺. PatternLab Node was successfully initialised in ${projectDir}`); // eslint-disable-line
 		return true;
 	} catch (err) {
 		error(`patternlab→init: Failed to init project. ${err}`);

bin/patternlab.js

@@ -8,11 +8,17 @@ const exportPatterns = require('./export');
 const init = require('./init');
 const resolveConfig = require('./resolve_config');
 const serve = require('./serve');
+const log = require('./utils').log;
 const error = require('./utils').error;
 const wrapAsync = require('./utils').wrapAsync;
 const pkg = require('../package.json');
 
-const trim = val => val.trim();
+// Register error logging
+log.on('error', msg => console.log(msg)); // eslint-disable-line
+
+const registerDebugLogger = () => {
+	log.on('debug', msg => console.log(msg)); // eslint-disable-line
+};
 
 /**
  * Hook up cli version, usage and options
@@ -24,7 +30,8 @@ cli
 	.action(function (cmd) {
 		checkArgs(cmd);
 	})
-	.option('-c, --config <path>', 'Specify config file. Default looks up the project dir', trim, './patternlab-config.json');
+	.option('-c, --config <path>', 'Specify config file. Default looks up the project dir', val => val.trim(), './patternlab-config.json')
+	.option('-v, --verbose', 'Show verbose logging');
 
 /**
  * build
@@ -37,6 +44,7 @@ cli
 	.option('-p, --patterns-only', 'Whether to only build patterns')
 	.action(options => wrapAsync(function*() {
 		try {
+			if (options.parent.verbose) registerDebugLogger();
 			const config = yield resolveConfig(options.parent.config);
 			yield copyFiles(config.paths);
 			build(config, options);
@@ -54,6 +62,7 @@ cli
 	.command('export')
 	.description('Export a PatternLab patterns into a compressed format')
 	.action(options => wrapAsync(function*() {
+		if (options.parent.verbose) registerDebugLogger();
 		const config = yield resolveConfig(options.parent.config);
 		exportPatterns(config);
 	}));
@@ -67,6 +76,7 @@ cli
 	.description('Initialize a PatternLab project from scratch or import an edition and/or starterkit')
 	.option('-f, --force', 'Overwrite existing files and folders')  // TODO: Make a global --clean flag to avoid repetition
 	.action(options => wrapAsync(function*() {
+		if (options.parent.verbose) registerDebugLogger();
 		yield init(options);
 	}));
 
@@ -79,18 +89,21 @@ cli
 	.alias('browse')
 	.description('Starts a server to inspect files in browser')
 	.action(options => wrapAsync(function*() {
+		if (options.parent.verbose) registerDebugLogger();
 		const config = yield resolveConfig(options.parent.config);
 		serve(config);
 	}));
 
 // Show additional help
 cli.on('--help', () => {
+	/* eslint-disable */
 	console.log('  Examples:');
 	console.log('');
 	console.log('    $ patternlab init # Initialize a PatternLab project.');
 	console.log('    $ patternlab <cmd> # Builds the PatternLab from the current dir');
 	console.log('    $ patternlab <cmd> --config <path/to/patternlab-config> # PatternLab from a config in a specified directory');
 	console.log('');
+	/* eslint-enable */
 });
 
 // Parse at the end because Node emit is immediate

bin/resolve_config.js

@@ -13,7 +13,6 @@ const wrapAsync = require('./utils').wrapAsync;
  */
 function resolveConfig(configPath) {
 	return wrapAsync(function*() {
-
 		// If config path is set but not a string
 		if (arguments.length && typeof configPath !== 'string') {
 			throw new TypeError('patternlab→resolveConfig: If configPath is set, it is expected to be of type string.');

bin/serve.js

@@ -1,6 +1,6 @@
 'use strict';
 const bs = require('browser-sync').create('PatternLab');
-const htmlInjector = require("bs-html-injector");
+const htmlInjector = require('bs-html-injector');
 const path = require('path');
 const _ = require('lodash');
 const isValidConfig = require('./is_valid_config');

bin/utils.js

@@ -5,32 +5,40 @@ const spawn = require('child-process-promise').spawn;
 const glob = require('glob');
 const path = require('path');
 const colors = require('colors');
+const EventEmitter = require('events').EventEmitter;
 
 /**
- * @func log
- * @desc Bind console to allow shorter log func.
+ * @name log
+ * @desc tiny event-based logger
+ * @type {*}
  */
-const log = console.log.bind(console); // eslint-disable-next-line
+const log = Object.assign({
+	debug(msg) {
+		this.emit('debug', colors.green(msg));
+	},
+	info(msg) {
+		this.emit('info', msg);
+	},
+	error(msg) {
+		this.emit('error', colors.red(msg));
+	}
+}, EventEmitter.prototype);
 
 /**
  * @func debug
  * @desc Coloured debug log
  * @param  {*} msg - The variadic messages to log out.
  * @return {void}
  */
-const debug = function (msg) {
-	log(colors.green(msg));
-};
+const debug = log.debug.bind(log);
 
 /**
  * @func error
  * @desc Coloured error log
  * @param  {*} e - The variadic messages to log out.
  * @return {void}
  */
-const error = function (e) {
-	log(colors.red(e));
-};
+const error = log.debug.bind(log);
 
 /**
  * @func wrapAsync
@@ -135,6 +143,7 @@ module.exports = {
 	readJsonAsync: fs.readJson,
 	error,
 	debug,
+	log,
 	wrapAsync,
 	checkAndInstallPackage,
 	noop

package.json

@@ -38,6 +38,10 @@
     "Node",
     "Javascript"
   ],
+  "scripts": {
+    "lint": "eslint bin/",
+    "test": "tap test/*.test.js --reporter spec"
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/pattern-lab/patternlab-node-cli.git"

test/build.test.js

@@ -0,0 +1,14 @@
+const proxyquire = require('proxyquire');
+const tap = require('tap');
+const config = require('../bin/generator').defaultPatternlabConfig;
+const patternLabMock = require('./mocks/patternlab.mock');
+
+// Require build and mock patternlab.build() so that we only test the build module behavior
+const build = proxyquire('../bin/build', {'patternlab-node': patternLabMock});
+const opts = {patternsOnly: true};
+tap.throws(() => { build() }, {}, 'build throws when config is empty');
+tap.throws(() => { build(123) }, {}, 'build throws when config is not of type object');
+tap.throws(() => { build(undefined, opts) }, {}, 'build --patterns-only throws when config is empty');
+tap.throws(() => { build(undefined, opts) }, {}, 'build --patterns-only throws when config is not of type object');
+tap.type(build(config), 'boolean', 'build returns a bool');
+tap.type(build(config, opts), 'boolean', 'build --patterns-only returns a bool');