oargv

Turns an object into a bash command.

☁️ Installation

$ npm i --save oargv

📋 Example

// Dependencies
var OArgv = require("oargv");

console.log(OArgv({
    r: true
  , _: ["target.zip", "somedir"]
}, "zip", true));
// => zip "-r" "target.zip" "somedir"

console.log(OArgv({
    d: "http://ionicabizau.net"
  , tt: true
  , size: "600x800"
}, "bat", true));
// => bat "-d" "http://ionicabizau.net" "--tt" "--size" "600x800"

console.log(OArgv({
    escaping: "She said: \"Hello World\"!"
}, "foo", true));
// => foo "--escaping" "She said: \"Hello World\"!"

console.log(OArgv({
    noCommand: "foo"
  , b: true
}));
// => [ '--noCommand', 'foo', '-b' ]

console.log(OArgv({
    __: "="
  , custom: "Separator"
}, "foo"));
// => [ 'foo', '--custom=Separator' ]

console.log(OArgv({
    author: ["foo@bar.com", "bar@foo.com"]
}));
// => [ '--author', 'foo@bar.com', '--author', 'bar@foo.com' ]

console.log(OArgv({
    author: ["foo@bar.com", "bar@foo.com"]
}, true));
// => "--author" "foo@bar.com" "--author" "bar@foo.com"

console.log(OArgv({
    author: ["foo@bar.com", "bar@foo.com"]
  , __: "="
}, true));
// => "--author=foo@bar.com" "--author=bar@foo.com"

📝 Documentation

OArgv(options, prgm, stringify)

Stringifies the options, building a command.

Params

• Object options: The options that should be stringified. If it contains the _ field, then this should be an Array of strings, that representing values that will be added at the end of the command. The __ field is the separator (default: " ").
• String prgm: The program that executes the command (default: "").
• Boolean stringify: If true, the result array will be stringified (default: false).

Return

• String|Array The stringified arguments (if stringify is true) or the array of arguments.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• batjs—This is the NodeJS bridge for BAT -- A minimalist tool for building native desktop applications using WEB technologies.
• bloggify—A set of tools for Bloggify administration.
• cdnjs-importer—Easy way to import a library into CDNJS.
• cobol—COBOL bridge for NodeJS which allows you to run COBOL code from NodeJS.
• electroner—Start ElectronJS apps from Node.js.
• engine-tools (by jillix)—Engine Tools library and CLI app.
• git-package-json—Get the package.json contents from git repositories.
• git-stats-importer—Imports your commits from a repository into git-stats history.
• gpm—npm + git = gpm - Install NPM packages and dependencies from git repositories.
• initial-commit-date—Get the initial commit date of a git repository.
• share-term—Share the terminal with your friends.
• spawn-npm—Run npm commands by creating child processes.

📜 License

MIT © Ionică Bizău