NB! This is readme for 3.0.0 - vNext version

See here for v2 docs

fuse-box-typechecker 3.0.0

Simple helper to do typechecking You need to install newest typescript to use this.

npm install fuse-box-typechecker

Output sample with all options enabled

---

How to load and configure

As plugin for fusebox v4

1import {pluginTypeChecker} from 'fuse-box-typechecker';
2
3
4//under plugins
5    plugins:[pluginTypeChecker({
6        tsConfig: './src/tsconfig', // optional, uses fusebox tsconfig if else
7        name: 'Superman' // optional, uses "no-name" if missing
8    })]
9

As Standalone

1// get typechecker, se under options for more info
2const typeChecker = require('fuse-box-typechecker').TypeChecker({
3    tsConfig: './tsconfig.json',
4    basePath: './',
5    name: 'checkerSync'
6});
7
8
9// to run it right away
10typeChecker.printSettings();
11typeChecker.inspectAndPrint();
12
13// or just run watch, it will now run in own tread and wait for changes
14typeChecker.worker_watch('./src');
15
16
17// see public functions for more ways to use it
18
19
20

Emiting code

1const checker = require('fuse-box-type-checker').TypeChecker({
2    tsConfig: './tsconfig.json',
3    tsConfigOverride:{
4        "compilerOptions": {
5            "outDir": "testme/"
6        }
7    },
8    basePath: './',
9    name: 'checkerEmit'
10});
11checker.printSettings(); // optional
12let result = checker.inspectOnly();
13checker.printOnly(result); // optional...
14result.oldProgram.emit();

---

Public functions

1printSettings(): void;
2inspectAndPrint(): number;
3inspectOnly(oldProgram: ts.EmitAndSemanticDiagnosticsBuilderProgram): IResults;
4printOnly(errors: IResults): number;
5worker_watch(pathToWatch: string): void;
6worker_kill(): void;
7worker_inspect(): void;
8worker_PrintSettings(): void;
9worker_print(): void;
10worker_inspectAndPrint(): void;
11

Options/interface info

1
2
3// options
4interface ITypeCheckerOptionsInterface {
5    //config file (compared to basepath './tsconfig.json')
6    tsConfig: string; 
7
8    
9    // override tsconfig settings, does not override entire compilerOptions object, only parts you set
10    tsConfigOverride: Object 
11       
12    
13    // base path to use
14    basePath: string; 
15    
16    
17    // name, will be displayed when it runs, useful when you have more then 1 checker
18    name?: string; 
19
20    // throw options
21    throwOnSyntactic?: boolean;
22    throwOnSemantic?: boolean;
23    throwOnGlobal?: boolean;
24    throwOnOptions?: boolean;  
25    
26    // use shortened filenames in order to make output less noisy
27    shortenFilenames?: boolean; 
28    
29    // skip ts errors
30    skipTsErrors?: number[];
31
32    // print settings
33    print_summary?: boolean; //default false
34    print_runtime?: boolean //default false
35    printFirstRun?: boolean //default false  /plugin only
36    
37}
38
39// result from inspect code, u need this to run print
40export interface IResults {
41    oldProgram: ts.EmitAndSemanticDiagnosticsBuilderProgram;
42    optionsErrors: ts.Diagnostic[];
43    globalErrors: ts.Diagnostic[];
44    syntacticErrors: ts.Diagnostic[];
45    semanticErrors: ts.Diagnostic[];
46    elapsedInspectionTime: number;
47}