UNPKG

option-parser

Version:

Command-line option parser similar to getopt

github.com/tests-always-included/option-parser/

tests-always-included/option-parser

143 lines (73 loc) • 5.09 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
`OptionParameter` ================= An instance of the `OptionParameter` class represents a single command-line option. It knows about all of the ways that option can get specified, if it takes a value, and what values were passed in from the command-line. `Constructor(short, long, message = null)` ------------------------------------------ Create a new instance of the class. `short` and `long` indicate what options are allowed. Multiple short and long options can be specified by passing an Array of allowed options. A wildcard short option of `*` or `-` will mean that this option should match any short or long option that didn't match anything else. `short` can be an Array of strings or just a single string. Each string should be exactly 1 character long. `null` means that the option should not have a short flag to trigger it. `long` can be an Array of strings or just a single string. If there should be no long option, pass `null`. `message` is the help message to be displayed for this option. When not specifying a help message, the option is hidden. `action(callback)` ------------------ Set an action to be performed when you specify this parameter. The callback must be a Function. If an invalid `callback` is used, an Error is thrown. `argument(name, required = true)` --------------------------------- Specify that this parameter takes a value from the command line. `name` is a string for the help message. It isn't used anywhere else. `required` is a boolean and will default to `true` if not passed. `count()` --------- Returns the number of times this parameter was used on the command line. `handleArgument(option, value = null)` -------------------------------------- Performs validation with the optionally specified validation callback. If that fails, will throw an Error. Once it passes the validation step, an action callback may be executed if one was assigned via `action()`. Lastly, this adds the value to the `getopt()` version of the arguments. This is intended to be only used internally by `OptionParser`. `getopt()` ---------- Returns an Array to be used by `OptionParser.getopt()`. `getWidth()` ------------ Returns the terminal width, employing whatever tricks that might work for you. Defaults to 80 if it can't find an actual terminal's width. `help(pad = 16, gutter = 2, width = null)` ------------------------------------------ Returns a string describing this option and how to invoke it. `pad` is the amount of space on the left for indenting the help option. It defaults to 16 spaces. `gutter` is the minimum amount of space required at the end of the short and long options and before the beginning of the help text. If there isn't this much space, the options will be put on a separate line. `width` is the size of the terminal. The default is `null`, which means the option should call `getWidth()` and try to figure out the terminal width itself. `matchAutocomplete(arg)` ------------------------ Returns an array of options that might match if the user just didn't finish the entire long option. For instance, the `arg` of "lo" would match "--long". This is only intended to be called from `OptionParser` during long option autocompletion. `matchLongArgument(arg)` ------------------------ Returns `true` if the argument exactly matches a long argument for this parameter. `matchShortArgument(arg)` ------------------------- Returns `true` if the argument exactly matches a short argument for this parameter. `matchWildcard()` ----------------- Returns `true` if this parameter is considered a "wildcard" parameter. This means that a short option is either `*` or `-`. `usesArgument()` ---------------- Returns whether or not the parameter takes an argument. Return value is a string-based code. This is intended to only be called from `OptionParser`. `validateCallback(callback)` ---------------------------- Returns true if the callback is valid. This merely checks if `callback` is a Function. Throws an Error if an invalid callback is specified. `validation(callback)` ---------------------- Set a validation function to be performed when you specify this parameter. The `callback` must be a Function. The validation callback will take a single parameter, which is the value specified for the parameter. If the value is valid, a falsy value should be returned. Otherwise, return an informative message as a string, which is set as a thrown Error's message. If an invalid `callback` is used, an Error is thrown. `value()` --------- For a parameter that takes values, returns the last value specified. Otherwise return the number of times this parameter was specified. Similar to `values()`. `values()` ---------- For a parameter that takes values, returns an Array that contains all values ever set on the command line. Otherwise returns the number of times the parameter was specified. `wrap(str, pad, width)` ----------------------- Rewraps `str` to fit within `width`. When newlines are added, indents the next line with `pad` spaces.