argue-cli 1.1.0 → 2.0.0-0

package/src/lib.js

@@ -1,393 +0,0 @@
-
-const argv = process.argv.slice(2, process.argv.length);
-
-function findName(name, names) {
-
-	var findedName = false,
-		array      = false;
-
-	names.some((fullName) => {
-
-		var keys, shirtName;
-
-		if (typeof fullName == "string") {
-
-			if (fullName == name) {
-				findedName = fullName;
-				return true;
-			}
-
-			return false
-		}
-
-		var proto = Object.getPrototypeOf(fullName);
-
-		if (proto == Object.prototype) {
-
-			keys      = fullName;
-			fullName  = Object.keys(keys)[0];
-			shirtName = keys[fullName];
-
-			if (fullName == name || shirtName == name) {
-				findedName = fullName;
-				return true;
-			}
-
-			return false;
-		}
-
-		if (proto == Array.prototype) {
-
-			[ fullName, shirtName ] = fullName;
-
-			if (fullName == name || shirtName == name) {
-				array      = true;
-				findedName = fullName;
-				return true;
-			}
-
-			return false;
-		}
-
-		return false;
-	});
-
-	return findedName
-		? { name: findedName, isArray: array }
-		: false
-	;
-}
-
-export function setArguments(...newArguments) {
-	argv.splice(0, argv.length);
-	argv.push(...newArguments);
-}
-
-/**
- * Strict expectation one of given commands.
- *
- *     command-line-app install 
- *
- *     expect(
- *         {"install": "i"}, - fullname and shirtname  
- *         ["update", "u"],  - also fullname and shirtname  
- *         "info"            - only one variant of name
- *     )
- * 
- * @param  {...Object} names 
- * @return {String}    fullname
- */
-export function expect(...names) {
-
-	if (!argv.length) {
-		throw new Error("Unexpected end of arguments.");
-	}
-
-	var sourceKey = argv.shift(),
-		argument  = findName(sourceKey, names);
-
-	if (!argument) {
-		throw new Error(`Unexpected argument "${sourceKey}".`);
-	}
-
-	return argument.name;
-}
-
-/**
- * Strict reading of argument.
- *
- *     command-line-app some-value 
- * 
- * @return {String} argument
- */
-export function read() {
-
-	if (!argv.length) {
-		throw new Error("Unexpected end of arguments.");
-	}
-
-	return argv.shift();
-}
-
-/**
- * Strict expectation of end.
- *
- */
-export function end() {
-
-	if (argv.length) {
-		throw new Error(`Unexpected argument "${argv[0]}".`);
-	}
-}
-
-/**
- * Strict reading of flags and options.
- *
- *     command-line-app --output test -p es2015,react --verbose
- *
- *     strictOptions([
- *         ["another"]      - for flags array is same as object notation
- *         "verbose"        - only one variant of name
- *     ], [
- *         {"output": "o"}, - fullname and shirtname  
- *         ["plugins", "p"] - fullname and shirtname for array
- *     ])
- * 
- * @param  {...Object} flagsNames
- * @param  {...Object} optionsNames
- * @return {Object}    fullname-value pairs 
- */
-export function strictOptions(flagsNames, optionsNames) {
-
-	if (!argv.length) {
-		return {}
-	}
-
-	var options  = {},
-		argument = argv[0];
-
-	while (
-		argv.length 
-		&& (
-			argument.indexOf("--") == 0 || 
-			argument.indexOf("-") == 0 && argument.length == 2
-		)
-	) {
-
-		var sourceKey = argv.shift().replace(/^(--|-)/, ""),
-			flagKey   = findName(sourceKey, flagsNames),
-			optionKey = findName(sourceKey, optionsNames);
-
-		if (!flagKey && !optionKey) {
-			throw new Error(`Unexpected key "${sourceKey}".`);
-		}
-
-		if (!flagKey && optionKey && !argv.length) {
-			throw new Error(`Unexpected end of arguments.`);
-		}
-
-		var value = argv[0];
-
-		if (optionKey && value.indexOf("--") != 0
-			&& (value.indexOf("-") != 0 && value.length != 2)
-		) {
-
-			argv.shift();
-
-			if (optionKey.isArray) {
-				value = value.split(",").map(element => element.replace(/^['"]|["']$/g, ""));
-			} else {
-				value = value.replace(/^['"]|["']$/g, "");
-			}
-
-			options[optionKey.name] = value;
-
-		} else
-		if (flagKey) {
-
-			options[flagKey.name] = true;
-
-		} else {
-			throw new Error(`Unexpected key "${value}".`);
-		}
-
-		argument = argv[0];
-	}
-
-	return options;
-}
-
-/**
- * Strict reading of options with equal sign. 
- * If option is provided without value it will interpreted as `true`.
- *
- *     command-line-app --output=test -p=es2015,react --verbose
- *
- *     strictOptionsEqual(
- *         {"output": "o"},  - fullname and shirtname  
- *         ["plugins", "p"], - fullname and shirtname for array
- *         "verbose"         - only one variant of name
- *     )
- * 
- * @param  {...Object} names 
- * @return {Object}    fullname-value pairs 
- */
-export function strictOptionsEqual(...names) {
-
-	if (!argv.length) {
-		return {};
-	}
-
-	var options  = {},
-		argument = argv[0];
-
-	while (
-		argv.length 
-		&& (
-			argument.indexOf("--") == 0 ||
-			argument.indexOf("-")  == 0
-		)
-	) {
-
-		var [ sourceKey, value ] = argv.shift().replace(/^(--|-)/, "").split("="),
-			key                  = findName(sourceKey, names);
-		
-		if (!key) {
-			throw new Error(`Unexpected key "${sourceKey}".`);
-		}
-
-		if (typeof value == "undefined") {
-			value = true;
-		} else
-		if (key.isArray) {
-			value = value.split(",").map(element => element.replace(/^['"]|["']$/g, ""));
-		} else {
-			value = value.replace(/^['"]|["']$/g, "");
-		}
-
-		options[key.name] = value;
-
-		argument = argv[0];
-	}
-
-	return options;
-}
-
-/**
- * Unlimited reading of flags and options.
- *
- *     command-line-app --output test install -p es2015,react babel --verbose
- *
- *     options([
- *         ["another"]      - for flags array is same as object notation
- *         "verbose"        - only one variant of name
- *     ], [
- *         {"output": "o"}, - fullname and shirtname  
- *         ["plugins", "p"] - fullname and shirtname for array
- *     ])
- * 
- * @param  {...Object} flagsNames
- * @param  {...Object} optionsNames
- * @return {Object}    fullname-value pairs 
- */
-export function options(flagsNames, optionsNames) {
-
-	if (!argv.length) {
-		return {};
-	}
-
-	var options = {},
-		argvc   = argv.slice(),
-		argc    = argvc.length,
-		remove  = [];
-
-	for (var i = 0, argument = argvc[i]; i < argc; argument = argvc[++i]) {
-
-		if (argument.indexOf("--") != 0
-			&& (argument.indexOf("-") != 0 || argument.length != 2)
-		) {
-			continue;
-		}
-
-		var sourceKey = argument.replace(/^(--|-)/, ""),
-			flagKey   = findName(sourceKey, flagsNames),
-			optionKey = findName(sourceKey, optionsNames);
-
-		if (!flagKey && !optionKey) {
-			throw new Error(`Unexpected key "${sourceKey}".`);
-		}
-
-		if (!flagKey && optionKey && i == argc - 1) {
-			throw new Error(`Unexpected end of arguments.`);
-		}
-
-		var value = argvc[i + 1];
-
-		if (optionKey && value.indexOf("--") != 0
-			&& (value.indexOf("-") != 0 && value.length != 2)
-		) {
-
-			remove.unshift(i++);
-
-			if (optionKey.isArray) {
-				value = value.split(",").map(element => element.replace(/^['"]|["']$/g, ""));
-			} else {
-				value = value.replace(/^['"]|["']$/g, "");
-			}
-
-			options[optionKey.name] = value;
-
-		} else
-		if (flagKey) {
-
-			options[flagKey.name] = true;
-
-		} else {
-			throw new Error(`Unexpected key "${value}".`);
-		}
-
-		remove.unshift(i);
-	}
-
-	remove.forEach(index => argv.splice(index, 1));
-
-	return options;
-}
-
-/**
- * Unlimited reading of with equal sign. 
- * If option is provided without value it will interpreted as `true`.
- *
- *     command-line-app --output=test install -p=es2015,react babel --verbose
- *
- *     optionsEqual(
- *         {"output": "o"},  - fullname and shirtname  
- *         ["plugins", "p"], - fullname and shirtname for array
- *         "verbose"         - only one variant of name
- *     )
- * 
- * @param  {...Object} names 
- * @return {Object}    fullname-value pairs 
- */
-export function optionsEqual(...names) {
-
-	if (!argv.length) {
-		return {};
-	}
-
-	var options = {},
-		argvc   = argv.slice(),
-		argc    = argvc.length,
-		remove  = [];
-
-	for (var i = 0, argument = argvc[i]; i < argc; argument = argvc[++i]) {
-
-		if (argument.indexOf("-") != 0) {
-			continue;
-		}
-
-		var [ sourceKey, value ] = argument.replace(/^(--|-)/, "").split("="),
-			key                  = findName(sourceKey, names);
-
-		remove.unshift(i);
-		
-		if (!key) {
-			throw new Error(`Unexpected key "${sourceKey}".`);
-		}
-
-		if (typeof value == "undefined") {
-			value = true;
-		} else
-		if (key.isArray) {
-			value = value.split(",").map(element => element.replace(/^['"]|["']$/g, ""));
-		} else {
-			value = value.replace(/^['"]|["']$/g, "");
-		}
-
-		options[key.name] = value;
-	}
-
-	remove.forEach(index => argv.splice(index, 1));
-
-	return options;
-}

