Class DumpConfig

A tool that dumps the Misti configuration file in use.

Hierarchy (view full)

Tool<DumpConfigOptions>
- DumpConfig

Index

Constructors

Properties

Accessors

defaultOptions id

Methods

getDescription getOptionDescriptions makeOutput run runStandalone runWithCU canRunStandalone

Constructors

constructor

new DumpConfig(ctx, config): DumpConfig
Parameters
- ctx: MistiContext
- config: DumpConfigOptions
Returns DumpConfig
Inherited from Tool.constructor
- Defined in src/tools/tool.ts:18

Properties

`Readonly`ctx

ctx: MistiContext

`Protected` `Readonly`options

options: DumpConfigOptions

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

Accessors

defaultOptions

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

Returns DumpConfigOptions
Overrides Tool.defaultOptions
- Defined in src/tools/dumpConfig.ts:11

id

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

Returns string
Inherited from Tool.id
- Defined in src/tools/tool.ts:28

Methods

getDescription

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

Returns string
Overrides Tool.getDescription
- Defined in src/tools/dumpConfig.ts:19

getOptionDescriptions

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

Returns Record<string, string>
Overrides Tool.getOptionDescriptions
- Defined in src/tools/dumpConfig.ts:23

`Protected`makeOutput

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

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.
Inherited from Tool.run
- Defined in src/tools/tool.ts:52

runStandalone

runStandalone(): ToolOutput
Runs the tool without any compilation unit.

Returns ToolOutput
The result of the tool.
Overrides Tool.runStandalone
- Defined in src/tools/dumpConfig.ts:15

`Protected`runWithCU

runWithCU(_): ToolOutput
Implement this method if your tool needs a compilation unit.
Parameters
- _: CompilationUnit
Returns ToolOutput
Inherited from Tool.runWithCU
- Defined in src/tools/tool.ts:70

`Static`canRunStandalone

canRunStandalone(tool): boolean
Tests if the Tool could be executed without compilation unit using runStandalone.
Parameters
- tool: Tool<any>
Returns boolean
Inherited from Tool.canRunStandalone
- Defined in src/tools/tool.ts:103