feat: add generics to OptionValues

[tyankatsu0105]

Pull Request

Problem

close #1536

Solution

TypeScript typings

• add generics to OptionValues
• add default generics to storeOptionsAsProperties and opts method

ChangeLog

[shadowspawn]

This looks like it is functional, but I want to experiment a bit. I 'm not expert with generics and the current signatures don't give the cues I expect. The any looks a bit odd here:

opts<T = any>(): OptionValues<T>;

Example usage:

const options1 = program.opts(); // weakly typed
const options2 = program.opts<MyOptionValues>(); // strongly typed, added by this PR

program.action((options: commander.OptionValue) => {}); // convenience for weakly typed param

[shadowspawn]

How about this? The extends is a sanity check that the passed type is a hash/dictionary.

interface OptionValues {
  [key: string]: any;
}

opts<T extends OptionValues = OptionValues>(): T;

[tyankatsu0105]

Wow. Looks better than my PR.
I take your advice and will change the code.

[tyankatsu0105]

done
@shadowspawn thanks for your kind advice :)

[shadowspawn]

Oh, even tidier with not needing to specify default. 😄

[shadowspawn]

Suggested tests for index.test-d.ts with the // opts tests.

interface MyCheeseOption {
  cheese: string;
}
const myCheeseOption = program.opts<MyCheeseOption>();
expectType<string>(myCheeseOption.cheese);
// @ts-expect-error Check that options strongly typed and does not allow arbitrary properties
expectType(myCheeseOption.foo);

[shadowspawn]

The next release will be based on release/8.x branch, and the typings have had a refactor causing merge conflicts. Might be easiest to make a new branch from release/8.x and redo PR (or copy-down and resolve conflicts if you prefer).

I don't mind sorting it out though, so optional for you to change the base branch.

[shadowspawn]

LGTM

[shadowspawn]

Reminder to self: don't merge onto develop branch

[shadowspawn]

PR moved to #1539