Class Tool<T>Abstract

constructor

• new Tool<T>(ctx, config): Tool<T>

• Type Parameters

  • T extends Record<string, unknown>

  Parameters

  • ctx: MistiContext
  • config: T

  Returns Tool<T>

Readonlyctx

AbstractdefaultOptions

• get defaultOptions(): T

• The default options for the tool.

  Returns T

id

• get id(): string

• The unique identifier of the tool.

  Returns string

AbstractgetDescription

• getDescription(): string

• Returns a description of the tool and its options.

  Returns string

AbstractgetOptionDescriptions

• getOptionDescriptions(): Record<keyof T, string>

• Returns a map of option names to their descriptions.

  Returns Record<keyof T, string>

run

• run(cu): ToolOutput

• Runs the tool on the given compilation unit.

  Parameters

  • cu: CompilationUnit

    The compilation unit to run the tool on.

  Returns ToolOutput

  The result of the tool.

runStandalone

• runStandalone(): ToolOutput

• Runs the tool without any compilation unit.

  Returns ToolOutput

  The result of the tool.

StaticcanRunStandalone

• canRunStandalone(tool): boolean

• Tests if the Tool could be executed without compilation unit using runStandalone.

  Parameters

  • tool: Tool<any>

  Returns boolean