import {CLICleanCommand} from 'projext/src/services/cli/cliClean.js'

public class | source

CLICleanCommand

CLICommand → CLICleanCommand

This is the command used on the CLI interface to remove a target file(s) or the entire distribution directory.

Constructor Summary

Public Constructor
public	constructor(builder: Builder, buildCleaner: BuildCleaner, targets: Targets) Class constructor.

Public Members
public	buildCleaner: BuildCleaner A local reference for the `buildCleaner` service function.
public	builder: Builder A local reference for the `builder` service function.
public	command: string The instruction needed to trigger the command.
public	description: string A description of the command for the help interface.
public	targets: Targets A local reference for the `targets` service function.

Public Methods
public	handle(name: string, command: Command, options: Object): Promise<undefined, Error> Handle the execution of the command.

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
builder	Builder		Needed to remove a target files.
buildCleaner	BuildCleaner		Needed to remove the distribution directory.
targets	Targets		To get the default target in case none is specified.

A local reference for the buildCleaner service function.

A local reference for the builder service function.

The instruction needed to trigger the command.

A description of the command for the help interface.

A local reference for the targets service function.

Handle the execution of the command.

Name	Type	Attribute	Description
name	string	nullable: true	The name of the target that will be removed from the distribution directory. If none is specified, it will fallback to the default target.
command	Command		The executed command (sent by `commander`).
options	Object		The commands options.
options.all	boolean		If this is `true`, instead of just removing the target files, the entire distribution directory will be deleted.