Class ResultAnalyzer

Analyzes compilation results and provides diagnostic information

Remarks

This class processes TypeScript compilation results and provides methods to analyze diagnostics, access compiler options, and retrieve source and output files.

Example

const compiler = new Compiler(['src/file.ts'], options);
const result = compiler.emit();
const analyzer = new ResultAnalyzer(result);
const diagnostics = analyzer.diag();

if (diagnostics.hasErrors) {
  console.error(diagnostics.formatted);
}

Index

Constructors

constructor

new ResultAnalyzer(result: CompilerResult): ResultAnalyzer
Creates a new ResultAnalyzer instance
Parameters
- result: CompilerResult
  The compilation result to analyze
Returns ResultAnalyzer
- Defined in src/result-analyzer.ts:61

Accessors

comments

get comments(): IFoundComment[]
Returns IFoundComment[]
- Defined in src/result-analyzer.ts:85

compilerOptions

get compilerOptions(): CompilerOptions
Gets the compiler options used in the compilation

Returns CompilerOptions
The TypeScript compiler options

Link
https://stackoverflow.com/questions/53804566/how-to-get-compileroptions-from-tsconfig-json
- Defined in src/result-analyzer.ts:72

outputFiles

get outputFiles(): string[]
Gets the paths of all emitted (output) files

Returns string[]
Array of output file paths
- Defined in src/result-analyzer.ts:94

sourceFiles

get sourceFiles(): readonly SourceFile[]
Gets all source files included in the compilation

Returns readonly SourceFile[]
Array of TypeScript source files

Link
https://stackoverflow.com/questions/45796878/how-to-get-all-sources-for-imported-files-with-typescript-compiler-api
- Defined in src/result-analyzer.ts:81

Methods

diag

diag(): DiagResult
Analyzes compilation diagnostics and returns detailed results

Returns DiagResult
A DiagResult object containing diagnostic information

Remarks
This method processes both emit diagnostics and pre-emit diagnostics, categorizing them into errors and warnings. It also provides a formatted string representation of all diagnostics with color and context.

Link
https://github.com/microsoft/TypeScript-wiki/blob/main/Using-the-Compiler-API.md
- Defined in src/result-analyzer.ts:111

Class ResultAnalyzer

Remarks

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ResultAnalyzer

Accessors

comments

Returns IFoundComment[]

compilerOptions

Returns CompilerOptions

Link

outputFiles

Returns string[]

sourceFiles

Returns readonly SourceFile[]

Link

Methods

diag

Returns DiagResult

Remarks

Link

Settings

On This Page