Class DumpImports

A tool that dumps the import graph of the given compilation unit.

Hierarchy (view full)

Tool<DumpImportGraphOptions>
- DumpImports

Index

Constructors

Properties

Accessors

defaultOptions id

Methods

getDescription getOptionDescriptions makeOutput run

Constructors

constructor

new DumpImports(ctx, config): DumpImports
Parameters
- ctx: MistiContext
- config: DumpImportGraphOptions
Returns DumpImports
Inherited from Tool.constructor
- Defined in src/tools/tool.ts:16

Properties

`Readonly`ctx

ctx: MistiContext

`Protected` `Readonly`options

options: DumpImportGraphOptions

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

Accessors

defaultOptions

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

Returns DumpImportGraphOptions
Overrides Tool.defaultOptions
- Defined in src/tools/dumpImports.ts:25

id

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

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

Methods

getDescription

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

Returns string
Overrides Tool.getDescription
- Defined in src/tools/dumpImports.ts:54

getOptionDescriptions

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

Returns Record<keyof DumpImportGraphOptions, string>
Overrides Tool.getOptionDescriptions
- Defined in src/tools/dumpImports.ts:58

`Protected`makeOutput

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

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.
Overrides Tool.run
- Defined in src/tools/dumpImports.ts:32