executor 1.0.6 → 1.1.0

package/lib/builders.js

@@ -1,285 +0,0 @@
-const path = require('path');
-const { setColors } = require('./extends');
-const { validateConfig, validateShortcut, validateTemplates, validateShortcuts } = require('./validators');
-const { mergeDeep, isObject, isTestRunning, isObjectEmpty } = require('./utils');
-const { getConfigFromSources, getConfigMergedWithDefault, getConfigFromJson } = require('./config');
-const { interpolateConfigVariables } = require('./interpolate');
-const { messages } = require('./i18n');
-
-
-/**
- * This is the main and only entry point!
- * the other functions exported by module are for test
- *
- * @param shortcut the command entered by user
- * @returns {*}
- */
-const buildCommand = (shortcut) => {
-	let configFromSources = getConfigFromSources();
-	let config = buildConfig(configFromSources);
-	return buildCommandWithConfig(shortcut, config, configFromSources.packageFile.content);
-};
-
-
-/**
- * This is the main with config for tests
- *
- * @param shortcut the command entered by user
- * @param config from config file
- * @param packageFile
- * @returns {*}
- */
-const buildCommandWithConfig = (shortcut, config, packageFile) => {
-
-	// hello case
-	if (shortcut === 'hello') {
-		let helloConfig = _getHelloConfig();
-		config = getConfigMergedWithDefault(mergeDeep(helloConfig, config));
-	}
-
-	// VALIDATE INPUTS:
-	validateConfig(config);
-	validateShortcut(shortcut, buildShortcutsAvailable(config.shortcuts));
-
-	// config first at all because I need to registry the colors for console
-	config = getConfigMergedWithDefault(config);
-	setColors(config);
-
-	// validation tasks
-	validateTemplates(config.templates);
-	validateShortcuts(config.shortcuts);
-
-	// building tasks
-	config.shortcutsRendered = interpolateConfigVariables(config, packageFile);
-	let command = buildShortcutCommand(config.shortcutsRendered, shortcut).join(' ');
-
-	let ui = resolveShowCommandOnConsole(config, command);
-
-	return {
-		command,
-		config,
-		ui
-	};
-};
-
-/**
- * resolve if show to the user info about the command executed
- *
- * @param config
- * @param command
- * @returns {{showedCommand: boolean, dry: boolean}}
- */
-const resolveShowCommandOnConsole = (config, command) => {
-
-	let ui = {
-		showedCommand: false,
-		dry: false
-	};
-
-	if (config.dry || config.showCommand) {
-		if (config.dry) {
-			ui = {
-				showedCommand: true,
-				dry: true
-			};
-
-			/* istanbul ignore if  */
-			if (!isTestRunning()) {
-				console.primary(`[${messages.app.name}]`, messages.builder.command.dry);
-				console.secondary(`${command}`);
-			}
-		} else {
-			ui = {
-				showedCommand: true,
-				dry: false
-			};
-
-			/* istanbul ignore if  */
-			if (!isTestRunning()) {
-				console.primary(`[${messages.app.name}]`, messages.builder.command.running);
-				console.secondary(`${command}\n`);
-			}
-		}
-	}
-
-	return ui;
-};
-
-
-/**
- * The recursive method to chain the shortcut with its templates
- *
- * @param shortcuts list of shortcuts posibles
- * @param shortcut the actual shortcut
- * @param log to show for the user if it fail
- * @returns {*}
- * @private
- */
-const _buildShortcutRecursive = (shortcuts, shortcut, log) => {
-	let key = shortcut.shift(),
-		found = shortcuts[key];
-
-	if (!found) {
-		throw new ExecutorError(log.msg, log.templates);
-	} else if (isObject(found)) {
-		let log = {};
-		if (shortcut.length === 0) {
-			log = {
-				msg: messages.errors.shortcut.withoutNextArgument,
-				templates: { key, extraMessage: buildShortcutsAvailable(found) }
-			};
-		} else {
-			log = {
-				msg: messages.errors.shortcut.notFound,
-				templates: { key, subKey: shortcut[0], extraMessage: buildShortcutsAvailable(found) }
-			};
-		}
-
-		return _buildShortcutRecursive(found, shortcut, log);
-	}
-
-	return found;
-};
-
-
-/**
- * This build the command line joining all pieces recursively
- *
- * @param shortcuts
- * @param shortcut
- * @returns {string}
- */
-const buildShortcutCommand = (shortcuts, shortcut) => {
-	shortcut = shortcut.split(' ');
-	// shortcut
-	let log = {
-		msg: messages.errors.shortcut.notFoundFirstShortcut,
-		templates: { shortcut: shortcut[0], extraMessage: buildShortcutsAvailable(shortcuts) }
-	};
-
-	let command = _buildShortcutRecursive(shortcuts, shortcut, log);
-
-	// this add final arguments to the command line
-	command = command.split(' ').concat(shortcut);
-	return command;
-};
-
-
-/**
- * This build final config from different sources
- *
- * @param configPreBuilt
- * @returns {string}
- */
-const buildConfig = (configPreBuilt) => {
-	let r = {};
-
-	let packageFile = configPreBuilt.packageFile;
-	let packageContent = packageFile && packageFile.content && packageFile.content[messages.app.name];
-	let configFile = configPreBuilt.configFile;
-	let configContent = configFile && configFile.content;
-	let executorFile = configPreBuilt.executorFile;
-	let executorContent = executorFile && executorFile.content;
-
-	return _resolveConfigs(r, packageContent, configFile, configContent, executorFile, executorContent);
-};
-
-/**
- * just for internal use, logic of merge from three different resources
- *
- * @param result
- * @param packageContent
- * @param configFile
- * @param configContent
- * @param executorFile
- * @param executorContent
- * @returns {*}
- * @private
- */
-function _resolveConfigs(result, packageContent, configFile, configContent, executorFile, executorContent) {
-	if (packageContent) {
-		result = mergeDeep(result, packageContent);
-
-		if (configContent) {
-			result = _merge(result, configFile);
-		} else if (executorContent) {
-			result = _merge(result, executorFile);
-		}
-	} else if (executorContent) {
-		result = _merge(result, executorFile);
-	}
-
-	delete result.configFile;
-
-	return result;
-}
-
-
-/**
- * #mutable
- *
- * @param result
- * @param file
- * @returns {*}
- * @private
- */
-const _merge = (result, file) => {
-	let content = file.content;
-	content.executorEmptyFlag = isObjectEmpty(file.content) ? file.fileName : false; // just for show an specified error to the user
-	return mergeDeep(result, content);
-};
-
-/**
- * This build the possibilities to use for output to user
- *
- * @param shortcuts
- * @returns {string}
- */
-const buildShortcutsAvailable = (shortcuts) => {
-	let r = '';
-
-	if (shortcuts) {
-		let shortcutsMap = Object.keys(shortcuts).map(item => `"${item}"`);
-
-		if (shortcutsMap.length > 0) {
-			r = messages.shortcut.withoutArgumentsAvailableValues.toTemplate({ shortcuts: shortcutsMap.join(', ') });
-		}
-	}
-
-	return r;
-};
-
-
-/**
- *
- * @returns {{showCommand: boolean, shortcuts: {hello: string}}}
- * @private
- */
-const _getHelloConfig = () => {
-	let configJsonPath = path.resolve(__dirname, '../');
-	let pkg = getConfigFromJson(configJsonPath, 'package.json'); // from global executor
-	/* istanbul ignore next */
-	let v = (pkg && pkg.version) ? pkg.version : '?.?.?';
-	let msg = [];
-	let line = '═'.repeat(v.length + 1);
-
-	msg.push(`╔══════════════════╦════════════════════════${line}╗`);
-	msg.push(`║ - HELLO WORLD! - ║ Executor installed! v: ${ v } ║`);
-	msg.push(`╚══════════════════╩════════════════════════${line}╝`);
-	return {
-		showCommand: false,
-		shortcuts: {
-			hello: 'echo ' + msg.join(' &&echo ')
-		}
-	};
-};
-
-
-module.exports = {
-	buildCommand,
-	buildCommandWithConfig,
-	resolveShowCommandOnConsole,
-	buildShortcutCommand,
-	buildConfig,
-	buildShortcutsAvailable
-};

