⛳️ Zero dependency command flag generator from a simple javascript object
MIT License
This packages aim is to simplify programmatically generate flags to use in Unix-style command by declaring them with an object literal and turning them into an array or a string of usable flags.
Why?
You can install locally
npm i flaggy
const flaggy = require("flaggy");
flaggy({ d: true, path: "/some/path", verbose: true }); // ["--path", "/some/path", "--verbose", "-d"]
flaggy({ d: true, path: "/some/path", verbose: true }, true); // "--path /some/path --verbose" -d
parameter | type | description | default |
---|---|---|---|
[0] | Object | Object with the value to stringify as flags | null |
[1] | Boolean | Stringify result? if false returns argv array else return stringified flags | false |
const fstring = flaggy(
{
t: true,
number: 1,
boolean: true,
s: "short",
string: "hi",
iCantGetWhy: "This is so long",
weHaveListToo: ["one", "long value"],
},
true
);
// -t --number 1 --boolean -s short --string hi --i-cant-get-why="This is so long" --we-have-list-too one --we-have-list-too="long value"
Project is pretty simple and straight forward for what is my needs, but if you have any idea you're welcome.
This projects uses commitizen so be sure to use standard commit format or PR won't be accepted
git checkout -b feature/AmazingFeature
)git commit -m 'feat(scope): some AmazingFeature'
)git push origin feature/AmazingFeature
)Distributed under the MIT License. See LICENSE
for more information.
Simone Corsi - @im_simonecorsi