Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commander-js/extra-typings
Infer strong typings for commander options and action handlers
https://github.com/commander-js/extra-typings
Last synced: 3 months ago
JSON representation
Infer strong typings for commander options and action handlers
- Host: GitHub
- URL: https://github.com/commander-js/extra-typings
- Owner: commander-js
- License: mit
- Created: 2022-08-13T03:38:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T02:28:02.000Z (6 months ago)
- Last Synced: 2024-08-15T21:11:33.762Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 363 KB
- Stars: 70
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# extra-typings for commander
[](https://www.npmjs.org/package/@commander-js/extra-typings)
[](https://npmcharts.com/compare/@commander-js/extra-typings?minimal=true)
This package offers TypeScript typings for `commander` which infer strong types for:
- all the parameters of the action handler, including the options
- options returned by `.opts()`
The runtime is supplied by commander. This package is all about the typings.
Usage
- install `@commander-js/extra-typings` using your preferred package manager
- install `commander`, if not already installed (peer dependency)
- in code import from `@commander-js/extra-typings` instead of `commander`
The installed version of this package should match the major and minor version numbers of the installed commander package, but the patch version number is independent (following pattern used by [Definitely Typed](https://github.com/DefinitelyTyped/DefinitelyTyped#how-do-definitely-typed-package-versions-relate-to-versions-of-the-corresponding-library)).
Credit: this builds on work by @PaperStrike in
## Limitations
- the generics lead to some noisy types visible in editor and errors
- some minor code changes required for subclasses of `Command`, `Argument`, or `Option` (see [subclass.test-d.ts](./tests/subclass.test-d.ts))
- chaining methods which do type inference return base class rather than `this`
- subclass of `Command` returns base class not subclass from `.command(name)`
- type parameter needed for class declaration of subclass of `Option` and `Argument`
## Usage tips
The types are built up as the options and arguments are defined. The usage pattern for action handlers is easy. Just chain the action handler after the options and arguments.
```typescript
import { program } from '@commander-js/extra-typings';
program.command('print')
.argument('')
.option('--double-sided')
.action((targetFile, options) => {
// command-arguments and options are fully typed
});
```
For working with a single command without an action handler, the configuration need to be done at the same time as the variable is declared.
```typescript
import { Command } from '@commander-js/extra-typings';
// broken pattern
const program = new Command(); // program type does not include options or arguments
program.option('-d, --debug'); // adding option does not change type of program
const options = program.opts(); // dumb type
```
```typescript
import { Command } from '@commander-js/extra-typings';
// working pattern
const program = new Command()
.option('-d, --debug'); // program type includes chained options and arguments
const options = program.opts(); // smart type
```
Use a "const assertion" on the choices to narrow the option type from `string`:
```typescript
const program = new Command()
.addOption(new Option('--drink-size ').choices(['small', 'medium', 'large'] as const))
.parse();
const drinkSize = program.opts().drinkSize; // "small" | "medium" | "large" | undefined
```