0.4.2 • Published 10 months ago
speaking-order-cli v0.4.2
Order CLI
A small command line utility to shuffle a list of names for a meeting round-table speaking order.
Provided a list of names, the list will be shuffled in a random order and copied to the clipboard.
Requirements
Node >= 16
Usage
> npx speaking-order-cli [options] [--] <participants...>Or
> npm install -g speaking-order-cli
> order [options] [--] <participants...>Options
| Option | Description | Type |
|---|---|---|
--debug | Output debug information | boolean |
-p, --prefix | Output prefix | string |
-s, --separators | Output list separators (i.e., separator, lastSeparator) | arraydefault: ",", "then"] |
--oc, --oxford-comma | Use the Oxford comma (e.g., "Alice, Bob, and Charlie"; applies the separator to the second-to-last item) | boolean |
--cc, --clipboard | Copy the output to the clipboard (to disable: --no-cc, --no-clipboard) | boolean |
--clr, --colors | Colorize the output (to disable: --no-clr, --no-colors) | boolean |
-h, --help | Show help | boolean |
-v, --version | Show version number | boolean |
Examples
> npx order Alice Bob Charlie
Speaking order: Bob, Charlie then Alice
> npx order -p "Here's the order: " Alice Bob Charlie
Here's the order: Charlie, Bob then Alice
> npx order -s ";" "and" --oc -- Alice Bob Charlie
Speaking order: Alice; Charlie; and BobLimitations
There's a self-imposed maximum of 16 participants.
Future
For this MVP, I was hoping to implement the ability to read from a local file. The self-imposed maximum of 16 participants was to limit the amount of data that would be output from a file.