Adding bin files

Author: raphaelokon

.gitignore

@@ -67,7 +67,7 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-# Patternlab CLI specific
+# PatternLab CLI specific
 
 .DS_Store
 latest-change.txt

bin/build.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const pl = require('patternlab-node');
+const debug = require('./utils').debug;
+const isValidConfig = require('./is_valid_config');
+
+/**
+ * @func build
+ * @desc Init patternLab core and build the PatternLab files.
+ * @param {object} config - The passed PatternLab config.
+ * @param {object} options - Additional opts to specify build mode.
+ */
+function build(config, options) {
+	if (!isValidConfig) throw new TypeError('build→Expects config not to be empty and of type object.');
+	
+	// Initiate PatternLab core with the config
+	const patternLab = pl(config);
+	
+	/**
+	 * Check whether a flag was passed for build
+	 * 1. Build only patterns
+	 * 2. Normal build
+	 */
+	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 ☺`);
+		}, 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 ☺`);
+		}, config.cleanPublic);
+	}
+}
+
+module.exports = build;

bin/check_args.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const error = require('./utils').error;
+
+/**
+ * @func checkArgs
+ * @desc Checks if a <cmd> is allowed.
+ * @param {string} cmd - Name of the command to check against.
+ * @throws Will throw an error if the passed <cmd> is not allowed and exits with 1.
+ * @return {object} - Returns true is all is good.
+ */
+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']);
+	
+	// Check if a <cmd> was specified. If not → bail out
+	if (typeof cmd === 'undefined') {
+		error('patternlab: Sorry, no command <cmd> was specified! Type `patternlab --help` to view all available commands and options.');
+		process.exit(1);
+	}
+	
+	// Check if <cmd> is on our command whitelist. If not → bail out. Probably Inquirer handles this scenario as well
+	if (CMD_WHITELIST.indexOf(cmd)) {
+		error('patternlab: Yikes, your command `' + cmd + '` is not supported. Type `patternlab --help` to view all available commands and options.');
+		process.exit(1);
+	}
+	return true;
+}
+
+module.exports = checkArgs;

bin/copy_source_files.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const copy = require('./utils').copy;
+const debug = require('./utils').debug;
+const wrapAsync = require('./utils').wrapAsync;
+
+/**
+ * @func copyFilesFromSourceToPublic
+ * @desc Copies files from the source path to the public path.
+ * @param {object} paths - The passed PatternLab config paths member.
+ * @return {Array}
+ */
+const copyFilesFromSourceToPublic = paths => wrapAsync(function*() {
+	// Copy files over
+	const copiedFiles = [
+		copy(paths.source.styleguide, '*', paths.public.root),
+		copy(paths.source.js, '**/*.js', paths.public.js),
+		copy(paths.source.css, '*.css', paths.public.css),
+		copy(paths.source.images, '*', paths.public.images),
+		copy(paths.source.fonts, '*', paths.public.fonts),
+		copy(paths.source.root, 'favicon.ico', paths.public.root)
+	];
+	debug('patternlab→build: Your files were copied over to ' + paths.public.root);
+	return yield Promise.all(copiedFiles);
+});
+
+module.exports = copyFilesFromSourceToPublic;