package/lib/config.js

@@ -1,133 +0,0 @@
-/**
- * This module build the config from different sources
- */
-const path = require('path');
-const { mergeDeep } = require('./utils');
-const { configDefault } = require('./defaults');
-const { validateConfigFileField } = require('./validators');
-const { getAbsoluteCWD, isTestRunning, getContentFileJson } = require('./utils');
-const { messages } = require('./i18n');
-
-
-/**
- * get configs from different sources
- * @returns {*}
- */
-const getConfigFromSources = () => {
-	let packageJson = getConfigFromPackageJson();
-	let configFromPackageJsonConfigFile = getConfigFromPackageJsonConfigFile(packageJson);
-	let appName = messages.app.name;
-	let configFileName = null;
-
-	if (configFromPackageJsonConfigFile) {
-		configFileName = packageJson[appName].configFile;
-	}
-
-	return {
-		packageFile: { fileName: 'package.json', content: packageJson },
-		configFile: { fileName: configFileName, content: configFromPackageJsonConfigFile },
-		executorFile: { fileName: `${appName}.json`, content: getConfigFromExecutorFile() }
-	};
-};
-
-
-/**
- * merge config with default
- * @returns {any}
- */
-const getConfigMergedWithDefault = (config) => {
-	return mergeDeep(configDefault, config);
-};
-
-
-/**
- * get the current package from cwd
- * @returns {*}
- */
-const getConfigFromPackageJson = () => {
-	return _getConfigFromJsonFile('package');
-};
-
-/**
- * get the current config from cwd
- * @returns {*}
- */
-const getConfigFromExecutorFile = () => {
-	return _getConfigFromJsonFile(messages.app.name);
-};
-
-
-/**
- *
- * @param name
- * @returns {*}
- * @private
- */
-const _getConfigFromJsonFile = (name) => {
-	return getConfigFromJson(getAbsoluteCWD(), `${name}.json`);
-};
-
-
-/**
- * this looking the configuration file on package.json config
- *
- * @param packageJson
- * @returns {object}
- */
-const getConfigFromPackageJsonConfigFile = (packageJson) => {
-	let configFile = null;
-
-	if (validateConfigFileField(packageJson)) {
-		const appName = messages.app.name;
-		const configFileName = packageJson[appName].configFile;
-
-		// I don't use getConfigFromJson because in this case I want to throw an error
-		configFile = getContentFileJson(configFileName);
-
-		// it is ok, I can use "console.primary" because I don't have the configuration to finish with this
-		/* istanbul ignore if  */
-		if (!isTestRunning()) {
-			console.log('\x1b[37m%s\x1b[0m', `[${messages.app.name}]`, messages.config.used.toTemplate({ configFileName }));
-		}
-	}
-
-	return configFile;
-};
-
-
-/**
- * parse json file with config
- *
- * @param filePath
- * @param fileName
- * @returns {*}
- */
-const getConfigFromJson = (filePath, fileName) => {
-	let configJson = null;
-	let configJsonPath = path.normalize(`${filePath}/${fileName}`);
-
-	try {
-		configJson = getContentFileJson(configJsonPath);
-	} catch(e) {
-		// *.json not found on filePath folder
-		if (e.name === 'ExecutorError') {
-			if (e.code !== messages.errors.config.internalNotFound.code) {
-				throw e;
-			}
-			// intentionally, it does not throw an error
-			// throw new ExecutorError(messages.errors.configJson.notFound, {folder: configJsonPath});
-		} else {
-			throw e;
-		}
-	}
-	return configJson;
-};
-
-module.exports = {
-	getConfigFromSources,
-	getConfigFromPackageJson,
-	getConfigFromPackageJsonConfigFile,
-	getConfigFromExecutorFile,
-	getConfigFromJson,
-	getConfigMergedWithDefault
-};

