egoist/tinyargs

Better TypeScript support

Open

#2 opened on Dec 13, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (2 forks)user submission
help wanted

Repository metrics

Stars
 (76 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently the return object is typed as Record<string, any>, ideally it should infer types based on options:

parse([], [{ name:'foo', type: Boolean }, { name: 'bar', type: String, optionalValue: true }])

//=> { foo?: boolean, bar?: string | true }

Contributor guide

Research direction
Look at how the options are defined and find a way to use TypeScript generics and conditional types to infer the return type. Study existing type definitions in similar CLI parsers like yargs or commander.
Tech stack
typescriptnodejsdeno
Domain
clibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65