bin/export.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const fs = require('fs-extra');
+const path = require('path');
+const Archiver = require('archiver');
+const isValidConfig = require('./is_valid_config');
+const debug = require('./utils').debug;
+
+/**
+ * @func exportPatterns
+ * @desc Exports the patterns into the patternExportDirectory.
+ * @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.');
+	
+	const archive = new Archiver('zip', {});
+	const exportsPath = path.resolve('./', config.patternExportDirectory, 'patterns.zip');
+	const output = fs.createWriteStream(exportsPath);
+	
+	output.on('close', function () {
+		debug('patternlab→export: Exported patterns in ' + exportsPath + ' - ' + archive.pointer() + ' total bytes.');
+	});
+	
+	archive.on('error', function (err) {
+		throw new TypeError(`export→An error occured during zipping the patterns: ${err}`);
+	});
+	
+	archive.pipe(output);
+	
+	archive.glob('?(_patterns|_data|_meta|_annotations)/**', {
+			cwd: config.paths.source.root
+		}, {})
+		.finalize();
+}
+
+module.exports = exportPatterns;

bin/generator.js

@@ -0,0 +1,128 @@
+'use strict';
+
+const path = require('path');
+const _ = require('lodash');
+const wrapAsync = require('./utils').wrapAsync;
+const mkdirsAsync = require('./utils').mkdirsAsync;
+const defaultPatternlabConfig = {
+	'paths': {
+		'source': {
+			'root': './source/',
+			'patterns': './source/_patterns/',
+			'data': './source/_data/',
+			'meta': './source/_meta/',
+			'annotations': './source/_annotations/',
+			'styleguide': 'node_modules/styleguidekit-assets-default/dist/',
+			'patternlabFiles': 'node_modules/styleguidekit-mustache-default/views/',
+			'js': './source/js',
+			'images': './source/images',
+			'fonts': './source/fonts',
+			'css': './source/css/'
+		},
+		'public': {
+			'root': './public/',
+			'patterns': './public/patterns/',
+			'data': './public/styleguide/data/',
+			'annotations': './public/annotations/',
+			'styleguide': './public/styleguide/',
+			'js': './public/js',
+			'images': './public/images',
+			'fonts': './public/fonts',
+			'css': './public/css'
+		}
+	},
+	'styleGuideExcludes': [
+		'templates',
+		'pages'
+	],
+	'defaultPattern': 'all',
+	'cleanPublic': false,
+	'patternExtension': 'mustache',
+	'ignored-extensions': ['scss', 'DS_Store', 'less'],
+	'ignored-directories': ['scss'],
+	'debug': false,
+	'ishControlsHide': {
+		's': false,
+		'm': false,
+		'l': false,
+		'full': false,
+		'random': false,
+		'disco': false,
+		'hay': true,
+		'mqs': false,
+		'find': false,
+		'views-all': false,
+		'views-annotations': false,
+		'views-code': false,
+		'views-new': false,
+		'tools-all': false,
+		'tools-docs': false
+	},
+	'ishMinimum': '240',
+	'ishMaximum': '2600',
+	'patternStateCascade': ['inprogress', 'inreview', 'complete'],
+	'patternStates': {
+		'molecules-single-comment': 'complete',
+		'organisms-sticky-comment': 'inreview',
+		'templates-article': 'complete'
+	},
+	'patternExportPatternPartials': [],
+	'patternExportDirectory': './pattern_exports/',
+	'baseurl': '',
+	'cacheBust': true,
+	'starterkitSubDir': 'dist',
+	'outputFileSuffixes': {
+		'rendered': '',
+		'rawTemplate': '',
+		'markupOnly': '.markup-only'
+	}
+};
+
+/**
+ * @func replaceConfigPaths
+ * @desc Immutable replace source and public paths in the passed config.
+ * @param {object} config - The passed PatternLab config.
+ * @param {string} projectDir - The project directory path, defaults to ./
+ * @param {string} sourceDir - The source root directory path.
+ * @param {string} publicDir - The public root directory path.
+ * @param {string} exportDir - The export root directory path.
+ * @return {object|Error} - Returns a modified config. Original stays unaltered.
+ */
+function replaceConfigPaths(config, projectDir, sourceDir, publicDir, exportDir) {
+	const conf = _.assign({}, config);
+	_.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.patternExportDirectory = path.join(projectDir, exportDir);
+	return conf;
+}
+
+/**
+ * @func scaffold
+ * @desc Generate file and folder structure for a PatternLab project
+ * @param {string} projectDir - The project root directory path.
+ * @param {string} sourceDir - The source root directory path.
+ * @param {string} publicDir - The public root directory path.
+ * @param {string} exportDir - The export root directory path.
+ * @return {void}
+ */
+const scaffold = (projectDir, sourceDir, publicDir, exportDir) => wrapAsync(function* () {
+	/**
+	 * Create mandatory files structure
+	 * 1. Create project source directory
+	 * 2. Create project public directory
+	 * 3. Create project export directory
+	 */
+	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
+	]);
+});
+
+module.exports = {
+	defaultPatternlabConfig,
+	replaceConfigPaths,
+	scaffold
+};