Complete async rewrite. Added e2e tests

Author: raphaelokon

bin/export.js bin/archive.jsbin/export.js renamed to bin/archive.js

@@ -1,15 +1,14 @@
 'use strict';
-
 const fs = require('fs-promise');
 const path = require('path');
 const Archiver = require('archiver');
-const isValidConfig = require('./is_valid_config');
+const isValidConfig = require('./validate-config');
 const debug = require('./utils').debug;
 
 /**
  * @func exportPatterns
  * @desc Exports the patterns into the patternExportDirectory.
- * @param {object} [config] - The passed PatternLab config.
+ * @param {object} config - The passed PatternLab config.
  */
 function exportPatterns(config) {
 	if (!isValidConfig) throw new TypeError('export→Expects config not to be empty OR of type object if not empty.');

bin/ask.js

@@ -0,0 +1,43 @@
+'use strict';
+const inquirer = require('inquirer');
+const wrapsAsync = require('./utils').wrapAsync;
+const confirmSetup = require('./inquiries/confirm');
+const editionSetup = require('./inquiries/edition');
+const starterkitSetup = require('./inquiries/starterkit');
+const ask = inquirer.prompt;
+
+/**
+ * @func init
+ * @desc Initiates a PatternLab project by getting user input through inquiry. Scaffolds the project and download mandatory files
+ * @param {object} options - Options passed in from CLI
+ * @param {boolean} options.force - Flag whether to force install in existing project directory. May overwrite stuff.
+ */
+const init = options => wrapsAsync(function*() {
+	/**
+	 * @property {string} project_root="./" - Path to the project root directory
+	 * @property {string|Symbol} edition - The name of the edition npm package or a Symbol for no install
+	 */
+	const editionAnswers = yield ask(editionSetup);
+	
+	/**
+	 * @property {object|Symbol} starterkit - The name of a starterkit npm package or a Symbol for no install
+	 */
+	const starterkitAnswers = yield ask(starterkitSetup);
+	
+	/**
+	 * @property {boolean} confirm - A bool hold the confirmation status
+	 */
+	const confirmation = yield ask(confirmSetup);
+	
+	// IF we have no confirmation we start all over again.
+	if (!confirmation.confirm) return init(options);
+	
+	return {
+		// Destructure the answers
+		projectDir: editionAnswers.project_root,
+		edition: editionAnswers.edition !== false ? editionAnswers.edition : '',
+		starterkit: starterkitAnswers.starterkit !== false ? starterkitAnswers.starterkit : ''
+	};
+});
+
+module.exports = init;

bin/build.js

@@ -1,8 +1,7 @@
 'use strict';
-
 const pl = require('patternlab-node');
 const debug = require('./utils').debug;
-const isValidConfig = require('./is_valid_config');
+const isValidConfig = require('./validate-config');
 
 /**
  * @func build

bin/check_args.js bin/check-args.jsbin/check_args.js renamed to bin/check-args.js

@@ -1,5 +1,4 @@
 'use strict';
-
 const error = require('./utils').error;
 
 /**
@@ -12,9 +11,8 @@ const error = require('./utils').error;
 function checkArgs(cmd) {
 	/**
 	 * An immutable whitelist to check incoming <cmd> against
-	 * TODO: Need to complete the whitelist and add note to main file when adding new commands
 	 */
-	const CMD_WHITELIST = Object.freeze(['build', 'compile', 'init', 'export', 'serve', 'browse']);
+	const CMD_WHITELIST = Object.freeze(['browse', 'build', 'compile', 'init', 'export', 'serve']);
 
 	// Check if a <cmd> was specified. If not → bail out
 	if (typeof cmd === 'undefined') {

bin/check-overwrites.js

@@ -0,0 +1,22 @@
+'use strict';
+const path = require('path');
+const exists = require('path-exists');
+const debug = require('./utils').debug;
+
+/**
+ * @func checkOverwrites
+ * @desc Checks whether a path exists and if it should be replaced.
+ * @param {string} input - User input from inquirer.
+ * @return {boolean} - Returns true if all went good.
+ */
+function checkOverwrites(input) {
+	// Checks if project root exists to avoid overwriting.
+	const inputPath = path.resolve(input);
+	if (exists.sync(inputPath)) {
+		// TODO: We might wanna add some more checks here. Currently CLI only displays a warning.
+		debug(`\n patternlab→init: The directory (${inputPath}) already exists and is not empty. Proceed on your own risk.`);
+	}
+	return true;
+}
+
+module.exports = checkOverwrites;

bin/cli-actions/build.js

@@ -0,0 +1,13 @@
+'use strict';
+const buildPatterns = require('../build');
+const copyFiles = require('../copy-source-files');
+const resolveConfig = require('../resolve-config');
+const wrapAsync = require('../utils').wrapAsync;
+
+const build = options => wrapAsync(function*() {
+	const config = yield resolveConfig(options.parent.config);
+	yield copyFiles(config.paths);
+	buildPatterns(config, options);
+});
+
+module.exports = build;

bin/cli-actions/export.js

@@ -0,0 +1,11 @@
+'use strict';
+const archive = require('../archive');
+const resolveConfig = require('../resolve-config');
+const wrapAsync = require('../utils').wrapAsync;
+
+const _export = options => wrapAsync(function*() {
+	const config = yield resolveConfig(options.parent.config);
+	archive(config);
+});
+
+module.exports = _export;

bin/cli-actions/help.js

@@ -0,0 +1,11 @@
+'use strict';
+module.exports = () => {
+	/* 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 */
+};

bin/cli-actions/init.js

@@ -0,0 +1,55 @@
+'use strict';
+const ask = require('../ask');
+const scaffold = require('../scaffold');
+const installEdition = require('../install-edition');
+const installStarterkit = require('../install-starterkit');
+const defaultPatternlabConfig = require('../default-config');
+const replaceConfigPaths = require('../replace-config');
+const path = require('path');
+const wrapAsync = require('../utils').wrapAsync;
+const writeJsonAsync = require('../utils').writeJsonAsync;
+
+const init = options => wrapAsync(function*() {
+	const sourceDir = 'source';
+	const publicDir = 'public';
+	const exportDir = 'pattern_exports';
+	const answers = options.projectDir ? options : yield ask(options);
+	const projectDir = answers.projectDir || './';
+	const edition = answers.edition;
+	const starterkit = answers.starterkit;
+	
+	/**
+	 * Process the init routines
+	 * 1 Replace config paths
+	 * 2. Scaffold the folder structure
+	 * 3. If `edition` is present:
+	 *    3.1 Install edition
+	 *    3.2 Reassign adjustedconfig
+	 * 3. If `starterkit` is present
+	 *    3.1 Install it
+	 *    3.2 Copy over the mandatory starterkit files to sourceDir
+	 * 4. Check for starterkit and install it
+	 * 5. Save patternlab-config.json in projectDir
+	 */
+	let patternlabConfig = replaceConfigPaths(defaultPatternlabConfig, projectDir, sourceDir, publicDir, exportDir); // 1
+	
+	yield scaffold(projectDir, sourceDir, publicDir, exportDir); // 2
+	
+	if (edition) {
+		const newConf = yield installEdition(edition, patternlabConfig); // 3.1
+		patternlabConfig = Object.assign(patternlabConfig, newConf); // 3.2
+	}
+	if (starterkit) yield installStarterkit(starterkit, patternlabConfig); // 4
+	yield writeJsonAsync(path.resolve(projectDir, 'patternlab-config.json'), patternlabConfig); // 4.2
+	
+	// Finally :>
+	if (!edition && !starterkit) {
+		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 {
+		console.log(`patternlab→init: Additional packages installed - ${edition ? 'edition: ' + edition : ''} ${starterkit ? ', starterkit: ' + starterkit.name : ''}`); // eslint-disable-line
+	}
+	console.log(`patternlab→init: Yay ☺. PatternLab Node was successfully initialised in ${projectDir}`); // eslint-disable-line
+	return true;
+});
+
+module.exports = init;

bin/cli-actions/serve.js

@@ -0,0 +1,11 @@
+'use strict';
+const resolveConfig = require('../resolve-config');
+const preview = require('../preview');
+const wrapAsync = require('../utils').wrapAsync;
+
+const serve = options => wrapAsync(function*() {
+	const config = yield resolveConfig(options.parent.config);
+	preview(config);
+});
+
+module.exports = serve;