yargs / yargs/cliui

Expose more final types

Open
#131 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
395
Forks
44
Avg merge
6m
Merged PRs (30d)
3

Description

Though it is currently possibly to determine most types from the default export...

import cliui from 'cliui';

type UI = ReturnType<typeof cliui>;
type UIOptions = Parameters<typeof cliui>[0];

...these types are rather finicky. It would be great if more finalized types were exported from this package.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the package's default export and the TypeScript type inference examples in the issue. Identify which finalized public types are currently only reachable through ReturnType or Parameters, then verify that the intended types are exported directly and can be imported by consumers.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.