mirror of
https://scm.univ-tours.fr/22107988t/rappaurio-sae501_502.git
synced 2025-08-30 00:05:58 +02:00
permet l'ajout des frameworks et des routes
This commit is contained in:
55
app/node_modules/jackspeak/LICENSE.md
generated
vendored
Normal file
55
app/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.***
|
348
app/node_modules/jackspeak/README.md
generated
vendored
Normal file
348
app/node_modules/jackspeak/README.md
generated
vendored
Normal file
@@ -0,0 +1,348 @@
|
||||
# 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.
|
||||
|
||||
### `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.
|
||||
- `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.
|
292
app/node_modules/jackspeak/dist/cjs/index.d.ts
generated
vendored
Normal file
292
app/node_modules/jackspeak/dist/cjs/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,292 @@
|
||||
/// <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, M extends 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> = {
|
||||
default?: ValidValue<T, M> | undefined;
|
||||
description?: string;
|
||||
validate?: ((v: any) => v is ValidValue<T, M>) | ((v: any) => boolean);
|
||||
short?: string | undefined;
|
||||
type?: T;
|
||||
} & (T extends 'boolean' ? {} : {
|
||||
hint?: string | undefined;
|
||||
}) & (M extends false ? {} : {
|
||||
multiple?: M | undefined;
|
||||
delim?: string | undefined;
|
||||
});
|
||||
/**
|
||||
* A set of {@link ConfigOptionMeta} fields, referenced by their longOption
|
||||
* string values.
|
||||
*/
|
||||
export type ConfigMetaSet<T extends ConfigType, M extends 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> = {
|
||||
type: T;
|
||||
short?: string | undefined;
|
||||
default?: ValidValue<T, M> | undefined;
|
||||
description?: string;
|
||||
hint?: T extends 'boolean' ? undefined : string | undefined;
|
||||
validate?: (v: any) => v is ValidValue<T, M>;
|
||||
} & 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, boolean>;
|
||||
};
|
||||
/**
|
||||
* The 'values' field returned by {@link Jack#parse}
|
||||
*/
|
||||
export type OptionsResults<T extends ConfigSet> = {
|
||||
[k in keyof T]?: 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, boolean>;
|
||||
};
|
||||
/**
|
||||
* 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;
|
||||
}
|
||||
/**
|
||||
* 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>;
|
||||
/**
|
||||
* Validate that any arbitrary object is a valid configuration `values`
|
||||
* object. Useful when loading config files or other sources.
|
||||
*/
|
||||
validate(o: any): asserts o is Parsed<C>['values'];
|
||||
/**
|
||||
* 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', true>>(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', true>>(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', true>>(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]: {
|
||||
default?: string | number | boolean | number[] | string[] | boolean[] | undefined;
|
||||
validate?: ((v: any) => v is string | number | boolean | number[] | string[] | 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
app/node_modules/jackspeak/dist/cjs/index.d.ts.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/cjs/index.d.ts.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
835
app/node_modules/jackspeak/dist/cjs/index.js
generated
vendored
Normal file
835
app/node_modules/jackspeak/dist/cjs/index.js
generated
vendored
Normal file
@@ -0,0 +1,835 @@
|
||||
"use strict";
|
||||
var __importDefault = (this && this.__importDefault) || function (mod) {
|
||||
return (mod && mod.__esModule) ? mod : { "default": mod };
|
||||
};
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.jack = exports.Jack = exports.isConfigOption = exports.isConfigType = void 0;
|
||||
const node_util_1 = require("node:util");
|
||||
const parse_args_js_1 = require("./parse-args.js");
|
||||
// it's a tiny API, just cast it inline, it's fine
|
||||
//@ts-ignore
|
||||
const cliui_1 = __importDefault(require("@isaacs/cliui"));
|
||||
const node_path_1 = require("node:path");
|
||||
const width = Math.min((process && process.stdout && process.stdout.columns) || 80, 80);
|
||||
// indentation spaces from heading level
|
||||
const indent = (n) => (n - 1) * 2;
|
||||
const toEnvKey = (pref, key) => {
|
||||
return [pref, key.replace(/[^a-zA-Z0-9]+/g, ' ')]
|
||||
.join(' ')
|
||||
.trim()
|
||||
.toUpperCase()
|
||||
.replace(/ /g, '_');
|
||||
};
|
||||
const toEnvVal = (value, delim = '\n') => {
|
||||
const str = typeof value === 'string'
|
||||
? value
|
||||
: typeof value === 'boolean'
|
||||
? value
|
||||
? '1'
|
||||
: '0'
|
||||
: typeof value === 'number'
|
||||
? String(value)
|
||||
: Array.isArray(value)
|
||||
? value
|
||||
.map((v) => toEnvVal(v))
|
||||
.join(delim)
|
||||
: /* c8 ignore start */
|
||||
undefined;
|
||||
if (typeof str !== 'string') {
|
||||
throw new Error(`could not serialize value to environment: ${JSON.stringify(value)}`);
|
||||
}
|
||||
/* c8 ignore stop */
|
||||
return str;
|
||||
};
|
||||
const fromEnvVal = (env, type, multiple, delim = '\n') => (multiple
|
||||
? env
|
||||
? env.split(delim).map(v => fromEnvVal(v, type, false))
|
||||
: []
|
||||
: type === 'string'
|
||||
? env
|
||||
: type === 'boolean'
|
||||
? env === '1'
|
||||
: +env.trim());
|
||||
const isConfigType = (t) => typeof t === 'string' &&
|
||||
(t === 'string' || t === 'number' || t === 'boolean');
|
||||
exports.isConfigType = isConfigType;
|
||||
const undefOrType = (v, t) => v === undefined || typeof v === t;
|
||||
// print the value type, for error message reporting
|
||||
const valueType = (v) => typeof v === 'string'
|
||||
? 'string'
|
||||
: typeof v === 'boolean'
|
||||
? 'boolean'
|
||||
: typeof v === 'number'
|
||||
? 'number'
|
||||
: Array.isArray(v)
|
||||
? joinTypes([...new Set(v.map(v => valueType(v)))]) + '[]'
|
||||
: `${v.type}${v.multiple ? '[]' : ''}`;
|
||||
const joinTypes = (types) => types.length === 1 ? types[0] : `(${types.join('|')})`;
|
||||
const isValidValue = (v, type, multi) => {
|
||||
if (multi) {
|
||||
if (!Array.isArray(v))
|
||||
return false;
|
||||
return !v.some((v) => !isValidValue(v, type, false));
|
||||
}
|
||||
if (Array.isArray(v))
|
||||
return false;
|
||||
return typeof v === type;
|
||||
};
|
||||
const isConfigOption = (o, type, multi) => !!o &&
|
||||
typeof o === 'object' &&
|
||||
(0, exports.isConfigType)(o.type) &&
|
||||
o.type === type &&
|
||||
undefOrType(o.short, 'string') &&
|
||||
undefOrType(o.description, 'string') &&
|
||||
undefOrType(o.hint, 'string') &&
|
||||
undefOrType(o.validate, 'function') &&
|
||||
(o.default === undefined || isValidValue(o.default, type, multi)) &&
|
||||
!!o.multiple === multi;
|
||||
exports.isConfigOption = isConfigOption;
|
||||
function num(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'number', false)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'number',
|
||||
multiple: false,
|
||||
};
|
||||
}
|
||||
function numList(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'number', true)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'number',
|
||||
multiple: true,
|
||||
};
|
||||
}
|
||||
function opt(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'string', false)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'string',
|
||||
multiple: false,
|
||||
};
|
||||
}
|
||||
function optList(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'string', true)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'string',
|
||||
multiple: true,
|
||||
};
|
||||
}
|
||||
function flag(o = {}) {
|
||||
const { hint, default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'boolean', false)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
if (hint !== undefined) {
|
||||
throw new TypeError('cannot provide hint for flag');
|
||||
}
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'boolean',
|
||||
multiple: false,
|
||||
};
|
||||
}
|
||||
function flagList(o = {}) {
|
||||
const { hint, default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'boolean', true)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
if (hint !== undefined) {
|
||||
throw new TypeError('cannot provide hint for flag list');
|
||||
}
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'boolean',
|
||||
multiple: true,
|
||||
};
|
||||
}
|
||||
const toParseArgsOptionsConfig = (options) => {
|
||||
const c = {};
|
||||
for (const longOption in options) {
|
||||
const config = options[longOption];
|
||||
if ((0, exports.isConfigOption)(config, 'number', true)) {
|
||||
c[longOption] = {
|
||||
type: 'string',
|
||||
multiple: true,
|
||||
default: config.default?.map(c => String(c)),
|
||||
};
|
||||
}
|
||||
else if ((0, exports.isConfigOption)(config, 'number', false)) {
|
||||
c[longOption] = {
|
||||
type: 'string',
|
||||
multiple: false,
|
||||
default: config.default === undefined
|
||||
? undefined
|
||||
: String(config.default),
|
||||
};
|
||||
}
|
||||
else {
|
||||
const conf = config;
|
||||
c[longOption] = {
|
||||
type: conf.type,
|
||||
multiple: conf.multiple,
|
||||
default: conf.default,
|
||||
};
|
||||
}
|
||||
if (typeof config.short === 'string') {
|
||||
c[longOption].short = config.short;
|
||||
}
|
||||
if (config.type === 'boolean' &&
|
||||
!longOption.startsWith('no-') &&
|
||||
!options[`no-${longOption}`]) {
|
||||
c[`no-${longOption}`] = {
|
||||
type: 'boolean',
|
||||
multiple: config.multiple,
|
||||
};
|
||||
}
|
||||
}
|
||||
return c;
|
||||
};
|
||||
const isHeading = (r) => r.type === 'heading';
|
||||
const isDescription = (r) => r.type === 'description';
|
||||
/**
|
||||
* Class returned by the {@link jack} function and all configuration
|
||||
* definition methods. This is what gets chained together.
|
||||
*/
|
||||
class Jack {
|
||||
#configSet;
|
||||
#shorts;
|
||||
#options;
|
||||
#fields = [];
|
||||
#env;
|
||||
#envPrefix;
|
||||
#allowPositionals;
|
||||
#usage;
|
||||
#usageMarkdown;
|
||||
constructor(options = {}) {
|
||||
this.#options = options;
|
||||
this.#allowPositionals = options.allowPositionals !== false;
|
||||
this.#env =
|
||||
this.#options.env === undefined ? process.env : this.#options.env;
|
||||
this.#envPrefix = options.envPrefix;
|
||||
// We need to fib a little, because it's always the same object, but it
|
||||
// starts out as having an empty config set. Then each method that adds
|
||||
// fields returns `this as Jack<C & { ...newConfigs }>`
|
||||
this.#configSet = Object.create(null);
|
||||
this.#shorts = Object.create(null);
|
||||
}
|
||||
/**
|
||||
* 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, source = '') {
|
||||
try {
|
||||
this.validate(values);
|
||||
}
|
||||
catch (er) {
|
||||
throw Object.assign(er, source ? { source } : {});
|
||||
}
|
||||
for (const [field, value] of Object.entries(values)) {
|
||||
const my = this.#configSet[field];
|
||||
my.default = value;
|
||||
}
|
||||
return 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 = process.argv) {
|
||||
if (args === process.argv) {
|
||||
args = args.slice(process._eval !== undefined ? 1 : 2);
|
||||
}
|
||||
if (this.#envPrefix) {
|
||||
for (const [field, my] of Object.entries(this.#configSet)) {
|
||||
const ek = toEnvKey(this.#envPrefix, field);
|
||||
const env = this.#env[ek];
|
||||
if (env !== undefined) {
|
||||
my.default = fromEnvVal(env, my.type, !!my.multiple, my.delim);
|
||||
}
|
||||
}
|
||||
}
|
||||
const options = toParseArgsOptionsConfig(this.#configSet);
|
||||
const result = (0, parse_args_js_1.parseArgs)({
|
||||
args,
|
||||
options,
|
||||
// always strict, but using our own logic
|
||||
strict: false,
|
||||
allowPositionals: this.#allowPositionals,
|
||||
tokens: true,
|
||||
});
|
||||
const p = {
|
||||
values: {},
|
||||
positionals: [],
|
||||
};
|
||||
for (const token of result.tokens) {
|
||||
if (token.kind === 'positional') {
|
||||
p.positionals.push(token.value);
|
||||
if (this.#options.stopAtPositional) {
|
||||
p.positionals.push(...args.slice(token.index + 1));
|
||||
return p;
|
||||
}
|
||||
}
|
||||
else if (token.kind === 'option') {
|
||||
let value = undefined;
|
||||
if (token.name.startsWith('no-')) {
|
||||
const my = this.#configSet[token.name];
|
||||
const pname = token.name.substring('no-'.length);
|
||||
const pos = this.#configSet[pname];
|
||||
if (pos &&
|
||||
pos.type === 'boolean' &&
|
||||
(!my ||
|
||||
(my.type === 'boolean' && !!my.multiple === !!pos.multiple))) {
|
||||
value = false;
|
||||
token.name = pname;
|
||||
}
|
||||
}
|
||||
const my = this.#configSet[token.name];
|
||||
if (!my) {
|
||||
throw new Error(`Unknown option '${token.rawName}'. ` +
|
||||
`To specify a positional argument starting with a '-', ` +
|
||||
`place it at the end of the command after '--', as in ` +
|
||||
`'-- ${token.rawName}'`);
|
||||
}
|
||||
if (value === undefined) {
|
||||
if (token.value === undefined) {
|
||||
if (my.type !== 'boolean') {
|
||||
throw new Error(`No value provided for ${token.rawName}, expected ${my.type}`);
|
||||
}
|
||||
value = true;
|
||||
}
|
||||
else {
|
||||
if (my.type === 'boolean') {
|
||||
throw new Error(`Flag ${token.rawName} does not take a value, received '${token.value}'`);
|
||||
}
|
||||
if (my.type === 'string') {
|
||||
value = token.value;
|
||||
}
|
||||
else {
|
||||
value = +token.value;
|
||||
if (value !== value) {
|
||||
throw new Error(`Invalid value '${token.value}' provided for ` +
|
||||
`'${token.rawName}' option, expected number`);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (my.multiple) {
|
||||
const pv = p.values;
|
||||
pv[token.name] = pv[token.name] ?? [];
|
||||
pv[token.name].push(value);
|
||||
}
|
||||
else {
|
||||
const pv = p.values;
|
||||
pv[token.name] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
for (const [field, c] of Object.entries(this.#configSet)) {
|
||||
if (c.default !== undefined && !(field in p.values)) {
|
||||
//@ts-ignore
|
||||
p.values[field] = c.default;
|
||||
}
|
||||
}
|
||||
for (const [field, value] of Object.entries(p.values)) {
|
||||
const valid = this.#configSet[field].validate;
|
||||
if (valid && !valid(value)) {
|
||||
throw new Error(`Invalid value provided for --${field}: ${JSON.stringify(value)}`);
|
||||
}
|
||||
}
|
||||
this.#writeEnv(p);
|
||||
return p;
|
||||
}
|
||||
/**
|
||||
* do not set fields as 'no-foo' if 'foo' exists and both are bools
|
||||
* just set foo.
|
||||
*/
|
||||
#noNoFields(f, val, s = f) {
|
||||
if (!f.startsWith('no-') || typeof val !== 'boolean')
|
||||
return;
|
||||
const yes = f.substring('no-'.length);
|
||||
// recurse so we get the core config key we care about.
|
||||
this.#noNoFields(yes, val, s);
|
||||
if (this.#configSet[yes]?.type === 'boolean') {
|
||||
throw new Error(`do not set '${s}', instead set '${yes}' as desired.`);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Validate that any arbitrary object is a valid configuration `values`
|
||||
* object. Useful when loading config files or other sources.
|
||||
*/
|
||||
validate(o) {
|
||||
if (!o || typeof o !== 'object') {
|
||||
throw new Error('Invalid config: not an object');
|
||||
}
|
||||
for (const field in o) {
|
||||
this.#noNoFields(field, o[field]);
|
||||
const config = this.#configSet[field];
|
||||
if (!config) {
|
||||
throw new Error(`Unknown config option: ${field}`);
|
||||
}
|
||||
if (!isValidValue(o[field], config.type, !!config.multiple)) {
|
||||
throw Object.assign(new Error(`Invalid value ${valueType(o[field])} for ${field}, expected ${valueType(config)}`), {
|
||||
field,
|
||||
value: o[field],
|
||||
});
|
||||
}
|
||||
if (config.validate && !config.validate(o[field])) {
|
||||
throw new Error(`Invalid config value for ${field}: ${o[field]}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
#writeEnv(p) {
|
||||
if (!this.#env || !this.#envPrefix)
|
||||
return;
|
||||
for (const [field, value] of Object.entries(p.values)) {
|
||||
const my = this.#configSet[field];
|
||||
this.#env[toEnvKey(this.#envPrefix, field)] = toEnvVal(value, my.delim);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Add a heading to the usage output banner
|
||||
*/
|
||||
heading(text, level, { pre = false } = {}) {
|
||||
if (level === undefined) {
|
||||
level = this.#fields.some(r => isHeading(r)) ? 2 : 1;
|
||||
}
|
||||
this.#fields.push({ type: 'heading', text, level, pre });
|
||||
return this;
|
||||
}
|
||||
/**
|
||||
* Add a long-form description to the usage output at this position.
|
||||
*/
|
||||
description(text, { pre } = {}) {
|
||||
this.#fields.push({ type: 'description', text, pre });
|
||||
return this;
|
||||
}
|
||||
/**
|
||||
* Add one or more number fields.
|
||||
*/
|
||||
num(fields) {
|
||||
return this.#addFields(fields, num);
|
||||
}
|
||||
/**
|
||||
* Add one or more multiple number fields.
|
||||
*/
|
||||
numList(fields) {
|
||||
return this.#addFields(fields, numList);
|
||||
}
|
||||
/**
|
||||
* Add one or more string option fields.
|
||||
*/
|
||||
opt(fields) {
|
||||
return this.#addFields(fields, opt);
|
||||
}
|
||||
/**
|
||||
* Add one or more multiple string option fields.
|
||||
*/
|
||||
optList(fields) {
|
||||
return this.#addFields(fields, optList);
|
||||
}
|
||||
/**
|
||||
* Add one or more flag fields.
|
||||
*/
|
||||
flag(fields) {
|
||||
return this.#addFields(fields, flag);
|
||||
}
|
||||
/**
|
||||
* Add one or more multiple flag fields.
|
||||
*/
|
||||
flagList(fields) {
|
||||
return this.#addFields(fields, flagList);
|
||||
}
|
||||
/**
|
||||
* 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(fields) {
|
||||
const next = this;
|
||||
for (const [name, field] of Object.entries(fields)) {
|
||||
this.#validateName(name, field);
|
||||
next.#fields.push({
|
||||
type: 'config',
|
||||
name,
|
||||
value: field,
|
||||
});
|
||||
}
|
||||
Object.assign(next.#configSet, fields);
|
||||
return next;
|
||||
}
|
||||
#addFields(fields, fn) {
|
||||
const next = this;
|
||||
Object.assign(next.#configSet, Object.fromEntries(Object.entries(fields).map(([name, field]) => {
|
||||
this.#validateName(name, field);
|
||||
const option = fn(field);
|
||||
next.#fields.push({
|
||||
type: 'config',
|
||||
name,
|
||||
value: option,
|
||||
});
|
||||
return [name, option];
|
||||
})));
|
||||
return next;
|
||||
}
|
||||
#validateName(name, field) {
|
||||
if (!/^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?$/.test(name)) {
|
||||
throw new TypeError(`Invalid option name: ${name}, ` +
|
||||
`must be '-' delimited ASCII alphanumeric`);
|
||||
}
|
||||
if (this.#configSet[name]) {
|
||||
throw new TypeError(`Cannot redefine option ${field}`);
|
||||
}
|
||||
if (this.#shorts[name]) {
|
||||
throw new TypeError(`Cannot redefine option ${name}, already ` +
|
||||
`in use for ${this.#shorts[name]}`);
|
||||
}
|
||||
if (field.short) {
|
||||
if (!/^[a-zA-Z0-9]$/.test(field.short)) {
|
||||
throw new TypeError(`Invalid ${name} short option: ${field.short}, ` +
|
||||
'must be 1 ASCII alphanumeric character');
|
||||
}
|
||||
if (this.#shorts[field.short]) {
|
||||
throw new TypeError(`Invalid ${name} short option: ${field.short}, ` +
|
||||
`already in use for ${this.#shorts[field.short]}`);
|
||||
}
|
||||
this.#shorts[field.short] = name;
|
||||
this.#shorts[name] = name;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Return the usage banner for the given configuration
|
||||
*/
|
||||
usage() {
|
||||
if (this.#usage)
|
||||
return this.#usage;
|
||||
let headingLevel = 1;
|
||||
const ui = (0, cliui_1.default)({ width });
|
||||
const first = this.#fields[0];
|
||||
let start = first?.type === 'heading' ? 1 : 0;
|
||||
if (first?.type === 'heading') {
|
||||
ui.div({
|
||||
padding: [0, 0, 0, 0],
|
||||
text: normalize(first.text),
|
||||
});
|
||||
}
|
||||
ui.div({ padding: [0, 0, 0, 0], text: 'Usage:' });
|
||||
if (this.#options.usage) {
|
||||
ui.div({
|
||||
text: this.#options.usage,
|
||||
padding: [0, 0, 0, 2],
|
||||
});
|
||||
}
|
||||
else {
|
||||
const cmd = (0, node_path_1.basename)(process.argv[1]);
|
||||
const shortFlags = [];
|
||||
const shorts = [];
|
||||
const flags = [];
|
||||
const opts = [];
|
||||
for (const [field, config] of Object.entries(this.#configSet)) {
|
||||
if (config.short) {
|
||||
if (config.type === 'boolean')
|
||||
shortFlags.push(config.short);
|
||||
else
|
||||
shorts.push([config.short, config.hint || field]);
|
||||
}
|
||||
else {
|
||||
if (config.type === 'boolean')
|
||||
flags.push(field);
|
||||
else
|
||||
opts.push([field, config.hint || field]);
|
||||
}
|
||||
}
|
||||
const sf = shortFlags.length ? ' -' + shortFlags.join('') : '';
|
||||
const so = shorts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const lf = flags.map(k => ` --${k}`).join('');
|
||||
const lo = opts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const usage = `${cmd}${sf}${so}${lf}${lo}`.trim();
|
||||
ui.div({
|
||||
text: usage,
|
||||
padding: [0, 0, 0, 2],
|
||||
});
|
||||
}
|
||||
ui.div({ padding: [0, 0, 0, 0], text: '' });
|
||||
const maybeDesc = this.#fields[start];
|
||||
if (isDescription(maybeDesc)) {
|
||||
const print = normalize(maybeDesc.text, maybeDesc.pre);
|
||||
start++;
|
||||
ui.div({ padding: [0, 0, 0, 0], text: print });
|
||||
ui.div({ padding: [0, 0, 0, 0], text: '' });
|
||||
}
|
||||
const { rows, maxWidth } = this.#usageRows(start);
|
||||
// every heading/description after the first gets indented by 2
|
||||
// extra spaces.
|
||||
for (const row of rows) {
|
||||
if (row.left) {
|
||||
// If the row is too long, don't wrap it
|
||||
// Bump the right-hand side down a line to make room
|
||||
const configIndent = indent(Math.max(headingLevel, 2));
|
||||
if (row.left.length > maxWidth - 3) {
|
||||
ui.div({ text: row.left, padding: [0, 0, 0, configIndent] });
|
||||
ui.div({ text: row.text, padding: [0, 0, 0, maxWidth] });
|
||||
}
|
||||
else {
|
||||
ui.div({
|
||||
text: row.left,
|
||||
padding: [0, 1, 0, configIndent],
|
||||
width: maxWidth,
|
||||
}, { padding: [0, 0, 0, 0], text: row.text });
|
||||
}
|
||||
if (row.skipLine) {
|
||||
ui.div({ padding: [0, 0, 0, 0], text: '' });
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (isHeading(row)) {
|
||||
const { level } = row;
|
||||
headingLevel = level;
|
||||
// only h1 and h2 have bottom padding
|
||||
// h3-h6 do not
|
||||
const b = level <= 2 ? 1 : 0;
|
||||
ui.div({ ...row, padding: [0, 0, b, indent(level)] });
|
||||
}
|
||||
else {
|
||||
ui.div({ ...row, padding: [0, 0, 1, indent(headingLevel + 1)] });
|
||||
}
|
||||
}
|
||||
}
|
||||
return (this.#usage = ui.toString());
|
||||
}
|
||||
/**
|
||||
* Return the usage banner markdown for the given configuration
|
||||
*/
|
||||
usageMarkdown() {
|
||||
if (this.#usageMarkdown)
|
||||
return this.#usageMarkdown;
|
||||
const out = [];
|
||||
let headingLevel = 1;
|
||||
const first = this.#fields[0];
|
||||
let start = first?.type === 'heading' ? 1 : 0;
|
||||
if (first?.type === 'heading') {
|
||||
out.push(`# ${normalizeOneLine(first.text)}`);
|
||||
}
|
||||
out.push('Usage:');
|
||||
if (this.#options.usage) {
|
||||
out.push(normalizeMarkdown(this.#options.usage, true));
|
||||
}
|
||||
else {
|
||||
const cmd = (0, node_path_1.basename)(process.argv[1]);
|
||||
const shortFlags = [];
|
||||
const shorts = [];
|
||||
const flags = [];
|
||||
const opts = [];
|
||||
for (const [field, config] of Object.entries(this.#configSet)) {
|
||||
if (config.short) {
|
||||
if (config.type === 'boolean')
|
||||
shortFlags.push(config.short);
|
||||
else
|
||||
shorts.push([config.short, config.hint || field]);
|
||||
}
|
||||
else {
|
||||
if (config.type === 'boolean')
|
||||
flags.push(field);
|
||||
else
|
||||
opts.push([field, config.hint || field]);
|
||||
}
|
||||
}
|
||||
const sf = shortFlags.length ? ' -' + shortFlags.join('') : '';
|
||||
const so = shorts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const lf = flags.map(k => ` --${k}`).join('');
|
||||
const lo = opts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const usage = `${cmd}${sf}${so}${lf}${lo}`.trim();
|
||||
out.push(normalizeMarkdown(usage, true));
|
||||
}
|
||||
const maybeDesc = this.#fields[start];
|
||||
if (isDescription(maybeDesc)) {
|
||||
out.push(normalizeMarkdown(maybeDesc.text, maybeDesc.pre));
|
||||
start++;
|
||||
}
|
||||
const { rows } = this.#usageRows(start);
|
||||
// heading level in markdown is number of # ahead of text
|
||||
for (const row of rows) {
|
||||
if (row.left) {
|
||||
out.push('#'.repeat(headingLevel + 1) +
|
||||
' ' +
|
||||
normalizeOneLine(row.left, true));
|
||||
if (row.text)
|
||||
out.push(normalizeMarkdown(row.text));
|
||||
}
|
||||
else if (isHeading(row)) {
|
||||
const { level } = row;
|
||||
headingLevel = level;
|
||||
out.push(`${'#'.repeat(headingLevel)} ${normalizeOneLine(row.text, row.pre)}`);
|
||||
}
|
||||
else {
|
||||
out.push(normalizeMarkdown(row.text, !!row.pre));
|
||||
}
|
||||
}
|
||||
return (this.#usageMarkdown = out.join('\n\n') + '\n');
|
||||
}
|
||||
#usageRows(start) {
|
||||
// turn each config type into a row, and figure out the width of the
|
||||
// left hand indentation for the option descriptions.
|
||||
let maxMax = Math.max(12, Math.min(26, Math.floor(width / 3)));
|
||||
let maxWidth = 8;
|
||||
let prev = undefined;
|
||||
const rows = [];
|
||||
for (const field of this.#fields.slice(start)) {
|
||||
if (field.type !== 'config') {
|
||||
if (prev?.type === 'config')
|
||||
prev.skipLine = true;
|
||||
prev = undefined;
|
||||
field.text = normalize(field.text, !!field.pre);
|
||||
rows.push(field);
|
||||
continue;
|
||||
}
|
||||
const { value } = field;
|
||||
const desc = value.description || '';
|
||||
const mult = value.multiple ? 'Can be set multiple times' : '';
|
||||
const dmDelim = mult && (desc.includes('\n') ? '\n\n' : '\n');
|
||||
const text = normalize(desc + dmDelim + mult);
|
||||
const hint = value.hint ||
|
||||
(value.type === 'number'
|
||||
? 'n'
|
||||
: value.type === 'string'
|
||||
? field.name
|
||||
: undefined);
|
||||
const short = !value.short
|
||||
? ''
|
||||
: value.type === 'boolean'
|
||||
? `-${value.short} `
|
||||
: `-${value.short}<${hint}> `;
|
||||
const left = value.type === 'boolean'
|
||||
? `${short}--${field.name}`
|
||||
: `${short}--${field.name}=<${hint}>`;
|
||||
const row = { text, left, type: 'config' };
|
||||
if (text.length > width - maxMax) {
|
||||
row.skipLine = true;
|
||||
}
|
||||
if (prev && left.length > maxMax)
|
||||
prev.skipLine = true;
|
||||
prev = row;
|
||||
const len = left.length + 4;
|
||||
if (len > maxWidth && len < maxMax) {
|
||||
maxWidth = len;
|
||||
}
|
||||
rows.push(row);
|
||||
}
|
||||
return { rows, maxWidth };
|
||||
}
|
||||
/**
|
||||
* Return the configuration options as a plain object
|
||||
*/
|
||||
toJSON() {
|
||||
return Object.fromEntries(Object.entries(this.#configSet).map(([field, def]) => [
|
||||
field,
|
||||
{
|
||||
type: def.type,
|
||||
...(def.multiple ? { multiple: true } : {}),
|
||||
...(def.delim ? { delim: def.delim } : {}),
|
||||
...(def.short ? { short: def.short } : {}),
|
||||
...(def.description
|
||||
? { description: normalize(def.description) }
|
||||
: {}),
|
||||
...(def.validate ? { validate: def.validate } : {}),
|
||||
...(def.default !== undefined ? { default: def.default } : {}),
|
||||
},
|
||||
]));
|
||||
}
|
||||
/**
|
||||
* Custom printer for `util.inspect`
|
||||
*/
|
||||
[node_util_1.inspect.custom](_, options) {
|
||||
return `Jack ${(0, node_util_1.inspect)(this.toJSON(), options)}`;
|
||||
}
|
||||
}
|
||||
exports.Jack = Jack;
|
||||
// Unwrap and un-indent, so we can wrap description
|
||||
// strings however makes them look nice in the code.
|
||||
const normalize = (s, pre = false) => pre
|
||||
? // prepend a ZWSP to each line so cliui doesn't strip it.
|
||||
s
|
||||
.split('\n')
|
||||
.map(l => `\u200b${l}`)
|
||||
.join('\n')
|
||||
: s
|
||||
// remove single line breaks, except for lists
|
||||
.replace(/([^\n])\n[ \t]*([^\n])/g, (_, $1, $2) => !/^[-*]/.test($2) ? `${$1} ${$2}` : `${$1}\n${$2}`)
|
||||
// normalize mid-line whitespace
|
||||
.replace(/([^\n])[ \t]+([^\n])/g, '$1 $2')
|
||||
// two line breaks are enough
|
||||
.replace(/\n{3,}/g, '\n\n')
|
||||
// remove any spaces at the start of a line
|
||||
.replace(/\n[ \t]+/g, '\n')
|
||||
.trim();
|
||||
// normalize for markdown printing, remove leading spaces on lines
|
||||
const normalizeMarkdown = (s, pre = false) => {
|
||||
const n = normalize(s, pre).replace(/\\/g, '\\\\');
|
||||
return pre
|
||||
? `\`\`\`\n${n.replace(/\u200b/g, '')}\n\`\`\``
|
||||
: n.replace(/\n +/g, '\n').trim();
|
||||
};
|
||||
const normalizeOneLine = (s, pre = false) => {
|
||||
const n = normalize(s, pre)
|
||||
.replace(/[\s\u200b]+/g, ' ')
|
||||
.trim();
|
||||
return pre ? `\`${n}\`` : n;
|
||||
};
|
||||
/**
|
||||
* Main entry point. Create and return a {@link Jack} object.
|
||||
*/
|
||||
const jack = (options = {}) => new Jack(options);
|
||||
exports.jack = jack;
|
||||
//# sourceMappingURL=index.js.map
|
1
app/node_modules/jackspeak/dist/cjs/index.js.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/cjs/index.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
3
app/node_modules/jackspeak/dist/cjs/package.json
generated
vendored
Normal file
3
app/node_modules/jackspeak/dist/cjs/package.json
generated
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"type": "commonjs"
|
||||
}
|
1
app/node_modules/jackspeak/dist/cjs/parse-args-cjs.d.ts.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/cjs/parse-args-cjs.d.ts.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"parse-args-cjs.d.ts","sourceRoot":"","sources":["../../src/parse-args-cjs.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAkB5B,eAAO,MAAM,SAAS,uBAAK,CAAA"}
|
1
app/node_modules/jackspeak/dist/cjs/parse-args-cjs.js.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/cjs/parse-args-cjs.js.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"parse-args-cjs.js","sourceRoot":"","sources":["../../src/parse-args-cjs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA4B;AAE5B,MAAM,EAAE,GACN,OAAO,OAAO,KAAK,QAAQ;IAC3B,CAAC,CAAC,OAAO;IACT,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;IACjC,CAAC,CAAC,OAAO,CAAC,OAAO;IACjB,CAAC,CAAC,QAAQ,CAAA;AACd,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,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,IAAI,CAAA;AAC5B,IAAI,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE;IACrC,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,SAAS,CAAA;CAC3C;AAEY,QAAA,SAAS,GAAG,EAAE,CAAA","sourcesContent":["import * as util from 'util'\n\nconst pv =\n typeof process === 'object' &&\n !!process &&\n typeof process.version === 'string'\n ? process.version\n : 'v0.0.0'\nconst pvs = pv\n .replace(/^v/, '')\n .split('.')\n .map(s => parseInt(s, 10))\n\nlet { parseArgs: pa } = util\nif (!pa || pvs[0] > 18 || pvs[1] < 11) {\n pa = require('@pkgjs/parseargs').parseArgs\n}\n\nexport const parseArgs = pa\n"]}
|
4
app/node_modules/jackspeak/dist/cjs/parse-args.d.ts
generated
vendored
Normal file
4
app/node_modules/jackspeak/dist/cjs/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.ts.map
|
42
app/node_modules/jackspeak/dist/cjs/parse-args.js
generated
vendored
Normal file
42
app/node_modules/jackspeak/dist/cjs/parse-args.js
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
"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));
|
||||
let { parseArgs: pa } = util;
|
||||
if (!pa || pvs[0] > 18 || pvs[1] < 11) {
|
||||
pa = require('@pkgjs/parseargs').parseArgs;
|
||||
}
|
||||
exports.parseArgs = pa;
|
||||
//# sourceMappingURL=parse-args-cjs.js.map
|
292
app/node_modules/jackspeak/dist/mjs/index.d.ts
generated
vendored
Normal file
292
app/node_modules/jackspeak/dist/mjs/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,292 @@
|
||||
/// <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, M extends 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> = {
|
||||
default?: ValidValue<T, M> | undefined;
|
||||
description?: string;
|
||||
validate?: ((v: any) => v is ValidValue<T, M>) | ((v: any) => boolean);
|
||||
short?: string | undefined;
|
||||
type?: T;
|
||||
} & (T extends 'boolean' ? {} : {
|
||||
hint?: string | undefined;
|
||||
}) & (M extends false ? {} : {
|
||||
multiple?: M | undefined;
|
||||
delim?: string | undefined;
|
||||
});
|
||||
/**
|
||||
* A set of {@link ConfigOptionMeta} fields, referenced by their longOption
|
||||
* string values.
|
||||
*/
|
||||
export type ConfigMetaSet<T extends ConfigType, M extends 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> = {
|
||||
type: T;
|
||||
short?: string | undefined;
|
||||
default?: ValidValue<T, M> | undefined;
|
||||
description?: string;
|
||||
hint?: T extends 'boolean' ? undefined : string | undefined;
|
||||
validate?: (v: any) => v is ValidValue<T, M>;
|
||||
} & 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, boolean>;
|
||||
};
|
||||
/**
|
||||
* The 'values' field returned by {@link Jack#parse}
|
||||
*/
|
||||
export type OptionsResults<T extends ConfigSet> = {
|
||||
[k in keyof T]?: 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, boolean>;
|
||||
};
|
||||
/**
|
||||
* 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;
|
||||
}
|
||||
/**
|
||||
* 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>;
|
||||
/**
|
||||
* Validate that any arbitrary object is a valid configuration `values`
|
||||
* object. Useful when loading config files or other sources.
|
||||
*/
|
||||
validate(o: any): asserts o is Parsed<C>['values'];
|
||||
/**
|
||||
* 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', true>>(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', true>>(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', true>>(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]: {
|
||||
default?: string | number | boolean | number[] | string[] | boolean[] | undefined;
|
||||
validate?: ((v: any) => v is string | number | boolean | number[] | string[] | 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
app/node_modules/jackspeak/dist/mjs/index.d.ts.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/mjs/index.d.ts.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
825
app/node_modules/jackspeak/dist/mjs/index.js
generated
vendored
Normal file
825
app/node_modules/jackspeak/dist/mjs/index.js
generated
vendored
Normal file
@@ -0,0 +1,825 @@
|
||||
import { inspect } from 'node:util';
|
||||
import { parseArgs } from './parse-args.js';
|
||||
// it's a tiny API, just cast it inline, it's fine
|
||||
//@ts-ignore
|
||||
import cliui from '@isaacs/cliui';
|
||||
import { basename } from 'node:path';
|
||||
const width = Math.min((process && process.stdout && process.stdout.columns) || 80, 80);
|
||||
// indentation spaces from heading level
|
||||
const indent = (n) => (n - 1) * 2;
|
||||
const toEnvKey = (pref, key) => {
|
||||
return [pref, key.replace(/[^a-zA-Z0-9]+/g, ' ')]
|
||||
.join(' ')
|
||||
.trim()
|
||||
.toUpperCase()
|
||||
.replace(/ /g, '_');
|
||||
};
|
||||
const toEnvVal = (value, delim = '\n') => {
|
||||
const str = typeof value === 'string'
|
||||
? value
|
||||
: typeof value === 'boolean'
|
||||
? value
|
||||
? '1'
|
||||
: '0'
|
||||
: typeof value === 'number'
|
||||
? String(value)
|
||||
: Array.isArray(value)
|
||||
? value
|
||||
.map((v) => toEnvVal(v))
|
||||
.join(delim)
|
||||
: /* c8 ignore start */
|
||||
undefined;
|
||||
if (typeof str !== 'string') {
|
||||
throw new Error(`could not serialize value to environment: ${JSON.stringify(value)}`);
|
||||
}
|
||||
/* c8 ignore stop */
|
||||
return str;
|
||||
};
|
||||
const fromEnvVal = (env, type, multiple, delim = '\n') => (multiple
|
||||
? env
|
||||
? env.split(delim).map(v => fromEnvVal(v, type, false))
|
||||
: []
|
||||
: type === 'string'
|
||||
? env
|
||||
: type === 'boolean'
|
||||
? env === '1'
|
||||
: +env.trim());
|
||||
export const isConfigType = (t) => typeof t === 'string' &&
|
||||
(t === 'string' || t === 'number' || t === 'boolean');
|
||||
const undefOrType = (v, t) => v === undefined || typeof v === t;
|
||||
// print the value type, for error message reporting
|
||||
const valueType = (v) => typeof v === 'string'
|
||||
? 'string'
|
||||
: typeof v === 'boolean'
|
||||
? 'boolean'
|
||||
: typeof v === 'number'
|
||||
? 'number'
|
||||
: Array.isArray(v)
|
||||
? joinTypes([...new Set(v.map(v => valueType(v)))]) + '[]'
|
||||
: `${v.type}${v.multiple ? '[]' : ''}`;
|
||||
const joinTypes = (types) => types.length === 1 ? types[0] : `(${types.join('|')})`;
|
||||
const isValidValue = (v, type, multi) => {
|
||||
if (multi) {
|
||||
if (!Array.isArray(v))
|
||||
return false;
|
||||
return !v.some((v) => !isValidValue(v, type, false));
|
||||
}
|
||||
if (Array.isArray(v))
|
||||
return false;
|
||||
return typeof v === type;
|
||||
};
|
||||
export const isConfigOption = (o, type, multi) => !!o &&
|
||||
typeof o === 'object' &&
|
||||
isConfigType(o.type) &&
|
||||
o.type === type &&
|
||||
undefOrType(o.short, 'string') &&
|
||||
undefOrType(o.description, 'string') &&
|
||||
undefOrType(o.hint, 'string') &&
|
||||
undefOrType(o.validate, 'function') &&
|
||||
(o.default === undefined || isValidValue(o.default, type, multi)) &&
|
||||
!!o.multiple === multi;
|
||||
function num(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'number', false)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'number',
|
||||
multiple: false,
|
||||
};
|
||||
}
|
||||
function numList(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'number', true)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'number',
|
||||
multiple: true,
|
||||
};
|
||||
}
|
||||
function opt(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'string', false)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'string',
|
||||
multiple: false,
|
||||
};
|
||||
}
|
||||
function optList(o = {}) {
|
||||
const { default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'string', true)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'string',
|
||||
multiple: true,
|
||||
};
|
||||
}
|
||||
function flag(o = {}) {
|
||||
const { hint, default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'boolean', false)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
if (hint !== undefined) {
|
||||
throw new TypeError('cannot provide hint for flag');
|
||||
}
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'boolean',
|
||||
multiple: false,
|
||||
};
|
||||
}
|
||||
function flagList(o = {}) {
|
||||
const { hint, default: def, validate: val, ...rest } = o;
|
||||
if (def !== undefined && !isValidValue(def, 'boolean', true)) {
|
||||
throw new TypeError('invalid default value');
|
||||
}
|
||||
const validate = val
|
||||
? val
|
||||
: undefined;
|
||||
if (hint !== undefined) {
|
||||
throw new TypeError('cannot provide hint for flag list');
|
||||
}
|
||||
return {
|
||||
...rest,
|
||||
default: def,
|
||||
validate,
|
||||
type: 'boolean',
|
||||
multiple: true,
|
||||
};
|
||||
}
|
||||
const toParseArgsOptionsConfig = (options) => {
|
||||
const c = {};
|
||||
for (const longOption in options) {
|
||||
const config = options[longOption];
|
||||
if (isConfigOption(config, 'number', true)) {
|
||||
c[longOption] = {
|
||||
type: 'string',
|
||||
multiple: true,
|
||||
default: config.default?.map(c => String(c)),
|
||||
};
|
||||
}
|
||||
else if (isConfigOption(config, 'number', false)) {
|
||||
c[longOption] = {
|
||||
type: 'string',
|
||||
multiple: false,
|
||||
default: config.default === undefined
|
||||
? undefined
|
||||
: String(config.default),
|
||||
};
|
||||
}
|
||||
else {
|
||||
const conf = config;
|
||||
c[longOption] = {
|
||||
type: conf.type,
|
||||
multiple: conf.multiple,
|
||||
default: conf.default,
|
||||
};
|
||||
}
|
||||
if (typeof config.short === 'string') {
|
||||
c[longOption].short = config.short;
|
||||
}
|
||||
if (config.type === 'boolean' &&
|
||||
!longOption.startsWith('no-') &&
|
||||
!options[`no-${longOption}`]) {
|
||||
c[`no-${longOption}`] = {
|
||||
type: 'boolean',
|
||||
multiple: config.multiple,
|
||||
};
|
||||
}
|
||||
}
|
||||
return c;
|
||||
};
|
||||
const isHeading = (r) => r.type === 'heading';
|
||||
const isDescription = (r) => r.type === 'description';
|
||||
/**
|
||||
* Class returned by the {@link jack} function and all configuration
|
||||
* definition methods. This is what gets chained together.
|
||||
*/
|
||||
export class Jack {
|
||||
#configSet;
|
||||
#shorts;
|
||||
#options;
|
||||
#fields = [];
|
||||
#env;
|
||||
#envPrefix;
|
||||
#allowPositionals;
|
||||
#usage;
|
||||
#usageMarkdown;
|
||||
constructor(options = {}) {
|
||||
this.#options = options;
|
||||
this.#allowPositionals = options.allowPositionals !== false;
|
||||
this.#env =
|
||||
this.#options.env === undefined ? process.env : this.#options.env;
|
||||
this.#envPrefix = options.envPrefix;
|
||||
// We need to fib a little, because it's always the same object, but it
|
||||
// starts out as having an empty config set. Then each method that adds
|
||||
// fields returns `this as Jack<C & { ...newConfigs }>`
|
||||
this.#configSet = Object.create(null);
|
||||
this.#shorts = Object.create(null);
|
||||
}
|
||||
/**
|
||||
* 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, source = '') {
|
||||
try {
|
||||
this.validate(values);
|
||||
}
|
||||
catch (er) {
|
||||
throw Object.assign(er, source ? { source } : {});
|
||||
}
|
||||
for (const [field, value] of Object.entries(values)) {
|
||||
const my = this.#configSet[field];
|
||||
my.default = value;
|
||||
}
|
||||
return 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 = process.argv) {
|
||||
if (args === process.argv) {
|
||||
args = args.slice(process._eval !== undefined ? 1 : 2);
|
||||
}
|
||||
if (this.#envPrefix) {
|
||||
for (const [field, my] of Object.entries(this.#configSet)) {
|
||||
const ek = toEnvKey(this.#envPrefix, field);
|
||||
const env = this.#env[ek];
|
||||
if (env !== undefined) {
|
||||
my.default = fromEnvVal(env, my.type, !!my.multiple, my.delim);
|
||||
}
|
||||
}
|
||||
}
|
||||
const options = toParseArgsOptionsConfig(this.#configSet);
|
||||
const result = parseArgs({
|
||||
args,
|
||||
options,
|
||||
// always strict, but using our own logic
|
||||
strict: false,
|
||||
allowPositionals: this.#allowPositionals,
|
||||
tokens: true,
|
||||
});
|
||||
const p = {
|
||||
values: {},
|
||||
positionals: [],
|
||||
};
|
||||
for (const token of result.tokens) {
|
||||
if (token.kind === 'positional') {
|
||||
p.positionals.push(token.value);
|
||||
if (this.#options.stopAtPositional) {
|
||||
p.positionals.push(...args.slice(token.index + 1));
|
||||
return p;
|
||||
}
|
||||
}
|
||||
else if (token.kind === 'option') {
|
||||
let value = undefined;
|
||||
if (token.name.startsWith('no-')) {
|
||||
const my = this.#configSet[token.name];
|
||||
const pname = token.name.substring('no-'.length);
|
||||
const pos = this.#configSet[pname];
|
||||
if (pos &&
|
||||
pos.type === 'boolean' &&
|
||||
(!my ||
|
||||
(my.type === 'boolean' && !!my.multiple === !!pos.multiple))) {
|
||||
value = false;
|
||||
token.name = pname;
|
||||
}
|
||||
}
|
||||
const my = this.#configSet[token.name];
|
||||
if (!my) {
|
||||
throw new Error(`Unknown option '${token.rawName}'. ` +
|
||||
`To specify a positional argument starting with a '-', ` +
|
||||
`place it at the end of the command after '--', as in ` +
|
||||
`'-- ${token.rawName}'`);
|
||||
}
|
||||
if (value === undefined) {
|
||||
if (token.value === undefined) {
|
||||
if (my.type !== 'boolean') {
|
||||
throw new Error(`No value provided for ${token.rawName}, expected ${my.type}`);
|
||||
}
|
||||
value = true;
|
||||
}
|
||||
else {
|
||||
if (my.type === 'boolean') {
|
||||
throw new Error(`Flag ${token.rawName} does not take a value, received '${token.value}'`);
|
||||
}
|
||||
if (my.type === 'string') {
|
||||
value = token.value;
|
||||
}
|
||||
else {
|
||||
value = +token.value;
|
||||
if (value !== value) {
|
||||
throw new Error(`Invalid value '${token.value}' provided for ` +
|
||||
`'${token.rawName}' option, expected number`);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (my.multiple) {
|
||||
const pv = p.values;
|
||||
pv[token.name] = pv[token.name] ?? [];
|
||||
pv[token.name].push(value);
|
||||
}
|
||||
else {
|
||||
const pv = p.values;
|
||||
pv[token.name] = value;
|
||||
}
|
||||
}
|
||||
}
|
||||
for (const [field, c] of Object.entries(this.#configSet)) {
|
||||
if (c.default !== undefined && !(field in p.values)) {
|
||||
//@ts-ignore
|
||||
p.values[field] = c.default;
|
||||
}
|
||||
}
|
||||
for (const [field, value] of Object.entries(p.values)) {
|
||||
const valid = this.#configSet[field].validate;
|
||||
if (valid && !valid(value)) {
|
||||
throw new Error(`Invalid value provided for --${field}: ${JSON.stringify(value)}`);
|
||||
}
|
||||
}
|
||||
this.#writeEnv(p);
|
||||
return p;
|
||||
}
|
||||
/**
|
||||
* do not set fields as 'no-foo' if 'foo' exists and both are bools
|
||||
* just set foo.
|
||||
*/
|
||||
#noNoFields(f, val, s = f) {
|
||||
if (!f.startsWith('no-') || typeof val !== 'boolean')
|
||||
return;
|
||||
const yes = f.substring('no-'.length);
|
||||
// recurse so we get the core config key we care about.
|
||||
this.#noNoFields(yes, val, s);
|
||||
if (this.#configSet[yes]?.type === 'boolean') {
|
||||
throw new Error(`do not set '${s}', instead set '${yes}' as desired.`);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Validate that any arbitrary object is a valid configuration `values`
|
||||
* object. Useful when loading config files or other sources.
|
||||
*/
|
||||
validate(o) {
|
||||
if (!o || typeof o !== 'object') {
|
||||
throw new Error('Invalid config: not an object');
|
||||
}
|
||||
for (const field in o) {
|
||||
this.#noNoFields(field, o[field]);
|
||||
const config = this.#configSet[field];
|
||||
if (!config) {
|
||||
throw new Error(`Unknown config option: ${field}`);
|
||||
}
|
||||
if (!isValidValue(o[field], config.type, !!config.multiple)) {
|
||||
throw Object.assign(new Error(`Invalid value ${valueType(o[field])} for ${field}, expected ${valueType(config)}`), {
|
||||
field,
|
||||
value: o[field],
|
||||
});
|
||||
}
|
||||
if (config.validate && !config.validate(o[field])) {
|
||||
throw new Error(`Invalid config value for ${field}: ${o[field]}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
#writeEnv(p) {
|
||||
if (!this.#env || !this.#envPrefix)
|
||||
return;
|
||||
for (const [field, value] of Object.entries(p.values)) {
|
||||
const my = this.#configSet[field];
|
||||
this.#env[toEnvKey(this.#envPrefix, field)] = toEnvVal(value, my.delim);
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Add a heading to the usage output banner
|
||||
*/
|
||||
heading(text, level, { pre = false } = {}) {
|
||||
if (level === undefined) {
|
||||
level = this.#fields.some(r => isHeading(r)) ? 2 : 1;
|
||||
}
|
||||
this.#fields.push({ type: 'heading', text, level, pre });
|
||||
return this;
|
||||
}
|
||||
/**
|
||||
* Add a long-form description to the usage output at this position.
|
||||
*/
|
||||
description(text, { pre } = {}) {
|
||||
this.#fields.push({ type: 'description', text, pre });
|
||||
return this;
|
||||
}
|
||||
/**
|
||||
* Add one or more number fields.
|
||||
*/
|
||||
num(fields) {
|
||||
return this.#addFields(fields, num);
|
||||
}
|
||||
/**
|
||||
* Add one or more multiple number fields.
|
||||
*/
|
||||
numList(fields) {
|
||||
return this.#addFields(fields, numList);
|
||||
}
|
||||
/**
|
||||
* Add one or more string option fields.
|
||||
*/
|
||||
opt(fields) {
|
||||
return this.#addFields(fields, opt);
|
||||
}
|
||||
/**
|
||||
* Add one or more multiple string option fields.
|
||||
*/
|
||||
optList(fields) {
|
||||
return this.#addFields(fields, optList);
|
||||
}
|
||||
/**
|
||||
* Add one or more flag fields.
|
||||
*/
|
||||
flag(fields) {
|
||||
return this.#addFields(fields, flag);
|
||||
}
|
||||
/**
|
||||
* Add one or more multiple flag fields.
|
||||
*/
|
||||
flagList(fields) {
|
||||
return this.#addFields(fields, flagList);
|
||||
}
|
||||
/**
|
||||
* 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(fields) {
|
||||
const next = this;
|
||||
for (const [name, field] of Object.entries(fields)) {
|
||||
this.#validateName(name, field);
|
||||
next.#fields.push({
|
||||
type: 'config',
|
||||
name,
|
||||
value: field,
|
||||
});
|
||||
}
|
||||
Object.assign(next.#configSet, fields);
|
||||
return next;
|
||||
}
|
||||
#addFields(fields, fn) {
|
||||
const next = this;
|
||||
Object.assign(next.#configSet, Object.fromEntries(Object.entries(fields).map(([name, field]) => {
|
||||
this.#validateName(name, field);
|
||||
const option = fn(field);
|
||||
next.#fields.push({
|
||||
type: 'config',
|
||||
name,
|
||||
value: option,
|
||||
});
|
||||
return [name, option];
|
||||
})));
|
||||
return next;
|
||||
}
|
||||
#validateName(name, field) {
|
||||
if (!/^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?$/.test(name)) {
|
||||
throw new TypeError(`Invalid option name: ${name}, ` +
|
||||
`must be '-' delimited ASCII alphanumeric`);
|
||||
}
|
||||
if (this.#configSet[name]) {
|
||||
throw new TypeError(`Cannot redefine option ${field}`);
|
||||
}
|
||||
if (this.#shorts[name]) {
|
||||
throw new TypeError(`Cannot redefine option ${name}, already ` +
|
||||
`in use for ${this.#shorts[name]}`);
|
||||
}
|
||||
if (field.short) {
|
||||
if (!/^[a-zA-Z0-9]$/.test(field.short)) {
|
||||
throw new TypeError(`Invalid ${name} short option: ${field.short}, ` +
|
||||
'must be 1 ASCII alphanumeric character');
|
||||
}
|
||||
if (this.#shorts[field.short]) {
|
||||
throw new TypeError(`Invalid ${name} short option: ${field.short}, ` +
|
||||
`already in use for ${this.#shorts[field.short]}`);
|
||||
}
|
||||
this.#shorts[field.short] = name;
|
||||
this.#shorts[name] = name;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Return the usage banner for the given configuration
|
||||
*/
|
||||
usage() {
|
||||
if (this.#usage)
|
||||
return this.#usage;
|
||||
let headingLevel = 1;
|
||||
const ui = cliui({ width });
|
||||
const first = this.#fields[0];
|
||||
let start = first?.type === 'heading' ? 1 : 0;
|
||||
if (first?.type === 'heading') {
|
||||
ui.div({
|
||||
padding: [0, 0, 0, 0],
|
||||
text: normalize(first.text),
|
||||
});
|
||||
}
|
||||
ui.div({ padding: [0, 0, 0, 0], text: 'Usage:' });
|
||||
if (this.#options.usage) {
|
||||
ui.div({
|
||||
text: this.#options.usage,
|
||||
padding: [0, 0, 0, 2],
|
||||
});
|
||||
}
|
||||
else {
|
||||
const cmd = basename(process.argv[1]);
|
||||
const shortFlags = [];
|
||||
const shorts = [];
|
||||
const flags = [];
|
||||
const opts = [];
|
||||
for (const [field, config] of Object.entries(this.#configSet)) {
|
||||
if (config.short) {
|
||||
if (config.type === 'boolean')
|
||||
shortFlags.push(config.short);
|
||||
else
|
||||
shorts.push([config.short, config.hint || field]);
|
||||
}
|
||||
else {
|
||||
if (config.type === 'boolean')
|
||||
flags.push(field);
|
||||
else
|
||||
opts.push([field, config.hint || field]);
|
||||
}
|
||||
}
|
||||
const sf = shortFlags.length ? ' -' + shortFlags.join('') : '';
|
||||
const so = shorts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const lf = flags.map(k => ` --${k}`).join('');
|
||||
const lo = opts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const usage = `${cmd}${sf}${so}${lf}${lo}`.trim();
|
||||
ui.div({
|
||||
text: usage,
|
||||
padding: [0, 0, 0, 2],
|
||||
});
|
||||
}
|
||||
ui.div({ padding: [0, 0, 0, 0], text: '' });
|
||||
const maybeDesc = this.#fields[start];
|
||||
if (isDescription(maybeDesc)) {
|
||||
const print = normalize(maybeDesc.text, maybeDesc.pre);
|
||||
start++;
|
||||
ui.div({ padding: [0, 0, 0, 0], text: print });
|
||||
ui.div({ padding: [0, 0, 0, 0], text: '' });
|
||||
}
|
||||
const { rows, maxWidth } = this.#usageRows(start);
|
||||
// every heading/description after the first gets indented by 2
|
||||
// extra spaces.
|
||||
for (const row of rows) {
|
||||
if (row.left) {
|
||||
// If the row is too long, don't wrap it
|
||||
// Bump the right-hand side down a line to make room
|
||||
const configIndent = indent(Math.max(headingLevel, 2));
|
||||
if (row.left.length > maxWidth - 3) {
|
||||
ui.div({ text: row.left, padding: [0, 0, 0, configIndent] });
|
||||
ui.div({ text: row.text, padding: [0, 0, 0, maxWidth] });
|
||||
}
|
||||
else {
|
||||
ui.div({
|
||||
text: row.left,
|
||||
padding: [0, 1, 0, configIndent],
|
||||
width: maxWidth,
|
||||
}, { padding: [0, 0, 0, 0], text: row.text });
|
||||
}
|
||||
if (row.skipLine) {
|
||||
ui.div({ padding: [0, 0, 0, 0], text: '' });
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (isHeading(row)) {
|
||||
const { level } = row;
|
||||
headingLevel = level;
|
||||
// only h1 and h2 have bottom padding
|
||||
// h3-h6 do not
|
||||
const b = level <= 2 ? 1 : 0;
|
||||
ui.div({ ...row, padding: [0, 0, b, indent(level)] });
|
||||
}
|
||||
else {
|
||||
ui.div({ ...row, padding: [0, 0, 1, indent(headingLevel + 1)] });
|
||||
}
|
||||
}
|
||||
}
|
||||
return (this.#usage = ui.toString());
|
||||
}
|
||||
/**
|
||||
* Return the usage banner markdown for the given configuration
|
||||
*/
|
||||
usageMarkdown() {
|
||||
if (this.#usageMarkdown)
|
||||
return this.#usageMarkdown;
|
||||
const out = [];
|
||||
let headingLevel = 1;
|
||||
const first = this.#fields[0];
|
||||
let start = first?.type === 'heading' ? 1 : 0;
|
||||
if (first?.type === 'heading') {
|
||||
out.push(`# ${normalizeOneLine(first.text)}`);
|
||||
}
|
||||
out.push('Usage:');
|
||||
if (this.#options.usage) {
|
||||
out.push(normalizeMarkdown(this.#options.usage, true));
|
||||
}
|
||||
else {
|
||||
const cmd = basename(process.argv[1]);
|
||||
const shortFlags = [];
|
||||
const shorts = [];
|
||||
const flags = [];
|
||||
const opts = [];
|
||||
for (const [field, config] of Object.entries(this.#configSet)) {
|
||||
if (config.short) {
|
||||
if (config.type === 'boolean')
|
||||
shortFlags.push(config.short);
|
||||
else
|
||||
shorts.push([config.short, config.hint || field]);
|
||||
}
|
||||
else {
|
||||
if (config.type === 'boolean')
|
||||
flags.push(field);
|
||||
else
|
||||
opts.push([field, config.hint || field]);
|
||||
}
|
||||
}
|
||||
const sf = shortFlags.length ? ' -' + shortFlags.join('') : '';
|
||||
const so = shorts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const lf = flags.map(k => ` --${k}`).join('');
|
||||
const lo = opts.map(([k, v]) => ` --${k}=<${v}>`).join('');
|
||||
const usage = `${cmd}${sf}${so}${lf}${lo}`.trim();
|
||||
out.push(normalizeMarkdown(usage, true));
|
||||
}
|
||||
const maybeDesc = this.#fields[start];
|
||||
if (isDescription(maybeDesc)) {
|
||||
out.push(normalizeMarkdown(maybeDesc.text, maybeDesc.pre));
|
||||
start++;
|
||||
}
|
||||
const { rows } = this.#usageRows(start);
|
||||
// heading level in markdown is number of # ahead of text
|
||||
for (const row of rows) {
|
||||
if (row.left) {
|
||||
out.push('#'.repeat(headingLevel + 1) +
|
||||
' ' +
|
||||
normalizeOneLine(row.left, true));
|
||||
if (row.text)
|
||||
out.push(normalizeMarkdown(row.text));
|
||||
}
|
||||
else if (isHeading(row)) {
|
||||
const { level } = row;
|
||||
headingLevel = level;
|
||||
out.push(`${'#'.repeat(headingLevel)} ${normalizeOneLine(row.text, row.pre)}`);
|
||||
}
|
||||
else {
|
||||
out.push(normalizeMarkdown(row.text, !!row.pre));
|
||||
}
|
||||
}
|
||||
return (this.#usageMarkdown = out.join('\n\n') + '\n');
|
||||
}
|
||||
#usageRows(start) {
|
||||
// turn each config type into a row, and figure out the width of the
|
||||
// left hand indentation for the option descriptions.
|
||||
let maxMax = Math.max(12, Math.min(26, Math.floor(width / 3)));
|
||||
let maxWidth = 8;
|
||||
let prev = undefined;
|
||||
const rows = [];
|
||||
for (const field of this.#fields.slice(start)) {
|
||||
if (field.type !== 'config') {
|
||||
if (prev?.type === 'config')
|
||||
prev.skipLine = true;
|
||||
prev = undefined;
|
||||
field.text = normalize(field.text, !!field.pre);
|
||||
rows.push(field);
|
||||
continue;
|
||||
}
|
||||
const { value } = field;
|
||||
const desc = value.description || '';
|
||||
const mult = value.multiple ? 'Can be set multiple times' : '';
|
||||
const dmDelim = mult && (desc.includes('\n') ? '\n\n' : '\n');
|
||||
const text = normalize(desc + dmDelim + mult);
|
||||
const hint = value.hint ||
|
||||
(value.type === 'number'
|
||||
? 'n'
|
||||
: value.type === 'string'
|
||||
? field.name
|
||||
: undefined);
|
||||
const short = !value.short
|
||||
? ''
|
||||
: value.type === 'boolean'
|
||||
? `-${value.short} `
|
||||
: `-${value.short}<${hint}> `;
|
||||
const left = value.type === 'boolean'
|
||||
? `${short}--${field.name}`
|
||||
: `${short}--${field.name}=<${hint}>`;
|
||||
const row = { text, left, type: 'config' };
|
||||
if (text.length > width - maxMax) {
|
||||
row.skipLine = true;
|
||||
}
|
||||
if (prev && left.length > maxMax)
|
||||
prev.skipLine = true;
|
||||
prev = row;
|
||||
const len = left.length + 4;
|
||||
if (len > maxWidth && len < maxMax) {
|
||||
maxWidth = len;
|
||||
}
|
||||
rows.push(row);
|
||||
}
|
||||
return { rows, maxWidth };
|
||||
}
|
||||
/**
|
||||
* Return the configuration options as a plain object
|
||||
*/
|
||||
toJSON() {
|
||||
return Object.fromEntries(Object.entries(this.#configSet).map(([field, def]) => [
|
||||
field,
|
||||
{
|
||||
type: def.type,
|
||||
...(def.multiple ? { multiple: true } : {}),
|
||||
...(def.delim ? { delim: def.delim } : {}),
|
||||
...(def.short ? { short: def.short } : {}),
|
||||
...(def.description
|
||||
? { description: normalize(def.description) }
|
||||
: {}),
|
||||
...(def.validate ? { validate: def.validate } : {}),
|
||||
...(def.default !== undefined ? { default: def.default } : {}),
|
||||
},
|
||||
]));
|
||||
}
|
||||
/**
|
||||
* Custom printer for `util.inspect`
|
||||
*/
|
||||
[inspect.custom](_, options) {
|
||||
return `Jack ${inspect(this.toJSON(), options)}`;
|
||||
}
|
||||
}
|
||||
// Unwrap and un-indent, so we can wrap description
|
||||
// strings however makes them look nice in the code.
|
||||
const normalize = (s, pre = false) => pre
|
||||
? // prepend a ZWSP to each line so cliui doesn't strip it.
|
||||
s
|
||||
.split('\n')
|
||||
.map(l => `\u200b${l}`)
|
||||
.join('\n')
|
||||
: s
|
||||
// remove single line breaks, except for lists
|
||||
.replace(/([^\n])\n[ \t]*([^\n])/g, (_, $1, $2) => !/^[-*]/.test($2) ? `${$1} ${$2}` : `${$1}\n${$2}`)
|
||||
// normalize mid-line whitespace
|
||||
.replace(/([^\n])[ \t]+([^\n])/g, '$1 $2')
|
||||
// two line breaks are enough
|
||||
.replace(/\n{3,}/g, '\n\n')
|
||||
// remove any spaces at the start of a line
|
||||
.replace(/\n[ \t]+/g, '\n')
|
||||
.trim();
|
||||
// normalize for markdown printing, remove leading spaces on lines
|
||||
const normalizeMarkdown = (s, pre = false) => {
|
||||
const n = normalize(s, pre).replace(/\\/g, '\\\\');
|
||||
return pre
|
||||
? `\`\`\`\n${n.replace(/\u200b/g, '')}\n\`\`\``
|
||||
: n.replace(/\n +/g, '\n').trim();
|
||||
};
|
||||
const normalizeOneLine = (s, pre = false) => {
|
||||
const n = normalize(s, pre)
|
||||
.replace(/[\s\u200b]+/g, ' ')
|
||||
.trim();
|
||||
return pre ? `\`${n}\`` : n;
|
||||
};
|
||||
/**
|
||||
* Main entry point. Create and return a {@link Jack} object.
|
||||
*/
|
||||
export const jack = (options = {}) => new Jack(options);
|
||||
//# sourceMappingURL=index.js.map
|
1
app/node_modules/jackspeak/dist/mjs/index.js.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/mjs/index.js.map
generated
vendored
Normal file
File diff suppressed because one or more lines are too long
3
app/node_modules/jackspeak/dist/mjs/package.json
generated
vendored
Normal file
3
app/node_modules/jackspeak/dist/mjs/package.json
generated
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"type": "module"
|
||||
}
|
1
app/node_modules/jackspeak/dist/mjs/parse-args-esm.d.ts.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/mjs/parse-args-esm.d.ts.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"parse-args-esm.d.ts","sourceRoot":"","sources":["../../src/parse-args-esm.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAmB5B,eAAO,MAAM,SAAS,uBAAK,CAAA"}
|
1
app/node_modules/jackspeak/dist/mjs/parse-args-esm.js.map
generated
vendored
Normal file
1
app/node_modules/jackspeak/dist/mjs/parse-args-esm.js.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"parse-args-esm.js","sourceRoot":"","sources":["../../src/parse-args-esm.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAE5B,MAAM,EAAE,GACN,OAAO,OAAO,KAAK,QAAQ;IAC3B,CAAC,CAAC,OAAO;IACT,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;IACjC,CAAC,CAAC,OAAO,CAAC,OAAO;IACjB,CAAC,CAAC,QAAQ,CAAA;AACd,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,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,IAAI,CAAA;AAC5B,IAAI,CAAC,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE;IACrC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC9C,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,SAAS,CAAA;CAC3C;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAA","sourcesContent":["// polyfill that overwrites parse-args.ts in the mjs build\nimport { createRequire } from 'module'\nimport * as util from 'util'\n\nconst pv =\n typeof process === 'object' &&\n !!process &&\n typeof process.version === 'string'\n ? process.version\n : 'v0.0.0'\nconst pvs = pv\n .replace(/^v/, '')\n .split('.')\n .map(s => parseInt(s, 10))\n\nlet { parseArgs: pa } = util\nif (!pa || pvs[0] > 18 || pvs[1] < 11) {\n const require = createRequire(import.meta.url)\n pa = require('@pkgjs/parseargs').parseArgs\n}\n\nexport const parseArgs = pa\n"]}
|
4
app/node_modules/jackspeak/dist/mjs/parse-args.d.ts
generated
vendored
Normal file
4
app/node_modules/jackspeak/dist/mjs/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-esm.d.ts.map
|
19
app/node_modules/jackspeak/dist/mjs/parse-args.js
generated
vendored
Normal file
19
app/node_modules/jackspeak/dist/mjs/parse-args.js
generated
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
// polyfill that overwrites parse-args.ts in the mjs build
|
||||
import { createRequire } from 'module';
|
||||
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));
|
||||
let { parseArgs: pa } = util;
|
||||
if (!pa || pvs[0] > 18 || pvs[1] < 11) {
|
||||
const require = createRequire(import.meta.url);
|
||||
pa = require('@pkgjs/parseargs').parseArgs;
|
||||
}
|
||||
export const parseArgs = pa;
|
||||
//# sourceMappingURL=parse-args-esm.js.map
|
131
app/node_modules/jackspeak/package.json
generated
vendored
Normal file
131
app/node_modules/jackspeak/package.json
generated
vendored
Normal file
@@ -0,0 +1,131 @@
|
||||
{
|
||||
"_from": "jackspeak@^2.0.3",
|
||||
"_id": "jackspeak@2.3.3",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-R2bUw+kVZFS/h1AZqBKrSgDmdmjApzgY0AlCPumopFiAlbUxE2gf+SCuBzQ0cP5hHmUmFYF5yw55T97Th5Kstg==",
|
||||
"_location": "/jackspeak",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "jackspeak@^2.0.3",
|
||||
"name": "jackspeak",
|
||||
"escapedName": "jackspeak",
|
||||
"rawSpec": "^2.0.3",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^2.0.3"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/glob"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-2.3.3.tgz",
|
||||
"_shasum": "95e4cbcc03b3eb357bf6bcce14a903fb3d1151e1",
|
||||
"_spec": "jackspeak@^2.0.3",
|
||||
"_where": "/mnt/c/Users/docto/Downloads/Rappaurio/node_modules/glob",
|
||||
"author": {
|
||||
"name": "Isaac Z. Schlueter",
|
||||
"email": "i@izs.me"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/isaacs/jackspeak/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"dependencies": {
|
||||
"@isaacs/cliui": "^8.0.2",
|
||||
"@pkgjs/parseargs": "^0.11.0"
|
||||
},
|
||||
"deprecated": false,
|
||||
"description": "A very strict and proper argument parser.",
|
||||
"devDependencies": {
|
||||
"@types/node": "^18.15.11",
|
||||
"@types/pkgjs__parseargs": "^0.10.0",
|
||||
"@types/tap": "^15.0.8",
|
||||
"c8": "^7.13.0",
|
||||
"eslint-config-prettier": "^8.8.0",
|
||||
"prettier": "^2.8.6",
|
||||
"tap": "^16.3.4",
|
||||
"ts-node": "^10.9.1",
|
||||
"typedoc": "^0.23.28",
|
||||
"typescript": "^5.0.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14"
|
||||
},
|
||||
"exports": {
|
||||
".": {
|
||||
"import": {
|
||||
"types": "./dist/mjs/index.d.ts",
|
||||
"default": "./dist/mjs/index.js"
|
||||
},
|
||||
"require": {
|
||||
"types": "./dist/cjs/index.d.ts",
|
||||
"default": "./dist/cjs/index.js"
|
||||
}
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/isaacs"
|
||||
},
|
||||
"homepage": "https://github.com/isaacs/jackspeak#readme",
|
||||
"keywords": [
|
||||
"argument",
|
||||
"parser",
|
||||
"args",
|
||||
"option",
|
||||
"flag",
|
||||
"cli",
|
||||
"command",
|
||||
"line",
|
||||
"parse",
|
||||
"parsing"
|
||||
],
|
||||
"license": "BlueOak-1.0.0",
|
||||
"main": "./dist/cjs/index.js",
|
||||
"module": "./dist/mjs/index.js",
|
||||
"name": "jackspeak",
|
||||
"optionalDependencies": {
|
||||
"@pkgjs/parseargs": "^0.11.0"
|
||||
},
|
||||
"prettier": {
|
||||
"semi": false,
|
||||
"printWidth": 75,
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"singleQuote": true,
|
||||
"jsxSingleQuote": false,
|
||||
"bracketSameLine": true,
|
||||
"arrowParens": "avoid",
|
||||
"endOfLine": "lf"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/isaacs/jackspeak.git"
|
||||
},
|
||||
"scripts": {
|
||||
"build-examples": "for i in examples/*.js ; do node $i -h > ${i/.js/.txt}; done",
|
||||
"format": "prettier --write . --loglevel warn",
|
||||
"postversion": "npm publish",
|
||||
"prepare": "tsc -p tsconfig.json && tsc -p tsconfig-esm.json && bash ./scripts/fixup.sh",
|
||||
"prepublishOnly": "git push origin --follow-tags",
|
||||
"presnap": "npm run prepare",
|
||||
"pretest": "npm run prepare",
|
||||
"preversion": "npm test",
|
||||
"snap": "c8 tap",
|
||||
"test": "c8 tap",
|
||||
"typedoc": "typedoc --tsconfig tsconfig-esm.json ./src/*.ts"
|
||||
},
|
||||
"tap": {
|
||||
"coverage": false,
|
||||
"node-arg": [
|
||||
"--no-warnings",
|
||||
"--loader",
|
||||
"ts-node/esm"
|
||||
],
|
||||
"ts": false
|
||||
},
|
||||
"types": "./dist/mjs/index.js",
|
||||
"version": "2.3.3"
|
||||
}
|
Reference in New Issue
Block a user