Class Tool<T>`Abstract`

A tool that can be used to extend the functionality of Misti.

Type Parameters

T extends Record<string, unknown>

Hierarchy (view full)

Tool

Index

Constructors

Properties

Accessors

defaultOptions id

Methods

getDescription getOptionDescriptions makeOutput run

Constructors

constructor

new Tool<T>(ctx, config): Tool<T>
Type Parameters
- T extends Record<string, unknown>
Parameters
- ctx: MistiContext
- config: T
Returns Tool<T>
- Defined in src/tools/tool.ts:16

Properties

`Readonly`ctx

ctx: MistiContext

`Protected` `Readonly`options

options: T

User-defined options for the tool merged with the default options.

Accessors

`Abstract`defaultOptions

get defaultOptions(): T
The default options for the tool.

Returns T
- Defined in src/tools/tool.ts:33

id

get id(): string
The unique identifier of the tool.

Returns string
- Defined in src/tools/tool.ts:26

Methods

`Abstract`getDescription

getDescription(): string
Returns a description of the tool and its options.

Returns string
- Defined in src/tools/tool.ts:66

`Abstract`getOptionDescriptions

getOptionDescriptions(): Record<keyof T, string>
Returns a map of option names to their descriptions.

Returns Record<keyof T, string>
- Defined in src/tools/tool.ts:71

`Protected`makeOutput

makeOutput(cu, output): ToolOutput
Makes a ToolOutput from the given output.
Parameters
- cu: CompilationUnit
- output: string
Returns ToolOutput
- Defined in src/tools/tool.ts:55

`Abstract`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.
- Defined in src/tools/tool.ts:50