executor 1.0.6 → 1.1.0

package/lib/utils.js

@@ -1,132 +0,0 @@
-/**
- * Resources various from me and others to keep calm and code easy
- */
-const fs = require('fs');
-const path = require('path');
-const { messages } = require('./i18n');
-
-
-/**
- * get the content from any file
- *
- * @param fileName
- */
-const getContentFile = (fileName) => {
-	if (fs.existsSync(fileName)) {
-		return fs.readFileSync(fileName, 'utf8');
-	}
-
-	throw new ExecutorError(messages.errors.config.internalNotFound, { fileName, cwd: getAbsoluteCWD() });
-};
-
-
-/**
- * get the content and parse to json format
- *
- * @param jsonFile
- * @returns {any}
- */
-const getContentFileJson = (jsonFile) => {
-	const contentFile = getContentFile(jsonFile);
-
-	try {
-		return JSON.parse(contentFile);
-	} catch(e) {
-		throw new ExecutorError(messages.errors.config.invalidJson, { jsonFile });
-	}
-};
-
-
-/**
- * @param value
- * @returns {boolean}
- */
-const isString = (value) => {
-	return (typeof value === 'string');
-};
-
-
-/**
- * @param item
- * @returns {boolean}
- */
-const isObject = (item) => {
-	return !!(item && typeof item === 'object' && !Array.isArray(item));
-};
-
-
-/**
- * @param item
- * @returns {boolean}
- */
-const isObjectEmpty = (item) => {
-	return (isObject(item) && Object.keys(item).length === 0 && item.constructor === Object);
-};
-
-
-/**
- * just for mocha and do not dirty the console and others features
- *
- * @returns {boolean}
- */
-const isTestRunning = () => {
-	return !!(process.argv.find(element => element.indexOf('mocha') !== -1));
-};
-
-
-/**
- * return the folder where the user is, skipped for coverage
- *
- * @returns {*}
- */
-/* istanbul ignore next */
-const getAbsoluteCWD = () => {
-	return path.normalize(path.resolve(process.cwd()));
-};
-
-// does not need it apparently
-// let getRelativeCWD = () => {
-// 	return path.normalize(path.basename(path.dirname(fs.realpathSync(__filename))));
-// };
-
-
-/**
- * merge two object on deeper way
- *
- * From: https://stackoverflow.com/questions/27936772/how-to-deep-merge-instead-of-shallow-merge
- * @param target
- * @param source
- * @returns {*}
- */
-const mergeDeep = (target, source) => {
-	let output = Object.assign({}, target);
-
-	if (isObject(target) && isObject(source)) {
-		Object.keys(source).forEach(key => {
-			if (isObject(source[key])) {
-				if (!(key in target)) {
-					Object.assign(output, { [key]: source[key] });
-				} else {
-					output[key] = mergeDeep(target[key], source[key]);
-				}
-			} else {
-				Object.assign(output, { [key]: source[key] });
-			}
-		});
-	} else {
-		throw new ExecutorError(messages.errors.global.mergeDeepInvalidObjects);
-	}
-	return output;
-};
-
-
-module.exports = {
-	getContentFile,
-	getContentFileJson,
-	isString,
-	isObject,
-	isObjectEmpty,
-	isTestRunning,
-	getAbsoluteCWD,
-	mergeDeep
-};

package/lib/validators.js

