API

nest-commander

Commander Decorators

@Command()

This class decorator is pretty much what everything else in this package relies on existing. This is the decorator that sets up the sub commands for the application that are to be consumed.

@RootCommand()

Just like @Command() except without the name property, and can only be used once per application.

@Option()

This method decorator allows for users to pass in extra options for commands defined with @Command(). These options allow for the program to act in slightly different, yet predictable ways.

@OptionChoicesFor()

This method decorator allows you to get chocies for an @Option() in a dynamic manner rather than hard coding them into the @Option() decorator. The method this decorator decorates should return a string array of options.

@Help()

This method decorator allows you to add custom help text for your command in a specified position with respect to the original help text

Help(position: 'before' | 'beforeAll' | 'after' | 'afterAll'): MethodDecorator

InquirerService

ask<T>

An asynchronous command to allow for getting user input based on existing options from commander and the name of a question set.

ask<T>(name: string, options: Partial<T> | undefined): Promise<T>
// The following is just an alias for the above
prompt<T>(name: string, options: Partial<T> | undefined): Promise<T>

Inquirer Decorators

@QuestionSet()

This class decorator allows for the setup of a set of questions to ask.

@Question()

This method decorator allows for creating questions to ask the user. For information on each specific kind of question, Inquirer’s docs should be consulted.

* The property itself is not required, but there must be a value for this, whether through dynamic decorator or the @Question() decorator.

@ValidateFor()

This method decorator allows a user to define a dynamic value for inquirer’s validate option for the named question. The method this decorator decorates takes in the user input and answer hashes and returns a boolean.

@TransformFor()

This method decorator allows a user to define a dynamic value for inquirer’s transform option for the named question. The method this decorator decorates takes in the user input, answer hashes, and option flags and returns the input after transformation. This transformation does not impact what is returned by Inquirer, only what is shown back to the user.

@WhenFor()

This method decorator allows a user to define a dynamic value for inquirer’s when option for the named question. The method this decorator decorates takes in the answer hashes and returns a boolean for if the question should be shown or not.

@MessageFor()

This method decorator allows a user to define a dynamic value for inquirer’s message option for the named question. The method this decorator decorates takes in the current set of answers and returns a string.

@ChoicesFor()

This method decorator allows a user to define a dynamic value for inquirer’s choices option for the named question. The method this decorator decorates takes in the current answer hashes and returns an array of choices. These choices can be an array of string, number, or objects containing a name, value, and short. The choices array can also contain a separator which can be read about in Inquirer’s docs.

@DefaultFor()

This method decorator allows a user to define a dynamic value for inquirer’s default option for the named question. The method this decorator decorates takes in the current hash of answers and returns a number, string, or boolean.

CliUtilityService

parseBoolean

A helper method to turn a string into a boolean based on true or false values.

parseInt

A Simple wrapper around Number.parseInt()

parseFloat

A simple wrapper around Number.parseFloat()

CommandFactory

run

A static method that kicks off the command and manages the Nest application lifecycle.

CommandFactory.run(rootModule: Type<any>, optionsOrLogger?: CommandFactoryRunOptions | NestLogger): Promise<void>

runWithoutClosing

The same static method as above, but without handling the closing of the Nest application when the command finishes. This is to allow the setup of things like file watchers or pollers.

CommandFactoryRunOptions

Options that can be passed to the run or runWithoutClosing method to modify the behavior.

CommandRunner

The CommandRunner is abstract class to define your command. You define the command in the class inherits it.

registerWithSubCommands

A static method that returns a list of the root command class, which calls this api, and all sub command classes set via the metadata of the @Command() and @SubCommand() decorators in the scope of module tree that the root command class traverses.

@Module({
  providers: [...RunCommand.registerWithSubCommands()]
})
export class AppModule {}

@RequestModule()

A wrapper decorator for Nest’s @Module() that exposes a way to set a request object mock for the REQUEST injection token.

@RequestModule({
  providers: [SomeCommand],
  requestObject: { headers: { Authorization: 'Bearer token' } }
})
export class SomeCommandModule {}

nest-commander-testing

CommandTestFactory

createTestingCommand

Similar to @nestjs/testing’s createTestingModule, this static method sets up a TestingModuleBuilder that can be used with Nest’s overrideProvider and compile methods for creating a TestingModule.

CommandFactory.createTestingCommand(moduleMetadata: CommandModuleMetadata): TestingModuleBuilder

run

Similar to CommandFactory.run but to be used within a test instance.

CommandTestFactory.run(app: TestingModule, args?: string[]): Promise<void>

setAnswers

A command to mock the gathering of information from a user, to help with automated testing.

CommandFactory.setAnswers(value: any | any[]): void

useDefaultInquirer

A method to sub back in the regular Inquirer instance instead of the mock used for testing. If this is used, the setAnswers will have no effect, and stdin data must be passed manually

CommandFactory.useDefaultInquirer(): typeof CommandTestFactory