Class CompilerCommand

Namespace

Dassie.Extensions

Assembly

dc.dll

Provides an abstract base class for commands implementing ICompilerCommand.

public abstract class CompilerCommand : ICompilerCommand

Inheritance

object

CompilerCommand

Implements

ICompilerCommand

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectDump.Dump(object)

Properties

Aliases

A list of alternative command names.

public virtual List<string> Aliases { get; }

Property Value

List<string>

Command

The name used to invoke the command in the console.

public abstract string Command { get; }

Property Value

string

Description

A short description of the command.

public abstract string Description { get; }

Property Value

string

HelpDetails

Represents the information displayed on the command's help page.

public virtual CommandHelpDetails HelpDetails { get; }

Property Value

CommandHelpDetails

Returns null by default.

Options

Advanced options for the command within the command loading system.

public virtual CommandOptions Options { get; }

Property Value

CommandOptions

The options specified for the command.

Role

Specifies the role of the command.

public virtual CommandRole Role { get; }

Property Value

CommandRole

Methods

Invoke(string[])

The method that is executed when the command is invoked.

public abstract int Invoke(string[] args)

Parameters

args string[]

Command-line arguments passed to the command, excluding the command name itself.

Returns

int

The exit code.