Yargs Typescript CommandModule Generics

my-command.ts

import { CommandModule, Argv, Options, ArgumentsCamelCase } from 'yargs'

export interface MyOptions extends Options {
  interactive: boolean
  env: string
  color: string
}

export class MyCommand<U extends MyOptions> implements CommandModule<{}, U> {
  public command = 'my-cmd'
  public describe = 'Just a simple generics example'

  public builder = (args: Argv): Argv<U> => {
    args.option('interactive', { boolean: true, alias: 'i', describe: 'get interactive with it!' })
    args.option('env', { string: true, alias: 'e', describe: 'Environment' })
    args.option('color', { boolean: true, describe: 'disable color', default: true })
    return args as unknown as Argv<U>
  }

  public handler = async (args: ArgumentsCamelCase<U>) => {

    // type hinting works with the following!
    console.log(
      args.color,
      args.env,
      args.interactive
    )
  }
}

I spent way too much time trying to figure this out. This simple version on how to get type hinting working using yargs Typescript generics.

See my screen shot on the type hinting in vscode.

This was a lifesaver... 👍

Thank you!

import { CommandModule, Arguments, Argv } from 'yargs';

interface CommandArgs {
  arg?: string;
}

export class ConfigureCommand implements CommandModule {
  public command = '';
  public describe = '';

  public builder(args: Argv): Argv<CommandArgs> {
    return args.positional('arg', {
      describe: 'Hello world!',
      type: 'string',
    });
  }

  public handler(argv: Arguments<CommandArgs>) {
    console.log(argv);
  }
}

or

import { CommandModule, Arguments, Argv } from 'yargs';

interface CommandArgs {
  arg?: string;
}

export class ConfigureCommand implements CommandModule<{}, CommandArgs> {
  public command = '';

  public describe = '';

  public builder(args: Argv<{}>) {
    return args.positional('arg', {
      describe: 'Hello world!',
      type: 'string',
    });
  }

  public handler(argv: Arguments<CommandArgs>) {
    console.log(argv);
  }
}