package/lib/defaults.js

@@ -1,29 +0,0 @@
-/**
- * In this module will have all default configuration for the project.
- *
- * @type {*}
- */
-
-const { getAbsoluteCWD } = require('./utils');
-
-module.exports = {
-	configDefault: {
-		description: '',
-		help: '',
-		colors: {
-			primary: '\x1b[37m%s\x1b[0m', //'\x1b[37m%s\x1b[0m'
-			secondary: '\x1b[1m\x1b[36m%s\x1b[0m',
-			alert: '\x1b[1m\x1b[31m%s\x1b[0m'
-		},
-		useColors: true,
-		showCommand: true,
-		showTime: true,
-		dry: false,
-		templates: {},
-		shortcuts: {},
-		executorEmptyFlag: false
-	},
-	def: {
-		cwd: getAbsoluteCWD()
-	}
-};

package/lib/extends.js

@@ -1,100 +0,0 @@
-/**
- * Extends the language with polyfills and others
- */
-const { messages } = require('./i18n');
-const { isObject } = require('./utils');
-
-
-/**
- * Error with custom structure to user and unit test
- */
-class ExecutorError extends Error {
-	constructor(data, templates) {
-		super();
-		this.name = this.constructor.name;
-
-		/* istanbul ignore next */
-		this.code = data.code || '1';
-
-		templates = isObject(templates) ? templates : {};
-
-		this.message = `[${messages.app.name}] ${data.msg.toTemplate(templates)}`;
-		/* istanbul ignore next */
-		if (Error.captureStackTrace) {
-			Error.captureStackTrace(this, ExecutorError);
-		}
-	}
-}
-
-global.ExecutorError = ExecutorError;
-
-
-/**
- * add toTemplate function to string object
- *
- * From: https://stackoverflow.com/questions/29182244/convert-a-string-to-a-template-string?noredirect=1&lq=1
- * @param map
- * @param fallback
- * @returns {string}
- */
-String.prototype.toTemplate = function(map, fallback) {
-	const getAttribute = (path, obj, fb = `$\{${path}}`) => {
-		return path.split('.').reduce((res, key) => res[key] || fb, obj);
-	};
-
-	return this.replace(/\${.+?}/g, (match) => {
-		const path = match.substr(2, match.length - 3).trim();
-		return getAttribute(path, map, fallback);
-	});
-};
-
-
-/**
- * just for user, skipped for coverage
- *
- * @param config
- */
-/* istanbul ignore next */
-const setColors = (config) => {
-	let primary = console.log,
-		secondary = console.log,
-		alert = console.log;
-
-	console.primary = function() {
-		primary.apply(console, setColor(config.useColors, config.colors.primary, arguments));
-	};
-
-	console.secondary = function() {
-		secondary.apply(console, setColor(config.useColors, config.colors.secondary, arguments));
-	};
-
-	console.alert = function() {
-		alert.apply(console, setColor(config.useColors, config.colors.alert, arguments));
-	};
-};
-
-
-/**
- * set the color for console, for first argument only
- *
- * @param useColors
- * @param color
- * @param _arguments
- * @returns {*}
- */
-const setColor = (useColors, color, _arguments) => {
-	let args = _arguments;
-
-	if (useColors) {
-		args = [color, ...args];
-	}
-
-	return args;
-};
-
-
-module.exports = {
-	setColor,
-	setColors,
-	ExecutorError
-};