package/test/end.js

@@ -1,18 +0,0 @@
-import * as Argue from '../src/lib';
-
-describe("end()", () => {
-
-	it('should throw error when arguments still exists', () => {
-
-		Argue.setArguments('install');
-		(() => Argue.end()).should.throw(Error, { 
-			message: `Unexpected argument "install".`
-		});
-	});
-
-	it('should stand still when no more arguments', () => {
-
-		Argue.setArguments();
-		Argue.end();
-	});
-});

package/test/expect.js

@@ -1,59 +0,0 @@
-import * as Argue from '../src/lib';
-
-describe("expect()", () => {
-
-	it('should throw error when no more arguments', () => {
-
-		Argue.setArguments();
-		(() => Argue.expect('install', 'remove')).should.throw(Error, { 
-			message: "Unexpected end of arguments."
-		});
-	});
-
-	it('should throw error when given command is doesn\'t expected', () => {
-
-		Argue.setArguments('delete', 'mocha');
-		(() => Argue.expect('install', 'remove')).should.throw(Error, { 
-			message: 'Unexpected argument "delete".' 
-		});
-	});
-
-	describe("when argument alias described as object", () => {
-
-		it('should return full version of command if full given', () => {
-
-			Argue.setArguments('install', 'mocha');
-			Argue.expect({'install':'i'}, {'remove':'r'}).should.be.equal('install');
-		});
-
-		it('should return full version of command if shirt given', () => {
-
-			Argue.setArguments('i', 'mocha');
-			Argue.expect({'install':'i'}, {'remove':'r'}).should.be.equal('install');
-		});
-	});
-
-	describe("when argument alias described as array", () => {
-
-		it('should return full version of command if full given', () => {
-
-			Argue.setArguments('install', 'mocha');
-			Argue.expect(['install','i'], ['remove', 'r']).should.be.equal('install');
-		});
-
-		it('should return full version of command if shirt given', () => {
-
-			Argue.setArguments('i', 'mocha');
-			Argue.expect(['install','i'], ['remove', 'r']).should.be.equal('install');
-		});
-	});
-
-	describe("when argument described as string", () => {
-
-		it('should return command', () => {
-
-			Argue.setArguments('install', 'mocha');
-			Argue.expect('install', 'remove').should.be.equal('install');
-		});
-	});
-});