@@ -1,192 +0,0 @@
-const { configDefault } = require('./defaults');
-const { isObject, isString, isObjectEmpty } = require('./utils');
-const { messages } = require('./i18n');
-
-
-/**
- * validate the input from the cli
- *
- * @param shortcut is the input from the user
- * @param shortcuts a string with extraMessage to concatenate
- */
-const validateShortcut = (shortcut, shortcuts) => {
-	if (!(shortcut && shortcut !== '' && isString(shortcut))) {
-		shortcuts = shortcuts || ' ';
-		throw new ExecutorError(messages.errors.shortcut.withoutArguments, { shortcuts });
-	}
-};
-
-
-/**
- * simple validation to de config
- *
- * @param config
- */
-const validateConfig = (config) => {
-	// can be undefined, just it will use the default one
-	if (config !== undefined) {
-		if (!isObject(config)) {
-			throw new ExecutorError(messages.errors.config.invalidFormat);
-		}
-
-		if (isObjectEmpty(config)) {
-			throw new ExecutorError(messages.errors.config.notFound);
-		}
-
-		if (config.executorEmptyFlag) {
-			throw new ExecutorError(messages.errors.config.notConfigurationOnFile, { file: config.executorEmptyFlag });
-		}
-
-		_validateKnownAndReserved(config);
-	}
-};
-
-/**
- * validation of known fields and reserved words
- *
- * @param config
- * @private
- */
-const _validateKnownAndReserved = (config) => {
-	_validateKnownFields(config);
-	config.templates && _validateReservedFields(config.templates);
-	config.shortcuts && _validateReservedFields(config.shortcuts);
-};
-
-/**
- * just first level
- *
- * @param config
- * @private
- */
-const _validateKnownFields = (config) => {
-	// eslint-disable-next-line no-prototype-builtins
-	let r = Object.keys(config).filter(item => !configDefault.hasOwnProperty(item));
-
-	if (r.length > 0) {
-		throw new ExecutorError(messages.errors.config.isNotAKnownField, { fields: r.join(', ') });
-	}
-};
-
-
-/**
- * just for not collide with some keywords
- *
- * @param config
- * @private
- */
-const _validateReservedFields = (config) => {
-	let reservedWords = ['env', 'def', 'pkg'];
-
-	let r = Object.keys(config).filter(item => {
-		return (reservedWords.indexOf(item.toLowerCase()) !== -1);
-	});
-
-	if (r.length > 0) {
-		throw new ExecutorError(messages.errors.config.isAReservedField, { field: r.join(', ') });
-	}
-};
-
-/**
- * validation of format of templates
- *
- * @param templates
- */
-const validateTemplates = (templates) => {
-	if (templates === undefined) {//yes, it's valid
-		return;
-	}
-
-	if (!isObject(templates)) {
-		throw new ExecutorError(messages.errors.templates.invalidData);
-	}
-
-	// validating pairs
-	Object.keys(templates).forEach(item => {
-		let value = templates[item];
-		if (isObject(value)) {
-			validateTemplates(templates[item]);
-		} else if (!isString(value)) {
-			throw new ExecutorError(messages.errors.templates.invalidFormat, { key: item, value });
-		}
-
-	});
-};
-
-
-/**
- * just for package.json field: configFile
- *
- * @param packageJson
- * @returns {boolean}
- */
-const validateConfigFileField = (packageJson) => {
-	let r = false;
-	if (!packageJson) {
-		return r;
-	}
-
-	r = _validateConfigFileField(packageJson);
-
-	return r;
-};
-const _validateConfigFileField = (packageJson) => {
-	const appName = messages.app.name;
-
-	let r = false;
-	let packageJsonEmpty = (isObjectEmpty(packageJson) && isObjectEmpty(packageJson.config));
-	let packageJsonWithoutConfig = (packageJson[appName] && packageJson[appName].configFile);
-
-	if (!packageJsonEmpty && packageJsonWithoutConfig) {
-		if (isString(packageJson[appName].configFile)) {
-			r = true;
-		} else {
-			throw new ExecutorError(messages.errors.config.isNotAString);
-		}
-	}
-
-	return r;
-};
-
-
-/**
- * validation of format of shortcuts
- *
- * @param shortcuts
- */
-const validateShortcuts = (shortcuts) => {
-	if (!(isObject(shortcuts) && !isObjectEmpty(shortcuts))) {
-
-		throw new ExecutorError(messages.errors.shortcuts.notFound);
-	}
-
-	_validateShortcutsRecursive(shortcuts);
-};
-
-const _validateShortcutsRecursive = (shortcutsNested) => {
-	let keys = Object.keys(shortcutsNested);
-	if (keys.length === 0) {
-		throw new ExecutorError(messages.errors.shortcuts.shouldBeAnObject);
-	}
-
-	keys.forEach((itemName) => {
-		let item = shortcutsNested[itemName];
-
-		if (isObject(item)) {
-			// nesting detected
-			return _validateShortcutsRecursive(item);
-		} else if (!isString(item)) {
-			// end detected
-			throw new ExecutorError(messages.errors.shortcuts.shouldBeAnObject);
-		}
-
-	});
-};
-
-module.exports = {
-	validateShortcut,
-	validateConfig,
-	validateTemplates,
-	validateShortcuts,
-	validateConfigFileField
-};