package/lib/i18n.js

@@ -1,57 +0,0 @@
-/**
- * All messages to user.
- * The idea is not to translate, just for save all in one place.
- *
- * @type {*}
- */
-module.exports.messages = {
-	app: {
-		name: 'executor'
-	},
-	errors: {
-		global: {
-			mergeDeepInvalidObjects: { code: 10, msg: 'Objects sent to mergeDeep are invalid' }
-		},
-		environments: {
-			invalidFormat: { code: 20, msg: 'The attribute "environments" should be an array with strings or simple object ({key: value})' }
-		},
-		config: {
-			notFound: { code: 404, msg: 'Configuration not found. (readme: https://github.com/crystian/executor)' },
-			notConfigurationOnFile: { code: 40, msg: 'Configuration not found on "${file}"' },
-			internalNotFound: { code: 41, msg: '"${fileName}" not found on: ${cwd}' },
-			invalidJson: { code: 42, msg: 'Invalid json format on your configuration file: ${jsonFile}' },
-			invalidFormat: { code: 43, msg: 'An invalid structure on config attribute' },
-			isNotAString: { code: 44, msg: 'An invalid type on configuration file: "configFile" should be a string' },
-			isNotAKnownField: { code: 45, msg: 'Invalid field/s on config: "${fields}"' },
-			isAReservedField: { code: 46, msg: '"${field}": Is a reserved word you can not use it' }
-		},
-		shortcut: {
-			withoutArguments: { code: 50, msg: 'coff coff ... and the "shortcut"?${shortcuts}' },
-			notFoundFirstShortcut: { code: 51, msg: 'The shortcut: "${shortcut}" not found ${extraMessage}' },
-			notFound: { code: 52, msg: 'The sub-arguments "${subKey}" from "${key}" does not match with your configuration file. ${extraMessage}' },
-			withoutNextArgument: { code: 52, msg: '"${key}" needs another argument. ${extraMessage}' }
-		},
-		shortcuts: {
-			notFound: { code: 60, msg: 'The attribute "shortcuts" should exist and should be an object no empty.' },
-			shouldBeAnObject: { code: 61, msg: 'The attribute "shortcuts" should be an object, and the last attribute on it should be a string.' }
-		},
-		templates: {
-			notFound: { code: 70, msg: 'Key "${template}" not found \(remember the order is important!\)' }, // eslint-disable-line no-useless-escape
-			invalidData: { code: 71, msg: 'The configurations of templates are invalid, should be an object or string' },
-			invalidFormat: { code: 72, msg: 'Invalid format, remember should be a pair key value \(both should be strings\), key: "${key}"' } // eslint-disable-line
-			// no-useless-escape
-		}
-	},
-	builder: {
-		command: {
-			dry: 'Executing on dry mode, this will be the command line:\n',
-			running: 'Running:\n'
-		}
-	},
-	config: {
-		used: 'Config file used: "${configFileName}"'
-	},
-	shortcut: {
-		withoutArgumentsAvailableValues: '\nShortcuts configured: ${shortcuts}'
-	}
-};

package/lib/interpolate.js

@@ -1,79 +0,0 @@
-const { isObject, isObjectEmpty, isString } = require('./utils');
-const { def } = require('./defaults');
-const { messages } = require('./i18n');
-
-
-/**
- * Interpolate all the inputs!
- *
- * Inputs in order: environment, preDEFined, template, shortcut
- * And it allow to use nested object! (not for environments)
- *
- * Note: it can be changed to get better performance.
- *
- * @param config
- * @param packageJson
- * @returns {any}
- */
-const interpolateConfigVariables = (config, packageJson) => {
-	let shortcuts = config.shortcuts,
-		templates = config.templates,
-		pkg = packageJson,
-		newShortcuts, newTemplates;
-
-	// copy structure to mutate in the easy way
-	newShortcuts = JSON.parse(JSON.stringify(shortcuts));
-	newTemplates = JSON.parse(JSON.stringify(templates));
-
-	// This is recursive and it is needed to pass on each stage
-	// to template
-	interpolateVariablesRecursive(newTemplates, { env: process.env });
-	interpolateVariablesRecursive(newTemplates, { def });
-	interpolateVariablesRecursive(newTemplates, { pkg });
-	interpolateVariablesRecursive(newTemplates, newTemplates); // yes to itself!
-	// to shortcuts
-	interpolateVariablesRecursive(newShortcuts, { env: process.env });
-	interpolateVariablesRecursive(newShortcuts, { def });
-	interpolateVariablesRecursive(newShortcuts, { pkg });
-	interpolateVariablesRecursive(newShortcuts, newTemplates);
-	interpolateVariablesRecursive(newShortcuts, newShortcuts, true); // yes to itself!
-
-	return newShortcuts;
-};
-
-
-/**
- * It does the magic recursively to replace the placeholders with target, even ITSELF (mutable)
- *
- * Be careful value is mutable!
- *
- * @param target are the data and you can use it so simple or you can mix with source (by placeholders)
- * @param source are the reuse "snippet", you can use it on target and avoid to repeat your code!
- * @param finalFlag at the final it will check if there are some placeholders without replaced
- * @private
- */
-const interpolateVariablesRecursive = (target, source, finalFlag) => {
-
-	Object.keys(target).forEach(item => {
-
-		// be careful, it is a mutable object
-		if (isString(target[item])) {
-
-			target[item] = target[item].toTemplate(source);
-
-			if (finalFlag && target[item].match(/\${.+?}/g)) {
-				throw new ExecutorError(messages.errors.templates.notFound, { template: target[item].match(/\${.+?}/g) });
-			}
-		} else if (isObject(target[item]) && !isObjectEmpty(target[item])) {
-			interpolateVariablesRecursive(target[item], source, finalFlag);
-		} else {
-			throw new ExecutorError(messages.errors.templates.invalidFormat, { key: item });
-		}
-	});
-};
-
-
-module.exports = {
-	interpolateConfigVariables,
-	interpolateVariablesRecursive
-};