package/test/mocha.opts

@@ -1,2 +0,0 @@
---require should
---compilers js:babel-register

package/test/options-equal.js

@@ -1,172 +0,0 @@
-import * as Argue from '../src/lib';
-
-describe("optionsEqual()", () => {
-
-	describe("when option described as string", () => {
-
-		it('should throw error when given option is doesn\'t expected', () => {
-
-			Argue.setArguments('--input');
-			(() => Argue.optionsEqual("output")).should.throw(Error, { 
-				message: 'Unexpected key "input".' 
-			});
-		});
-
-		it('should return empty object when no more arguments', () => {
-
-			Argue.setArguments();
-			Argue.strictOptions([], ["output"]).should.be.deepEqual({});
-		});
-
-		it('should return empty object when key given instead flag', () => {
-
-			Argue.setArguments('install');
-			Argue.optionsEqual("output").should.be.deepEqual({});
-		});
-
-		it('should return object with values', () => {
-
-			Argue.setArguments('--output=/var/tmp.txt', '--verbose');
-			Argue.optionsEqual("output", "verbose").should.be.deepEqual({
-				output: '/var/tmp.txt',
-				verbose: true
-			});
-		});
-
-		it('should read all flags and return object with values', () => {
-
-			Argue.setArguments('lift', '--verbose');
-			Argue.optionsEqual("verbose").should.be.deepEqual({
-				verbose: true
-			});
-		});
-	});
-
-	describe("when option described as array", () => {
-
-		it('should throw error when given option is doesn\'t expected', () => {
-
-			Argue.setArguments('--input');
-			(() => Argue.optionsEqual(["output", "o"])).should.throw(Error, { 
-				message: 'Unexpected key "input".' 
-			});
-		});
-
-		it('should return empty object when no more arguments', () => {
-
-			Argue.setArguments();
-			Argue.optionsEqual(["output", "o"]).should.be.deepEqual({});
-		});
-
-		it('should return empty object when key given instead flag', () => {
-
-			Argue.setArguments('install');
-			Argue.optionsEqual(["output", "o"]).should.be.deepEqual({});
-		});
-
-		it('should return object with values if full flag is given', () => {
-
-			Argue.setArguments('--output=/var/tmp.txt');
-			Argue.optionsEqual(["output", "o"]).should.be.deepEqual({
-				output: ['/var/tmp.txt']
-			});
-		});
-
-		it('should return object with array values if full flag is given', () => {
-
-			Argue.setArguments('--output=/var/tmp.txt,/var/log/my');
-			Argue.optionsEqual(["output", "o"]).should.be.deepEqual({
-				output: ['/var/tmp.txt', '/var/log/my']
-			});
-		});
-
-		it('should read all flags and return object with values if full flag is given', () => {
-
-			Argue.setArguments('lift', '--verbose');
-			Argue.optionsEqual(["verbose", "v"]).should.be.deepEqual({
-				verbose: true
-			});
-		});
-
-		it('should return object with values if shirt flag is given', () => {
-
-			Argue.setArguments('-o=/var/tmp.txt');
-			Argue.optionsEqual(["output", "o"]).should.be.deepEqual({
-				output: ['/var/tmp.txt']
-			});
-		});
-
-		it('should return object with array values if shirt flag is given', () => {
-
-			Argue.setArguments('-o=/var/tmp.txt,/var/log/my');
-			Argue.optionsEqual(["output", "o"]).should.be.deepEqual({
-				output: ['/var/tmp.txt', '/var/log/my']
-			});
-		});
-
-		it('should read all flags and return object with values if shirt flag is given', () => {
-
-			Argue.setArguments('lift', '-v');
-			Argue.optionsEqual(["verbose", "v"]).should.be.deepEqual({
-				verbose: true
-			});
-		});
-	});
-
-	describe("when option described as object", () => {
-
-		it('should throw error when given option is doesn\'t expected', () => {
-
-			Argue.setArguments('--input');
-			(() => Argue.optionsEqual({"output": "o"})).should.throw(Error, { 
-				message: 'Unexpected key "input".' 
-			});
-		});
-
-		it('should return empty object when no more arguments', () => {
-
-			Argue.setArguments();
-			Argue.optionsEqual({"output": "o"}).should.be.deepEqual({});
-		});
-
-		it('should return empty object when key given instead flag', () => {
-
-			Argue.setArguments('install');
-			Argue.optionsEqual({"output": "o"}).should.be.deepEqual({});
-		});
-
-		it('should return object with values if full flag is given', () => {
-
-			Argue.setArguments('--output=/var/tmp.txt', '--verbose');
-			Argue.optionsEqual({"output": "o"}, {"verbose":"v"}).should.be.deepEqual({
-				output: '/var/tmp.txt',
-				verbose: true
-			});
-		});
-
-		it('should read all flags and return object with values if full flag is given', () => {
-
-			Argue.setArguments('lift', '--verbose');
-			Argue.optionsEqual({"verbose": "v"}).should.be.deepEqual({
-				verbose: true
-			});
-		});
-
-		it('should return object with values if shirt flag is given', () => {
-
-			Argue.setArguments('-o=/var/tmp.txt', '-v');
-			Argue.optionsEqual({"output": "o"}, {"verbose":"v"}).should.be.deepEqual({
-				output: '/var/tmp.txt',
-				verbose: true
-			});
-		});
-
-		it('should read all flags and return object with values if shirt flag is given', () => {
-
-			Argue.setArguments('lift', '-v');
-			Argue.optionsEqual({"verbose": "v"}).should.be.deepEqual({
-				verbose: true
-			});
-		});
-	});
-});