Deployed the page to Github Pages.
This commit is contained in:
parent
1d79754e93
commit
2c89899458
62797 changed files with 6551425 additions and 15279 deletions
55
node_modules/jackspeak/LICENSE.md
generated
vendored
Normal file
55
node_modules/jackspeak/LICENSE.md
generated
vendored
Normal file
|
@ -0,0 +1,55 @@
|
|||
# Blue Oak Model License
|
||||
|
||||
Version 1.0.0
|
||||
|
||||
## Purpose
|
||||
|
||||
This license gives everyone as much permission to work with
|
||||
this software as possible, while protecting contributors
|
||||
from liability.
|
||||
|
||||
## Acceptance
|
||||
|
||||
In order to receive this license, you must agree to its
|
||||
rules. The rules of this license are both obligations
|
||||
under that agreement and conditions to your license.
|
||||
You must not do anything with this software that triggers
|
||||
a rule that you cannot or will not follow.
|
||||
|
||||
## Copyright
|
||||
|
||||
Each contributor licenses you to do everything with this
|
||||
software that would otherwise infringe that contributor's
|
||||
copyright in it.
|
||||
|
||||
## Notices
|
||||
|
||||
You must ensure that everyone who gets a copy of
|
||||
any part of this software from you, with or without
|
||||
changes, also gets the text of this license or a link to
|
||||
<https://blueoakcouncil.org/license/1.0.0>.
|
||||
|
||||
## Excuse
|
||||
|
||||
If anyone notifies you in writing that you have not
|
||||
complied with [Notices](#notices), you can keep your
|
||||
license by taking all practical steps to comply within 30
|
||||
days after the notice. If you do not do so, your license
|
||||
ends immediately.
|
||||
|
||||
## Patent
|
||||
|
||||
Each contributor licenses you to do everything with this
|
||||
software that would otherwise infringe any patent claims
|
||||
they can license or become able to license.
|
||||
|
||||
## Reliability
|
||||
|
||||
No contributor can revoke this license.
|
||||
|
||||
## No Liability
|
||||
|
||||
**_As far as the law allows, this software comes as is,
|
||||
without any warranty or condition, and no contributor
|
||||
will be liable to anyone for any damages related to this
|
||||
software or this license, under any kind of legal claim._**
|
357
node_modules/jackspeak/README.md
generated
vendored
Normal file
357
node_modules/jackspeak/README.md
generated
vendored
Normal file
|
@ -0,0 +1,357 @@
|
|||
# jackspeak
|
||||
|
||||
A very strict and proper argument parser.
|
||||
|
||||
Validate string, boolean, and number options, from the command
|
||||
line and the environment.
|
||||
|
||||
Call the `jack` method with a config object, and then chain
|
||||
methods off of it.
|
||||
|
||||
At the end, call the `.parse()` method, and you'll get an object
|
||||
with `positionals` and `values` members.
|
||||
|
||||
Any unrecognized configs or invalid values will throw an error.
|
||||
|
||||
As long as you define configs using object literals, types will
|
||||
be properly inferred and TypeScript will know what kinds of
|
||||
things you got.
|
||||
|
||||
If you give it a prefix for environment variables, then defaults
|
||||
will be read from the environment, and parsed values written back
|
||||
to it, so you can easily pass configs through to child processes.
|
||||
|
||||
Automatically generates a `usage`/`help` banner by calling the
|
||||
`.usage()` method.
|
||||
|
||||
Unless otherwise noted, all methods return the object itself.
|
||||
|
||||
## USAGE
|
||||
|
||||
```js
|
||||
import { jack } from 'jackspeak'
|
||||
// this works too:
|
||||
// const { jack } = require('jackspeak')
|
||||
|
||||
const { positionals, values } = jack({ envPrefix: 'FOO' })
|
||||
.flag({
|
||||
asdf: { description: 'sets the asfd flag', short: 'a', default: true },
|
||||
'no-asdf': { description: 'unsets the asdf flag', short: 'A' },
|
||||
foo: { description: 'another boolean', short: 'f' },
|
||||
})
|
||||
.optList({
|
||||
'ip-addrs': {
|
||||
description: 'addresses to ip things',
|
||||
delim: ',', // defaults to '\n'
|
||||
default: ['127.0.0.1'],
|
||||
},
|
||||
})
|
||||
.parse([
|
||||
'some',
|
||||
'positional',
|
||||
'--ip-addrs',
|
||||
'192.168.0.1',
|
||||
'--ip-addrs',
|
||||
'1.1.1.1',
|
||||
'args',
|
||||
'--foo', // sets the foo flag
|
||||
'-A', // short for --no-asdf, sets asdf flag to false
|
||||
])
|
||||
|
||||
console.log(process.env.FOO_ASDF) // '0'
|
||||
console.log(process.env.FOO_FOO) // '1'
|
||||
console.log(values) // {
|
||||
// 'ip-addrs': ['192.168.0.1', '1.1.1.1'],
|
||||
// foo: true,
|
||||
// asdf: false,
|
||||
// }
|
||||
console.log(process.env.FOO_IP_ADDRS) // '192.168.0.1,1.1.1.1'
|
||||
console.log(positionals) // ['some', 'positional', 'args']
|
||||
```
|
||||
|
||||
## `jack(options: JackOptions = {}) => Jack`
|
||||
|
||||
Returns a `Jack` object that can be used to chain and add
|
||||
field definitions. The other methods (apart from `validate()`,
|
||||
`parse()`, and `usage()` obviously) return the same Jack object,
|
||||
updated with the new types, so they can be chained together as
|
||||
shown in the code examples.
|
||||
|
||||
Options:
|
||||
|
||||
- `allowPositionals` Defaults to true. Set to `false` to not
|
||||
allow any positional arguments.
|
||||
|
||||
- `envPrefix` Set to a string to write configs to and read
|
||||
configs from the environment. For example, if set to `MY_APP`
|
||||
then the `foo-bar` config will default based on the value of
|
||||
`env.MY_APP_FOO_BAR` and will write back to that when parsed.
|
||||
|
||||
Boolean values are written as `'1'` and `'0'`, and will be
|
||||
treated as `true` if they're `'1'` or false otherwise.
|
||||
|
||||
Number values are written with their `toString()`
|
||||
representation.
|
||||
|
||||
Strings are just strings.
|
||||
|
||||
Any value with `multiple: true` will be represented in the
|
||||
environment split by a delimiter, which defaults to `\n`.
|
||||
|
||||
- `env` The place to read/write environment variables. Defaults
|
||||
to `process.env`.
|
||||
|
||||
- `usage` A short usage string to print at the top of the help
|
||||
banner.
|
||||
|
||||
- `stopAtPositional` Boolean, default false. Stop parsing opts
|
||||
and flags at the first positional argument. This is useful if
|
||||
you want to pass certain options to subcommands, like some
|
||||
programs do, so you can stop parsing and pass the positionals
|
||||
to the subcommand to parse.
|
||||
|
||||
- `stopAtPositionalTest` Conditional `stopAtPositional`. Provide
|
||||
a function that takes a positional argument string and returns
|
||||
boolean. If it returns `true`, then parsing will stop. Useful
|
||||
when _some_ subcommands should parse the rest of the command
|
||||
line options, and others should not.
|
||||
|
||||
### `Jack.heading(text: string, level?: 1 | 2 | 3 | 4 | 5 | 6)`
|
||||
|
||||
Define a short string heading, used in the `usage()` output.
|
||||
|
||||
Indentation of the heading and subsequent description/config
|
||||
usage entries (up until the next heading) is set by the heading
|
||||
level.
|
||||
|
||||
If the first usage item defined is a heading, it is always
|
||||
treated as level 1, regardless of the argument provided.
|
||||
|
||||
Headings level 1 and 2 will have a line of padding underneath
|
||||
them. Headings level 3 through 6 will not.
|
||||
|
||||
### `Jack.description(text: string, { pre?: boolean } = {})`
|
||||
|
||||
Define a long string description, used in the `usage()` output.
|
||||
|
||||
If the `pre` option is set to `true`, then whitespace will not be
|
||||
normalized. However, if any line is too long for the width
|
||||
allotted, it will still be wrapped.
|
||||
|
||||
## Option Definitions
|
||||
|
||||
Configs are defined by calling the appropriate field definition
|
||||
method with an object where the keys are the long option name,
|
||||
and the value defines the config.
|
||||
|
||||
Options:
|
||||
|
||||
- `type` Only needed for the `addFields` method, as the others
|
||||
set it implicitly. Can be `'string'`, `'boolean'`, or
|
||||
`'number'`.
|
||||
- `multiple` Only needed for the `addFields` method, as the
|
||||
others set it implicitly. Set to `true` to define an array
|
||||
type. This means that it can be set on the CLI multiple times,
|
||||
set as an array in the `values`
|
||||
and it is represented in the environment as a delimited string.
|
||||
- `short` A one-character shorthand for the option.
|
||||
- `description` Some words to describe what this option is and
|
||||
why you'd set it.
|
||||
- `hint` (Only relevant for non-boolean types) The thing to show
|
||||
in the usage output, like `--option=<hint>`
|
||||
- `validate` A function that returns false (or throws) if an
|
||||
option value is invalid.
|
||||
- `validOptions` An array of strings or numbers that define the
|
||||
valid values that can be set. This is not allowed on `boolean`
|
||||
(flag) options. May be used along with a `validate()` method.
|
||||
- `default` A default value for the field. Note that this may be
|
||||
overridden by an environment variable, if present.
|
||||
|
||||
### `Jack.flag({ [option: string]: definition, ... })`
|
||||
|
||||
Define one or more boolean fields.
|
||||
|
||||
Boolean options may be set to `false` by using a
|
||||
`--no-${optionName}` argument, which will be implicitly created
|
||||
if it's not defined to be something else.
|
||||
|
||||
If a boolean option named `no-${optionName}` with the same
|
||||
`multiple` setting is in the configuration, then that will be
|
||||
treated as a negating flag.
|
||||
|
||||
### `Jack.flagList({ [option: string]: definition, ... })`
|
||||
|
||||
Define one or more boolean array fields.
|
||||
|
||||
### `Jack.num({ [option: string]: definition, ... })`
|
||||
|
||||
Define one or more number fields. These will be set in the
|
||||
environment as a stringified number, and included in the `values`
|
||||
object as a number.
|
||||
|
||||
### `Jack.numList({ [option: string]: definition, ... })`
|
||||
|
||||
Define one or more number list fields. These will be set in the
|
||||
environment as a delimited set of stringified numbers, and
|
||||
included in the `values` as a number array.
|
||||
|
||||
### `Jack.opt({ [option: string]: definition, ... })`
|
||||
|
||||
Define one or more string option fields.
|
||||
|
||||
### `Jack.optList({ [option: string]: definition, ... })`
|
||||
|
||||
Define one or more string list fields.
|
||||
|
||||
### `Jack.addFields({ [option: string]: definition, ... })`
|
||||
|
||||
Define one or more fields of any type. Note that `type` and
|
||||
`multiple` must be set explicitly on each definition when using
|
||||
this method.
|
||||
|
||||
## Actions
|
||||
|
||||
Use these methods on a Jack object that's already had its config
|
||||
fields defined.
|
||||
|
||||
### `Jack.parse(args: string[] = process.argv): { positionals: string[], values: OptionsResults }`
|
||||
|
||||
Parse the arguments list, write to the environment if `envPrefix`
|
||||
is set, and returned the parsed values and remaining positional
|
||||
arguments.
|
||||
|
||||
### `Jack.validate(o: any): asserts o is OptionsResults`
|
||||
|
||||
Throws an error if the object provided is not a valid result set,
|
||||
for the configurations defined thusfar.
|
||||
|
||||
### `Jack.usage(): string`
|
||||
|
||||
Returns the compiled `usage` string, with all option descriptions
|
||||
and heading/description text, wrapped to the appropriate width
|
||||
for the terminal.
|
||||
|
||||
### `Jack.setConfigValues(options: OptionsResults, src?: string)`
|
||||
|
||||
Validate the `options` argument, and set the default value for
|
||||
each field that appears in the options.
|
||||
|
||||
Values provided will be overridden by environment variables or
|
||||
command line arguments.
|
||||
|
||||
### `Jack.usageMarkdown(): string`
|
||||
|
||||
Returns the compiled `usage` string, with all option descriptions
|
||||
and heading/description text, but as markdown instead of
|
||||
formatted for a terminal, for generating HTML documentation for
|
||||
your CLI.
|
||||
|
||||
## Some Example Code
|
||||
|
||||
Also see [the examples
|
||||
folder](https://github.com/isaacs/jackspeak/tree/master/examples)
|
||||
|
||||
```js
|
||||
import { jack } from 'jackspeak'
|
||||
|
||||
const j = jack({
|
||||
// Optional
|
||||
// This will be auto-generated from the descriptions if not supplied
|
||||
// top level usage line, printed by -h
|
||||
// will be auto-generated if not specified
|
||||
usage: 'foo [options] <files>',
|
||||
})
|
||||
.heading('The best Foo that ever Fooed')
|
||||
.description(
|
||||
`
|
||||
Executes all the files and interprets their output as
|
||||
TAP formatted test result data.
|
||||
|
||||
To parse TAP data from stdin, specify "-" as a filename.
|
||||
`,
|
||||
)
|
||||
|
||||
// flags don't take a value, they're boolean on or off, and can be
|
||||
// turned off by prefixing with `--no-`
|
||||
// so this adds support for -b to mean --bail, or -B to mean --no-bail
|
||||
.flag({
|
||||
flag: {
|
||||
// specify a short value if you like. this must be a single char
|
||||
short: 'f',
|
||||
// description is optional as well.
|
||||
description: `Make the flags wave`,
|
||||
// default value for flags is 'false', unless you change it
|
||||
default: true,
|
||||
},
|
||||
'no-flag': {
|
||||
// you can can always negate a flag with `--no-flag`
|
||||
// specifying a negate option will let you define a short
|
||||
// single-char option for negation.
|
||||
short: 'F',
|
||||
description: `Do not wave the flags`,
|
||||
},
|
||||
})
|
||||
|
||||
// Options that take a value are specified with `opt()`
|
||||
.opt({
|
||||
reporter: {
|
||||
short: 'R',
|
||||
description: 'the style of report to display',
|
||||
},
|
||||
})
|
||||
|
||||
// if you want a number, say so, and jackspeak will enforce it
|
||||
.num({
|
||||
jobs: {
|
||||
short: 'j',
|
||||
description: 'how many jobs to run in parallel',
|
||||
default: 1,
|
||||
},
|
||||
})
|
||||
|
||||
// A list is an option that can be specified multiple times,
|
||||
// to expand into an array of all the settings. Normal opts
|
||||
// will just give you the last value specified.
|
||||
.optList({
|
||||
'node-arg': {},
|
||||
})
|
||||
|
||||
// a flagList is an array of booleans, so `-ddd` is [true, true, true]
|
||||
// count the `true` values to treat it as a counter.
|
||||
.flagList({
|
||||
debug: { short: 'd' },
|
||||
})
|
||||
|
||||
// opts take a value, and is set to the string in the results
|
||||
// you can combine multiple short-form flags together, but
|
||||
// an opt will end the combine chain, posix-style. So,
|
||||
// -bofilename would be like --bail --output-file=filename
|
||||
.opt({
|
||||
'output-file': {
|
||||
short: 'o',
|
||||
// optional: make it -o<file> in the help output insead of -o<value>
|
||||
hint: 'file',
|
||||
description: `Send the raw output to the specified file.`,
|
||||
},
|
||||
})
|
||||
|
||||
// now we can parse argv like this:
|
||||
const { values, positionals } = j.parse(process.argv)
|
||||
|
||||
// or decide to show the usage banner
|
||||
console.log(j.usage())
|
||||
|
||||
// or validate an object config we got from somewhere else
|
||||
try {
|
||||
j.validate(someConfig)
|
||||
} catch (er) {
|
||||
console.error('someConfig is not valid!', er)
|
||||
}
|
||||
```
|
||||
|
||||
## Name
|
||||
|
||||
The inspiration for this module is [yargs](http://npm.im/yargs), which
|
||||
is pirate talk themed. Yargs has all the features, and is infinitely
|
||||
flexible. "Jackspeak" is the slang of the royal navy. This module
|
||||
does not have all the features. It is declarative and rigid by design.
|
315
node_modules/jackspeak/dist/commonjs/index.d.ts
generated
vendored
Normal file
315
node_modules/jackspeak/dist/commonjs/index.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,315 @@
|
|||
/// <reference types="node" />
|
||||
export type ConfigType = 'number' | 'string' | 'boolean';
|
||||
/**
|
||||
* Given a Jack object, get the typeof its ConfigSet
|
||||
*/
|
||||
export type Unwrap<J> = J extends Jack<infer C> ? C : never;
|
||||
import { inspect, InspectOptions } from 'node:util';
|
||||
/**
|
||||
* Defines the type of value that is valid, given a config definition's
|
||||
* {@link ConfigType} and boolean multiple setting
|
||||
*/
|
||||
export type ValidValue<T extends ConfigType = ConfigType, M extends boolean = boolean> = [
|
||||
T,
|
||||
M
|
||||
] extends ['number', true] ? number[] : [T, M] extends ['string', true] ? string[] : [T, M] extends ['boolean', true] ? boolean[] : [T, M] extends ['number', false] ? number : [T, M] extends ['string', false] ? string : [T, M] extends ['boolean', false] ? boolean : [T, M] extends ['string', boolean] ? string | string[] : [T, M] extends ['boolean', boolean] ? boolean | boolean[] : [T, M] extends ['number', boolean] ? number | number[] : [T, M] extends [ConfigType, false] ? string | number | boolean : [T, M] extends [ConfigType, true] ? string[] | number[] | boolean[] : string | number | boolean | string[] | number[] | boolean[];
|
||||
/**
|
||||
* The meta information for a config option definition, when the
|
||||
* type and multiple values can be inferred by the method being used
|
||||
*/
|
||||
export type ConfigOptionMeta<T extends ConfigType, M extends boolean = boolean, O extends undefined | (T extends 'boolean' ? never : T extends 'string' ? readonly string[] : T extends 'number' ? readonly number[] : readonly number[] | readonly string[]) = undefined | (T extends 'boolean' ? never : T extends 'string' ? readonly string[] : T extends 'number' ? readonly number[] : readonly number[] | readonly string[])> = {
|
||||
default?: undefined | (ValidValue<T, M> & (O extends number[] | string[] ? M extends false ? O[number] : O[number][] : unknown));
|
||||
validOptions?: O;
|
||||
description?: string;
|
||||
validate?: ((v: unknown) => v is ValidValue<T, M>) | ((v: unknown) => boolean);
|
||||
short?: string | undefined;
|
||||
type?: T;
|
||||
hint?: T extends 'boolean' ? never : string;
|
||||
delim?: M extends true ? string : never;
|
||||
} & (M extends false ? {
|
||||
multiple?: false | undefined;
|
||||
} : M extends true ? {
|
||||
multiple: true;
|
||||
} : {
|
||||
multiple?: boolean;
|
||||
});
|
||||
/**
|
||||
* A set of {@link ConfigOptionMeta} fields, referenced by their longOption
|
||||
* string values.
|
||||
*/
|
||||
export type ConfigMetaSet<T extends ConfigType, M extends boolean = boolean> = {
|
||||
[longOption: string]: ConfigOptionMeta<T, M>;
|
||||
};
|
||||
/**
|
||||
* Infer {@link ConfigSet} fields from a given {@link ConfigMetaSet}
|
||||
*/
|
||||
export type ConfigSetFromMetaSet<T extends ConfigType, M extends boolean, S extends ConfigMetaSet<T, M>> = {
|
||||
[longOption in keyof S]: ConfigOptionBase<T, M>;
|
||||
};
|
||||
/**
|
||||
* Fields that can be set on a {@link ConfigOptionBase} or
|
||||
* {@link ConfigOptionMeta} based on whether or not the field is known to be
|
||||
* multiple.
|
||||
*/
|
||||
export type MultiType<M extends boolean> = M extends true ? {
|
||||
multiple: true;
|
||||
delim?: string | undefined;
|
||||
} : M extends false ? {
|
||||
multiple?: false | undefined;
|
||||
delim?: undefined;
|
||||
} : {
|
||||
multiple?: boolean | undefined;
|
||||
delim?: string | undefined;
|
||||
};
|
||||
/**
|
||||
* A config field definition, in its full representation.
|
||||
*/
|
||||
export type ConfigOptionBase<T extends ConfigType, M extends boolean = boolean> = {
|
||||
type: T;
|
||||
short?: string | undefined;
|
||||
default?: ValidValue<T, M> | undefined;
|
||||
description?: string;
|
||||
hint?: T extends 'boolean' ? undefined : string | undefined;
|
||||
validate?: (v: unknown) => v is ValidValue<T, M>;
|
||||
validOptions?: T extends 'boolean' ? undefined : T extends 'string' ? readonly string[] : T extends 'number' ? readonly number[] : readonly number[] | readonly string[];
|
||||
} & MultiType<M>;
|
||||
export declare const isConfigType: (t: string) => t is ConfigType;
|
||||
export declare const isConfigOption: <T extends ConfigType, M extends boolean>(o: any, type: T, multi: M) => o is ConfigOptionBase<T, M>;
|
||||
/**
|
||||
* A set of {@link ConfigOptionBase} objects, referenced by their longOption
|
||||
* string values.
|
||||
*/
|
||||
export type ConfigSet = {
|
||||
[longOption: string]: ConfigOptionBase<ConfigType>;
|
||||
};
|
||||
/**
|
||||
* The 'values' field returned by {@link Jack#parse}
|
||||
*/
|
||||
export type OptionsResults<T extends ConfigSet> = {
|
||||
[k in keyof T]?: T[k]['validOptions'] extends (readonly string[] | readonly number[]) ? T[k] extends ConfigOptionBase<'string' | 'number', false> ? T[k]['validOptions'][number] : T[k] extends ConfigOptionBase<'string' | 'number', true> ? T[k]['validOptions'][number][] : never : T[k] extends ConfigOptionBase<'string', false> ? string : T[k] extends ConfigOptionBase<'string', true> ? string[] : T[k] extends ConfigOptionBase<'number', false> ? number : T[k] extends ConfigOptionBase<'number', true> ? number[] : T[k] extends ConfigOptionBase<'boolean', false> ? boolean : T[k] extends ConfigOptionBase<'boolean', true> ? boolean[] : never;
|
||||
};
|
||||
/**
|
||||
* The object retured by {@link Jack#parse}
|
||||
*/
|
||||
export type Parsed<T extends ConfigSet> = {
|
||||
values: OptionsResults<T>;
|
||||
positionals: string[];
|
||||
};
|
||||
/**
|
||||
* A row used when generating the {@link Jack#usage} string
|
||||
*/
|
||||
export interface Row {
|
||||
left?: string;
|
||||
text: string;
|
||||
skipLine?: boolean;
|
||||
type?: string;
|
||||
}
|
||||
/**
|
||||
* A heading for a section in the usage, created by the jack.heading()
|
||||
* method.
|
||||
*
|
||||
* First heading is always level 1, subsequent headings default to 2.
|
||||
*
|
||||
* The level of the nearest heading level sets the indentation of the
|
||||
* description that follows.
|
||||
*/
|
||||
export interface Heading extends Row {
|
||||
type: 'heading';
|
||||
text: string;
|
||||
left?: '';
|
||||
skipLine?: boolean;
|
||||
level: number;
|
||||
pre?: boolean;
|
||||
}
|
||||
/**
|
||||
* An arbitrary blob of text describing some stuff, set by the
|
||||
* jack.description() method.
|
||||
*
|
||||
* Indentation determined by level of the nearest header.
|
||||
*/
|
||||
export interface Description extends Row {
|
||||
type: 'description';
|
||||
text: string;
|
||||
left?: '';
|
||||
skipLine?: boolean;
|
||||
pre?: boolean;
|
||||
}
|
||||
/**
|
||||
* A heading or description row used when generating the {@link Jack#usage}
|
||||
* string
|
||||
*/
|
||||
export type TextRow = Heading | Description;
|
||||
/**
|
||||
* Either a {@link TextRow} or a reference to a {@link ConfigOptionBase}
|
||||
*/
|
||||
export type UsageField = TextRow | {
|
||||
type: 'config';
|
||||
name: string;
|
||||
value: ConfigOptionBase<ConfigType>;
|
||||
};
|
||||
/**
|
||||
* Options provided to the {@link Jack} constructor
|
||||
*/
|
||||
export interface JackOptions {
|
||||
/**
|
||||
* Whether to allow positional arguments
|
||||
*
|
||||
* @default true
|
||||
*/
|
||||
allowPositionals?: boolean;
|
||||
/**
|
||||
* Prefix to use when reading/writing the environment variables
|
||||
*
|
||||
* If not specified, environment behavior will not be available.
|
||||
*/
|
||||
envPrefix?: string;
|
||||
/**
|
||||
* Environment object to read/write. Defaults `process.env`.
|
||||
* No effect if `envPrefix` is not set.
|
||||
*/
|
||||
env?: {
|
||||
[k: string]: string | undefined;
|
||||
};
|
||||
/**
|
||||
* A short usage string. If not provided, will be generated from the
|
||||
* options provided, but that can of course be rather verbose if
|
||||
* there are a lot of options.
|
||||
*/
|
||||
usage?: string;
|
||||
/**
|
||||
* Stop parsing flags and opts at the first positional argument.
|
||||
* This is to support cases like `cmd [flags] <subcmd> [options]`, where
|
||||
* each subcommand may have different options. This effectively treats
|
||||
* any positional as a `--` argument. Only relevant if `allowPositionals`
|
||||
* is true.
|
||||
*
|
||||
* To do subcommands, set this option, look at the first positional, and
|
||||
* parse the remaining positionals as appropriate.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
stopAtPositional?: boolean;
|
||||
/**
|
||||
* Conditional `stopAtPositional`. If set to a `(string)=>boolean` function,
|
||||
* will be called with each positional argument encountered. If the function
|
||||
* returns true, then parsing will stop at that point.
|
||||
*/
|
||||
stopAtPositionalTest?: (arg: string) => boolean;
|
||||
}
|
||||
/**
|
||||
* Class returned by the {@link jack} function and all configuration
|
||||
* definition methods. This is what gets chained together.
|
||||
*/
|
||||
export declare class Jack<C extends ConfigSet = {}> {
|
||||
#private;
|
||||
constructor(options?: JackOptions);
|
||||
/**
|
||||
* Set the default value (which will still be overridden by env or cli)
|
||||
* as if from a parsed config file. The optional `source` param, if
|
||||
* provided, will be included in error messages if a value is invalid or
|
||||
* unknown.
|
||||
*/
|
||||
setConfigValues(values: OptionsResults<C>, source?: string): this;
|
||||
/**
|
||||
* Parse a string of arguments, and return the resulting
|
||||
* `{ values, positionals }` object.
|
||||
*
|
||||
* If an {@link JackOptions#envPrefix} is set, then it will read default
|
||||
* values from the environment, and write the resulting values back
|
||||
* to the environment as well.
|
||||
*
|
||||
* Environment values always take precedence over any other value, except
|
||||
* an explicit CLI setting.
|
||||
*/
|
||||
parse(args?: string[]): Parsed<C>;
|
||||
loadEnvDefaults(): void;
|
||||
applyDefaults(p: Parsed<C>): void;
|
||||
/**
|
||||
* Only parse the command line arguments passed in.
|
||||
* Does not strip off the `node script.js` bits, so it must be just the
|
||||
* arguments you wish to have parsed.
|
||||
* Does not read from or write to the environment, or set defaults.
|
||||
*/
|
||||
parseRaw(args: string[]): Parsed<C>;
|
||||
/**
|
||||
* Validate that any arbitrary object is a valid configuration `values`
|
||||
* object. Useful when loading config files or other sources.
|
||||
*/
|
||||
validate(o: unknown): asserts o is Parsed<C>['values'];
|
||||
writeEnv(p: Parsed<C>): void;
|
||||
/**
|
||||
* Add a heading to the usage output banner
|
||||
*/
|
||||
heading(text: string, level?: 1 | 2 | 3 | 4 | 5 | 6, { pre }?: {
|
||||
pre?: boolean;
|
||||
}): Jack<C>;
|
||||
/**
|
||||
* Add a long-form description to the usage output at this position.
|
||||
*/
|
||||
description(text: string, { pre }?: {
|
||||
pre?: boolean;
|
||||
}): Jack<C>;
|
||||
/**
|
||||
* Add one or more number fields.
|
||||
*/
|
||||
num<F extends ConfigMetaSet<'number', false>>(fields: F): Jack<C & ConfigSetFromMetaSet<'number', false, F>>;
|
||||
/**
|
||||
* Add one or more multiple number fields.
|
||||
*/
|
||||
numList<F extends ConfigMetaSet<'number'>>(fields: F): Jack<C & ConfigSetFromMetaSet<'number', true, F>>;
|
||||
/**
|
||||
* Add one or more string option fields.
|
||||
*/
|
||||
opt<F extends ConfigMetaSet<'string', false>>(fields: F): Jack<C & ConfigSetFromMetaSet<'string', false, F>>;
|
||||
/**
|
||||
* Add one or more multiple string option fields.
|
||||
*/
|
||||
optList<F extends ConfigMetaSet<'string'>>(fields: F): Jack<C & ConfigSetFromMetaSet<'string', true, F>>;
|
||||
/**
|
||||
* Add one or more flag fields.
|
||||
*/
|
||||
flag<F extends ConfigMetaSet<'boolean', false>>(fields: F): Jack<C & ConfigSetFromMetaSet<'boolean', false, F>>;
|
||||
/**
|
||||
* Add one or more multiple flag fields.
|
||||
*/
|
||||
flagList<F extends ConfigMetaSet<'boolean'>>(fields: F): Jack<C & ConfigSetFromMetaSet<'boolean', true, F>>;
|
||||
/**
|
||||
* Generic field definition method. Similar to flag/flagList/number/etc,
|
||||
* but you must specify the `type` (and optionally `multiple` and `delim`)
|
||||
* fields on each one, or Jack won't know how to define them.
|
||||
*/
|
||||
addFields<F extends ConfigSet>(fields: F): Jack<C & F>;
|
||||
/**
|
||||
* Return the usage banner for the given configuration
|
||||
*/
|
||||
usage(): string;
|
||||
/**
|
||||
* Return the usage banner markdown for the given configuration
|
||||
*/
|
||||
usageMarkdown(): string;
|
||||
/**
|
||||
* Return the configuration options as a plain object
|
||||
*/
|
||||
toJSON(): {
|
||||
[k: string]: {
|
||||
hint?: string | undefined;
|
||||
default?: string | number | boolean | string[] | number[] | boolean[] | undefined;
|
||||
validOptions?: readonly number[] | readonly string[] | undefined;
|
||||
validate?: ((v: unknown) => v is string | number | boolean | string[] | number[] | boolean[]) | undefined;
|
||||
description?: string | undefined;
|
||||
short?: string | undefined;
|
||||
delim?: string | undefined;
|
||||
multiple?: boolean | undefined;
|
||||
type: ConfigType;
|
||||
};
|
||||
};
|
||||
/**
|
||||
* Custom printer for `util.inspect`
|
||||
*/
|
||||
[inspect.custom](_: number, options: InspectOptions): string;
|
||||
}
|
||||
/**
|
||||
* Main entry point. Create and return a {@link Jack} object.
|
||||
*/
|
||||
export declare const jack: (options?: JackOptions) => Jack<{}>;
|
||||
//# sourceMappingURL=index.d.ts.map
|
1
node_modules/jackspeak/dist/commonjs/index.d.ts.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/commonjs/index.d.ts.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
1010
node_modules/jackspeak/dist/commonjs/index.js
generated
vendored
Normal file
1010
node_modules/jackspeak/dist/commonjs/index.js
generated
vendored
Normal file
File diff suppressed because it is too large
Load diff
1
node_modules/jackspeak/dist/commonjs/index.js.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/commonjs/index.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
3
node_modules/jackspeak/dist/commonjs/package.json
generated
vendored
Normal file
3
node_modules/jackspeak/dist/commonjs/package.json
generated
vendored
Normal file
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"type": "commonjs"
|
||||
}
|
1
node_modules/jackspeak/dist/commonjs/parse-args-cjs.cjs.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/commonjs/parse-args-cjs.cjs.map
generated
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
{"version":3,"file":"parse-args-cjs.cjs","sourceRoot":"","sources":["../../src/parse-args-cjs.cts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA4B;AAE5B,MAAM,EAAE,GACN,CACE,OAAO,OAAO,KAAK,QAAQ;IAC3B,CAAC,CAAC,OAAO;IACT,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,CACpC,CAAC,CAAC;IACD,OAAO,CAAC,OAAO;IACjB,CAAC,CAAC,QAAQ,CAAA;AACZ,MAAM,GAAG,GAAG,EAAE;KACX,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;KACjB,KAAK,CAAC,GAAG,CAAC;KACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;AAE5B,qBAAqB;AACrB,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;AAClC,oBAAoB;AAEpB,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,IAAI,CAAA;AAC5B,qBAAqB;AACrB,IACE,CAAC,EAAE;IACH,KAAK,GAAG,EAAE;IACV,CAAC,KAAK,KAAK,EAAE,IAAI,KAAK,GAAG,EAAE,CAAC;IAC5B,CAAC,KAAK,KAAK,EAAE,IAAI,KAAK,GAAG,EAAE,CAAC,EAC5B,CAAC;IACD,oBAAoB;IACpB,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,SAAS,CAAA;AAC5C,CAAC;AAEY,QAAA,SAAS,GAAG,EAAE,CAAA","sourcesContent":["import * as util from 'util'\n\nconst pv =\n (\n typeof process === 'object' &&\n !!process &&\n typeof process.version === 'string'\n ) ?\n process.version\n : 'v0.0.0'\nconst pvs = pv\n .replace(/^v/, '')\n .split('.')\n .map(s => parseInt(s, 10))\n\n/* c8 ignore start */\nconst [major = 0, minor = 0] = pvs\n/* c8 ignore stop */\n\nlet { parseArgs: pa } = util\n/* c8 ignore start */\nif (\n !pa ||\n major < 16 ||\n (major === 18 && minor < 11) ||\n (major === 16 && minor < 19)\n) {\n /* c8 ignore stop */\n pa = require('@pkgjs/parseargs').parseArgs\n}\n\nexport const parseArgs = pa\n"]}
|
1
node_modules/jackspeak/dist/commonjs/parse-args-cjs.d.cts.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/commonjs/parse-args-cjs.d.cts.map
generated
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
{"version":3,"file":"parse-args-cjs.d.cts","sourceRoot":"","sources":["../../src/parse-args-cjs.cts"],"names":[],"mappings":";AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AA+B5B,eAAO,MAAM,SAAS,uBAAK,CAAA"}
|
4
node_modules/jackspeak/dist/commonjs/parse-args.d.ts
generated
vendored
Normal file
4
node_modules/jackspeak/dist/commonjs/parse-args.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
/// <reference types="node" />
|
||||
import * as util from 'util';
|
||||
export declare const parseArgs: typeof util.parseArgs;
|
||||
//# sourceMappingURL=parse-args-cjs.d.cts.map
|
50
node_modules/jackspeak/dist/commonjs/parse-args.js
generated
vendored
Normal file
50
node_modules/jackspeak/dist/commonjs/parse-args.js
generated
vendored
Normal file
|
@ -0,0 +1,50 @@
|
|||
"use strict";
|
||||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
||||
if (k2 === undefined) k2 = k;
|
||||
var desc = Object.getOwnPropertyDescriptor(m, k);
|
||||
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
||||
desc = { enumerable: true, get: function() { return m[k]; } };
|
||||
}
|
||||
Object.defineProperty(o, k2, desc);
|
||||
}) : (function(o, m, k, k2) {
|
||||
if (k2 === undefined) k2 = k;
|
||||
o[k2] = m[k];
|
||||
}));
|
||||
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
||||
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
||||
}) : function(o, v) {
|
||||
o["default"] = v;
|
||||
});
|
||||
var __importStar = (this && this.__importStar) || function (mod) {
|
||||
if (mod && mod.__esModule) return mod;
|
||||
var result = {};
|
||||
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
||||
__setModuleDefault(result, mod);
|
||||
return result;
|
||||
};
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.parseArgs = void 0;
|
||||
const util = __importStar(require("util"));
|
||||
const pv = (typeof process === 'object' &&
|
||||
!!process &&
|
||||
typeof process.version === 'string') ?
|
||||
process.version
|
||||
: 'v0.0.0';
|
||||
const pvs = pv
|
||||
.replace(/^v/, '')
|
||||
.split('.')
|
||||
.map(s => parseInt(s, 10));
|
||||
/* c8 ignore start */
|
||||
const [major = 0, minor = 0] = pvs;
|
||||
/* c8 ignore stop */
|
||||
let { parseArgs: pa } = util;
|
||||
/* c8 ignore start */
|
||||
if (!pa ||
|
||||
major < 16 ||
|
||||
(major === 18 && minor < 11) ||
|
||||
(major === 16 && minor < 19)) {
|
||||
/* c8 ignore stop */
|
||||
pa = require('@pkgjs/parseargs').parseArgs;
|
||||
}
|
||||
exports.parseArgs = pa;
|
||||
//# sourceMappingURL=parse-args-cjs.cjs.map
|
315
node_modules/jackspeak/dist/esm/index.d.ts
generated
vendored
Normal file
315
node_modules/jackspeak/dist/esm/index.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,315 @@
|
|||
/// <reference types="node" resolution-mode="require"/>
|
||||
export type ConfigType = 'number' | 'string' | 'boolean';
|
||||
/**
|
||||
* Given a Jack object, get the typeof its ConfigSet
|
||||
*/
|
||||
export type Unwrap<J> = J extends Jack<infer C> ? C : never;
|
||||
import { inspect, InspectOptions } from 'node:util';
|
||||
/**
|
||||
* Defines the type of value that is valid, given a config definition's
|
||||
* {@link ConfigType} and boolean multiple setting
|
||||
*/
|
||||
export type ValidValue<T extends ConfigType = ConfigType, M extends boolean = boolean> = [
|
||||
T,
|
||||
M
|
||||
] extends ['number', true] ? number[] : [T, M] extends ['string', true] ? string[] : [T, M] extends ['boolean', true] ? boolean[] : [T, M] extends ['number', false] ? number : [T, M] extends ['string', false] ? string : [T, M] extends ['boolean', false] ? boolean : [T, M] extends ['string', boolean] ? string | string[] : [T, M] extends ['boolean', boolean] ? boolean | boolean[] : [T, M] extends ['number', boolean] ? number | number[] : [T, M] extends [ConfigType, false] ? string | number | boolean : [T, M] extends [ConfigType, true] ? string[] | number[] | boolean[] : string | number | boolean | string[] | number[] | boolean[];
|
||||
/**
|
||||
* The meta information for a config option definition, when the
|
||||
* type and multiple values can be inferred by the method being used
|
||||
*/
|
||||
export type ConfigOptionMeta<T extends ConfigType, M extends boolean = boolean, O extends undefined | (T extends 'boolean' ? never : T extends 'string' ? readonly string[] : T extends 'number' ? readonly number[] : readonly number[] | readonly string[]) = undefined | (T extends 'boolean' ? never : T extends 'string' ? readonly string[] : T extends 'number' ? readonly number[] : readonly number[] | readonly string[])> = {
|
||||
default?: undefined | (ValidValue<T, M> & (O extends number[] | string[] ? M extends false ? O[number] : O[number][] : unknown));
|
||||
validOptions?: O;
|
||||
description?: string;
|
||||
validate?: ((v: unknown) => v is ValidValue<T, M>) | ((v: unknown) => boolean);
|
||||
short?: string | undefined;
|
||||
type?: T;
|
||||
hint?: T extends 'boolean' ? never : string;
|
||||
delim?: M extends true ? string : never;
|
||||
} & (M extends false ? {
|
||||
multiple?: false | undefined;
|
||||
} : M extends true ? {
|
||||
multiple: true;
|
||||
} : {
|
||||
multiple?: boolean;
|
||||
});
|
||||
/**
|
||||
* A set of {@link ConfigOptionMeta} fields, referenced by their longOption
|
||||
* string values.
|
||||
*/
|
||||
export type ConfigMetaSet<T extends ConfigType, M extends boolean = boolean> = {
|
||||
[longOption: string]: ConfigOptionMeta<T, M>;
|
||||
};
|
||||
/**
|
||||
* Infer {@link ConfigSet} fields from a given {@link ConfigMetaSet}
|
||||
*/
|
||||
export type ConfigSetFromMetaSet<T extends ConfigType, M extends boolean, S extends ConfigMetaSet<T, M>> = {
|
||||
[longOption in keyof S]: ConfigOptionBase<T, M>;
|
||||
};
|
||||
/**
|
||||
* Fields that can be set on a {@link ConfigOptionBase} or
|
||||
* {@link ConfigOptionMeta} based on whether or not the field is known to be
|
||||
* multiple.
|
||||
*/
|
||||
export type MultiType<M extends boolean> = M extends true ? {
|
||||
multiple: true;
|
||||
delim?: string | undefined;
|
||||
} : M extends false ? {
|
||||
multiple?: false | undefined;
|
||||
delim?: undefined;
|
||||
} : {
|
||||
multiple?: boolean | undefined;
|
||||
delim?: string | undefined;
|
||||
};
|
||||
/**
|
||||
* A config field definition, in its full representation.
|
||||
*/
|
||||
export type ConfigOptionBase<T extends ConfigType, M extends boolean = boolean> = {
|
||||
type: T;
|
||||
short?: string | undefined;
|
||||
default?: ValidValue<T, M> | undefined;
|
||||
description?: string;
|
||||
hint?: T extends 'boolean' ? undefined : string | undefined;
|
||||
validate?: (v: unknown) => v is ValidValue<T, M>;
|
||||
validOptions?: T extends 'boolean' ? undefined : T extends 'string' ? readonly string[] : T extends 'number' ? readonly number[] : readonly number[] | readonly string[];
|
||||
} & MultiType<M>;
|
||||
export declare const isConfigType: (t: string) => t is ConfigType;
|
||||
export declare const isConfigOption: <T extends ConfigType, M extends boolean>(o: any, type: T, multi: M) => o is ConfigOptionBase<T, M>;
|
||||
/**
|
||||
* A set of {@link ConfigOptionBase} objects, referenced by their longOption
|
||||
* string values.
|
||||
*/
|
||||
export type ConfigSet = {
|
||||
[longOption: string]: ConfigOptionBase<ConfigType>;
|
||||
};
|
||||
/**
|
||||
* The 'values' field returned by {@link Jack#parse}
|
||||
*/
|
||||
export type OptionsResults<T extends ConfigSet> = {
|
||||
[k in keyof T]?: T[k]['validOptions'] extends (readonly string[] | readonly number[]) ? T[k] extends ConfigOptionBase<'string' | 'number', false> ? T[k]['validOptions'][number] : T[k] extends ConfigOptionBase<'string' | 'number', true> ? T[k]['validOptions'][number][] : never : T[k] extends ConfigOptionBase<'string', false> ? string : T[k] extends ConfigOptionBase<'string', true> ? string[] : T[k] extends ConfigOptionBase<'number', false> ? number : T[k] extends ConfigOptionBase<'number', true> ? number[] : T[k] extends ConfigOptionBase<'boolean', false> ? boolean : T[k] extends ConfigOptionBase<'boolean', true> ? boolean[] : never;
|
||||
};
|
||||
/**
|
||||
* The object retured by {@link Jack#parse}
|
||||
*/
|
||||
export type Parsed<T extends ConfigSet> = {
|
||||
values: OptionsResults<T>;
|
||||
positionals: string[];
|
||||
};
|
||||
/**
|
||||
* A row used when generating the {@link Jack#usage} string
|
||||
*/
|
||||
export interface Row {
|
||||
left?: string;
|
||||
text: string;
|
||||
skipLine?: boolean;
|
||||
type?: string;
|
||||
}
|
||||
/**
|
||||
* A heading for a section in the usage, created by the jack.heading()
|
||||
* method.
|
||||
*
|
||||
* First heading is always level 1, subsequent headings default to 2.
|
||||
*
|
||||
* The level of the nearest heading level sets the indentation of the
|
||||
* description that follows.
|
||||
*/
|
||||
export interface Heading extends Row {
|
||||
type: 'heading';
|
||||
text: string;
|
||||
left?: '';
|
||||
skipLine?: boolean;
|
||||
level: number;
|
||||
pre?: boolean;
|
||||
}
|
||||
/**
|
||||
* An arbitrary blob of text describing some stuff, set by the
|
||||
* jack.description() method.
|
||||
*
|
||||
* Indentation determined by level of the nearest header.
|
||||
*/
|
||||
export interface Description extends Row {
|
||||
type: 'description';
|
||||
text: string;
|
||||
left?: '';
|
||||
skipLine?: boolean;
|
||||
pre?: boolean;
|
||||
}
|
||||
/**
|
||||
* A heading or description row used when generating the {@link Jack#usage}
|
||||
* string
|
||||
*/
|
||||
export type TextRow = Heading | Description;
|
||||
/**
|
||||
* Either a {@link TextRow} or a reference to a {@link ConfigOptionBase}
|
||||
*/
|
||||
export type UsageField = TextRow | {
|
||||
type: 'config';
|
||||
name: string;
|
||||
value: ConfigOptionBase<ConfigType>;
|
||||
};
|
||||
/**
|
||||
* Options provided to the {@link Jack} constructor
|
||||
*/
|
||||
export interface JackOptions {
|
||||
/**
|
||||
* Whether to allow positional arguments
|
||||
*
|
||||
* @default true
|
||||
*/
|
||||
allowPositionals?: boolean;
|
||||
/**
|
||||
* Prefix to use when reading/writing the environment variables
|
||||
*
|
||||
* If not specified, environment behavior will not be available.
|
||||
*/
|
||||
envPrefix?: string;
|
||||
/**
|
||||
* Environment object to read/write. Defaults `process.env`.
|
||||
* No effect if `envPrefix` is not set.
|
||||
*/
|
||||
env?: {
|
||||
[k: string]: string | undefined;
|
||||
};
|
||||
/**
|
||||
* A short usage string. If not provided, will be generated from the
|
||||
* options provided, but that can of course be rather verbose if
|
||||
* there are a lot of options.
|
||||
*/
|
||||
usage?: string;
|
||||
/**
|
||||
* Stop parsing flags and opts at the first positional argument.
|
||||
* This is to support cases like `cmd [flags] <subcmd> [options]`, where
|
||||
* each subcommand may have different options. This effectively treats
|
||||
* any positional as a `--` argument. Only relevant if `allowPositionals`
|
||||
* is true.
|
||||
*
|
||||
* To do subcommands, set this option, look at the first positional, and
|
||||
* parse the remaining positionals as appropriate.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
stopAtPositional?: boolean;
|
||||
/**
|
||||
* Conditional `stopAtPositional`. If set to a `(string)=>boolean` function,
|
||||
* will be called with each positional argument encountered. If the function
|
||||
* returns true, then parsing will stop at that point.
|
||||
*/
|
||||
stopAtPositionalTest?: (arg: string) => boolean;
|
||||
}
|
||||
/**
|
||||
* Class returned by the {@link jack} function and all configuration
|
||||
* definition methods. This is what gets chained together.
|
||||
*/
|
||||
export declare class Jack<C extends ConfigSet = {}> {
|
||||
#private;
|
||||
constructor(options?: JackOptions);
|
||||
/**
|
||||
* Set the default value (which will still be overridden by env or cli)
|
||||
* as if from a parsed config file. The optional `source` param, if
|
||||
* provided, will be included in error messages if a value is invalid or
|
||||
* unknown.
|
||||
*/
|
||||
setConfigValues(values: OptionsResults<C>, source?: string): this;
|
||||
/**
|
||||
* Parse a string of arguments, and return the resulting
|
||||
* `{ values, positionals }` object.
|
||||
*
|
||||
* If an {@link JackOptions#envPrefix} is set, then it will read default
|
||||
* values from the environment, and write the resulting values back
|
||||
* to the environment as well.
|
||||
*
|
||||
* Environment values always take precedence over any other value, except
|
||||
* an explicit CLI setting.
|
||||
*/
|
||||
parse(args?: string[]): Parsed<C>;
|
||||
loadEnvDefaults(): void;
|
||||
applyDefaults(p: Parsed<C>): void;
|
||||
/**
|
||||
* Only parse the command line arguments passed in.
|
||||
* Does not strip off the `node script.js` bits, so it must be just the
|
||||
* arguments you wish to have parsed.
|
||||
* Does not read from or write to the environment, or set defaults.
|
||||
*/
|
||||
parseRaw(args: string[]): Parsed<C>;
|
||||
/**
|
||||
* Validate that any arbitrary object is a valid configuration `values`
|
||||
* object. Useful when loading config files or other sources.
|
||||
*/
|
||||
validate(o: unknown): asserts o is Parsed<C>['values'];
|
||||
writeEnv(p: Parsed<C>): void;
|
||||
/**
|
||||
* Add a heading to the usage output banner
|
||||
*/
|
||||
heading(text: string, level?: 1 | 2 | 3 | 4 | 5 | 6, { pre }?: {
|
||||
pre?: boolean;
|
||||
}): Jack<C>;
|
||||
/**
|
||||
* Add a long-form description to the usage output at this position.
|
||||
*/
|
||||
description(text: string, { pre }?: {
|
||||
pre?: boolean;
|
||||
}): Jack<C>;
|
||||
/**
|
||||
* Add one or more number fields.
|
||||
*/
|
||||
num<F extends ConfigMetaSet<'number', false>>(fields: F): Jack<C & ConfigSetFromMetaSet<'number', false, F>>;
|
||||
/**
|
||||
* Add one or more multiple number fields.
|
||||
*/
|
||||
numList<F extends ConfigMetaSet<'number'>>(fields: F): Jack<C & ConfigSetFromMetaSet<'number', true, F>>;
|
||||
/**
|
||||
* Add one or more string option fields.
|
||||
*/
|
||||
opt<F extends ConfigMetaSet<'string', false>>(fields: F): Jack<C & ConfigSetFromMetaSet<'string', false, F>>;
|
||||
/**
|
||||
* Add one or more multiple string option fields.
|
||||
*/
|
||||
optList<F extends ConfigMetaSet<'string'>>(fields: F): Jack<C & ConfigSetFromMetaSet<'string', true, F>>;
|
||||
/**
|
||||
* Add one or more flag fields.
|
||||
*/
|
||||
flag<F extends ConfigMetaSet<'boolean', false>>(fields: F): Jack<C & ConfigSetFromMetaSet<'boolean', false, F>>;
|
||||
/**
|
||||
* Add one or more multiple flag fields.
|
||||
*/
|
||||
flagList<F extends ConfigMetaSet<'boolean'>>(fields: F): Jack<C & ConfigSetFromMetaSet<'boolean', true, F>>;
|
||||
/**
|
||||
* Generic field definition method. Similar to flag/flagList/number/etc,
|
||||
* but you must specify the `type` (and optionally `multiple` and `delim`)
|
||||
* fields on each one, or Jack won't know how to define them.
|
||||
*/
|
||||
addFields<F extends ConfigSet>(fields: F): Jack<C & F>;
|
||||
/**
|
||||
* Return the usage banner for the given configuration
|
||||
*/
|
||||
usage(): string;
|
||||
/**
|
||||
* Return the usage banner markdown for the given configuration
|
||||
*/
|
||||
usageMarkdown(): string;
|
||||
/**
|
||||
* Return the configuration options as a plain object
|
||||
*/
|
||||
toJSON(): {
|
||||
[k: string]: {
|
||||
hint?: string | undefined;
|
||||
default?: string | number | boolean | string[] | number[] | boolean[] | undefined;
|
||||
validOptions?: readonly number[] | readonly string[] | undefined;
|
||||
validate?: ((v: unknown) => v is string | number | boolean | string[] | number[] | boolean[]) | undefined;
|
||||
description?: string | undefined;
|
||||
short?: string | undefined;
|
||||
delim?: string | undefined;
|
||||
multiple?: boolean | undefined;
|
||||
type: ConfigType;
|
||||
};
|
||||
};
|
||||
/**
|
||||
* Custom printer for `util.inspect`
|
||||
*/
|
||||
[inspect.custom](_: number, options: InspectOptions): string;
|
||||
}
|
||||
/**
|
||||
* Main entry point. Create and return a {@link Jack} object.
|
||||
*/
|
||||
export declare const jack: (options?: JackOptions) => Jack<{}>;
|
||||
//# sourceMappingURL=index.d.ts.map
|
1
node_modules/jackspeak/dist/esm/index.d.ts.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/esm/index.d.ts.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
1000
node_modules/jackspeak/dist/esm/index.js
generated
vendored
Normal file
1000
node_modules/jackspeak/dist/esm/index.js
generated
vendored
Normal file
File diff suppressed because it is too large
Load diff
1
node_modules/jackspeak/dist/esm/index.js.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/esm/index.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
3
node_modules/jackspeak/dist/esm/package.json
generated
vendored
Normal file
3
node_modules/jackspeak/dist/esm/package.json
generated
vendored
Normal file
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"type": "module"
|
||||
}
|
4
node_modules/jackspeak/dist/esm/parse-args.d.ts
generated
vendored
Normal file
4
node_modules/jackspeak/dist/esm/parse-args.d.ts
generated
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
/// <reference types="node" resolution-mode="require"/>
|
||||
import * as util from 'util';
|
||||
export declare const parseArgs: typeof util.parseArgs;
|
||||
//# sourceMappingURL=parse-args.d.ts.map
|
1
node_modules/jackspeak/dist/esm/parse-args.d.ts.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/esm/parse-args.d.ts.map
generated
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
{"version":3,"file":"parse-args.d.ts","sourceRoot":"","sources":["../../src/parse-args.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAoC5B,eAAO,MAAM,SAAS,uBAA6C,CAAA"}
|
26
node_modules/jackspeak/dist/esm/parse-args.js
generated
vendored
Normal file
26
node_modules/jackspeak/dist/esm/parse-args.js
generated
vendored
Normal file
|
@ -0,0 +1,26 @@
|
|||
import * as util from 'util';
|
||||
const pv = (typeof process === 'object' &&
|
||||
!!process &&
|
||||
typeof process.version === 'string') ?
|
||||
process.version
|
||||
: 'v0.0.0';
|
||||
const pvs = pv
|
||||
.replace(/^v/, '')
|
||||
.split('.')
|
||||
.map(s => parseInt(s, 10));
|
||||
/* c8 ignore start */
|
||||
const [major = 0, minor = 0] = pvs;
|
||||
/* c8 ignore stop */
|
||||
let { parseArgs: pa, } = util;
|
||||
/* c8 ignore start - version specific */
|
||||
if (!pa ||
|
||||
major < 16 ||
|
||||
(major === 18 && minor < 11) ||
|
||||
(major === 16 && minor < 19)) {
|
||||
// Ignore because we will clobber it for commonjs
|
||||
//@ts-ignore
|
||||
pa = (await import('@pkgjs/parseargs')).parseArgs;
|
||||
}
|
||||
/* c8 ignore stop */
|
||||
export const parseArgs = pa;
|
||||
//# sourceMappingURL=parse-args.js.map
|
1
node_modules/jackspeak/dist/esm/parse-args.js.map
generated
vendored
Normal file
1
node_modules/jackspeak/dist/esm/parse-args.js.map
generated
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
{"version":3,"file":"parse-args.js","sourceRoot":"","sources":["../../src/parse-args.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAE5B,MAAM,EAAE,GACN,CACE,OAAO,OAAO,KAAK,QAAQ;IAC3B,CAAC,CAAC,OAAO;IACT,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,CACpC,CAAC,CAAC;IACD,OAAO,CAAC,OAAO;IACjB,CAAC,CAAC,QAAQ,CAAA;AACZ,MAAM,GAAG,GAAG,EAAE;KACX,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;KACjB,KAAK,CAAC,GAAG,CAAC;KACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;AAE5B,qBAAqB;AACrB,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;AAClC,oBAAoB;AAEpB,IAAI,EACF,SAAS,EAAE,EAAE,GACd,GAA8D,IAAI,CAAA;AAEnE,wCAAwC;AACxC,IACE,CAAC,EAAE;IACH,KAAK,GAAG,EAAE;IACV,CAAC,KAAK,KAAK,EAAE,IAAI,KAAK,GAAG,EAAE,CAAC;IAC5B,CAAC,KAAK,KAAK,EAAE,IAAI,KAAK,GAAG,EAAE,CAAC,EAC5B,CAAC;IACD,iDAAiD;IACjD,YAAY;IACZ,EAAE,GAAG,CAAC,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAA;AACnD,CAAC;AACD,oBAAoB;AAEpB,MAAM,CAAC,MAAM,SAAS,GAAG,EAA0C,CAAA","sourcesContent":["import * as util from 'util'\n\nconst pv =\n (\n typeof process === 'object' &&\n !!process &&\n typeof process.version === 'string'\n ) ?\n process.version\n : 'v0.0.0'\nconst pvs = pv\n .replace(/^v/, '')\n .split('.')\n .map(s => parseInt(s, 10))\n\n/* c8 ignore start */\nconst [major = 0, minor = 0] = pvs\n/* c8 ignore stop */\n\nlet {\n parseArgs: pa,\n}: typeof import('util') | typeof import('@pkgjs/parseargs') = util\n\n/* c8 ignore start - version specific */\nif (\n !pa ||\n major < 16 ||\n (major === 18 && minor < 11) ||\n (major === 16 && minor < 19)\n) {\n // Ignore because we will clobber it for commonjs\n //@ts-ignore\n pa = (await import('@pkgjs/parseargs')).parseArgs\n}\n/* c8 ignore stop */\n\nexport const parseArgs = pa as (typeof import('util'))['parseArgs']\n"]}
|
95
node_modules/jackspeak/package.json
generated
vendored
Normal file
95
node_modules/jackspeak/package.json
generated
vendored
Normal file
|
@ -0,0 +1,95 @@
|
|||
{
|
||||
"name": "jackspeak",
|
||||
"publishConfig": {
|
||||
"tag": "v3-legacy"
|
||||
},
|
||||
"version": "3.4.3",
|
||||
"description": "A very strict and proper argument parser.",
|
||||
"tshy": {
|
||||
"main": true,
|
||||
"exports": {
|
||||
"./package.json": "./package.json",
|
||||
".": "./src/index.js"
|
||||
}
|
||||
},
|
||||
"main": "./dist/commonjs/index.js",
|
||||
"types": "./dist/commonjs/index.d.ts",
|
||||
"type": "module",
|
||||
"exports": {
|
||||
"./package.json": "./package.json",
|
||||
".": {
|
||||
"import": {
|
||||
"types": "./dist/esm/index.d.ts",
|
||||
"default": "./dist/esm/index.js"
|
||||
},
|
||||
"require": {
|
||||
"types": "./dist/commonjs/index.d.ts",
|
||||
"default": "./dist/commonjs/index.js"
|
||||
}
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build-examples": "for i in examples/*.js ; do node $i -h > ${i/.js/.txt}; done",
|
||||
"preversion": "npm test",
|
||||
"postversion": "npm publish",
|
||||
"prepublishOnly": "git push origin --follow-tags",
|
||||
"prepare": "tshy",
|
||||
"pretest": "npm run prepare",
|
||||
"presnap": "npm run prepare",
|
||||
"test": "tap",
|
||||
"snap": "tap",
|
||||
"format": "prettier --write . --log-level warn",
|
||||
"typedoc": "typedoc --tsconfig .tshy/esm.json ./src/*.ts"
|
||||
},
|
||||
"license": "BlueOak-1.0.0",
|
||||
"prettier": {
|
||||
"experimentalTernaries": true,
|
||||
"semi": false,
|
||||
"printWidth": 75,
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"singleQuote": true,
|
||||
"jsxSingleQuote": false,
|
||||
"bracketSameLine": true,
|
||||
"arrowParens": "avoid",
|
||||
"endOfLine": "lf"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.7.0",
|
||||
"@types/pkgjs__parseargs": "^0.10.1",
|
||||
"prettier": "^3.2.5",
|
||||
"tap": "^18.8.0",
|
||||
"tshy": "^1.14.0",
|
||||
"typedoc": "^0.25.1",
|
||||
"typescript": "^5.2.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@isaacs/cliui": "^8.0.2"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/isaacs"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/isaacs/jackspeak.git"
|
||||
},
|
||||
"keywords": [
|
||||
"argument",
|
||||
"parser",
|
||||
"args",
|
||||
"option",
|
||||
"flag",
|
||||
"cli",
|
||||
"command",
|
||||
"line",
|
||||
"parse",
|
||||
"parsing"
|
||||
],
|
||||
"author": "Isaac Z. Schlueter <i@izs.me>",
|
||||
"optionalDependencies": {
|
||||
"@pkgjs/parseargs": "^0.11.0"
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue