import {CLIInfoCommand} from 'projext/src/services/cli/cliInfo.js'

public class | source

CLIInfoCommand

CLICommand → CLIInfoCommand

This is the command used on the CLI to show the contents of the project configuration.

Constructor Summary

Public Constructor
public	constructor(appLogger: Logger, projectConfiguration: ProjectConfigurationSettings) Class constructor.

Public Members
public	appLogger: Logger A local reference for the `appLogger` service.
public	command: string The instruction needed to trigger the command.
public	description: string A description of the command for the help interface.
public	projectConfiguration: ProjectConfigurationSettings All the project settings.

Public Methods
public	handle(path: string) Handle the execution of the command and shows the project configuration.

From class CLICommand
public	allowUnknownOptions: Boolean Whether or not the command supports unknown options.
public	checkOptionsOnParent: boolean This is a useful flag for when the command is ran as a result of another command.
public	cliName: string This is the name of the program that runs the command.
public	command: string The CLI command instruction.
public	description: string A description of the command for the help interface.
public	fullDescription: string A more complete description of the command to show when the command help interface is invoked.
public	hidden: boolean Whether the command and its description should be shown on the CLI interface list of commands.
public	options: Array A list with the name of the options the command supports.
public	optionsByName: Object A dictionary of command options settings by their option name.
public	subProgram: boolean Whether or not a sub program should be executed for this command.
private	_unknownOptions: Object This dictionary will be completed when the command gets activated.
public	addOption(name: string, instruction: string, description: string, defaultValue: string) Add a new option for the command.
public	generate(args: Object): string Generate an instruction for this command.
public abstract	handle() Handle the command execution.
public	output(text: string) A simple wrapper for a `console.log`.
public	register(program: Command, cli: Object) Register this command on a CLI program.

Class constructor.

Name	Type	Attribute	Description
appLogger	Logger		To log the configuration on the console.
projectConfiguration	ProjectConfigurationSettings		To read the configuration.