burgee/yargs/parser
burgee/yargs/parser is a drop-in for yargs-parser: the same API, documented by yargs-parser itself. Every name it exports, and where its reference lives.
burgee/yargs/parser is a drop-in for yargs-parser, graded by the incumbent's own test suite. Its API is the incumbent's, so its reference is the incumbent's own documentation.
- Reference: yargs-parser 22.0.0, the release that suite is run at.
- How closely it matches: Compatibility, that suite's result in CI, with every case left out of the gate and the reason.
- Side by side: burgee vs yargs.
- Moving a program over:
burgee migraterewrites'yargs-parser'to'burgee/yargs/parser'across a project.
Exports
Every name burgee/yargs/parser exports, as the built declarations state them. Signatures and behaviour are yargs-parser's.
| Export | Kind |
|---|---|
default | const |
camelCase | function |
decamelize | function |
looksLikeNumber | function |
tokenizeArgString | function |
YargsParser | class |
module.exports | const |
Parser | const |
Arguments | interface |
DetailedArguments | interface |
ParserMixin | interface |
Configuration | type |
Options | type |
burgee/yargs/helpers
burgee/yargs/helpers is a drop-in for yargs/helpers: the same API, documented by yargs itself. Every name it exports, and where its reference lives.
The floor
The requirements every CLI on burgee meets, and who holds each — runtime, lint, or both. 74 of the floor's 114 are tabled here.