https://github.com/fuse-box/fuse-box-typechecker
https://github.com/fuse-box/fuse-box-typechecker
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fuse-box/fuse-box-typechecker
- Owner: fuse-box
- License: mit
- Created: 2017-03-03T20:59:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:41:02.000Z (over 3 years ago)
- Last Synced: 2024-04-24T13:10:28.536Z (over 2 years ago)
- Language: TypeScript
- Size: 1.16 MB
- Stars: 31
- Watchers: 4
- Forks: 8
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
##### NB! This is readme for 3.0.0 - vNext version
See [here for v2 docs](https://github.com/fuse-box/fuse-box-typechecker/tree/dee2380a88b66704299b1c2e3345d935ca21f651)
# 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
```js
import {pluginTypeChecker} from 'fuse-box-typechecker';
//under plugins
plugins:[pluginTypeChecker({
tsConfig: './src/tsconfig', // optional, uses fusebox tsconfig if else
name: 'Superman' // optional, uses "no-name" if missing
})]
```
#### As Standalone
```js
// get typechecker, se under options for more info
const typeChecker = require('fuse-box-typechecker').TypeChecker({
tsConfig: './tsconfig.json',
basePath: './',
name: 'checkerSync'
});
// to run it right away
typeChecker.printSettings();
typeChecker.inspectAndPrint();
// or just run watch, it will now run in own tread and wait for changes
typeChecker.worker_watch('./src');
// see public functions for more ways to use it
```
Emiting code
```js
const checker = require('fuse-box-type-checker').TypeChecker({
tsConfig: './tsconfig.json',
tsConfigOverride:{
"compilerOptions": {
"outDir": "testme/"
}
},
basePath: './',
name: 'checkerEmit'
});
checker.printSettings(); // optional
let result = checker.inspectOnly();
checker.printOnly(result); // optional...
result.oldProgram.emit();
```
---
#### Public functions
```ts
printSettings(): void;
inspectAndPrint(): number;
inspectOnly(oldProgram: ts.EmitAndSemanticDiagnosticsBuilderProgram): IResults;
printOnly(errors: IResults): number;
worker_watch(pathToWatch: string): void;
worker_kill(): void;
worker_inspect(): void;
worker_PrintSettings(): void;
worker_print(): void;
worker_inspectAndPrint(): void;
```
#### Options/interface info
```typescript
// options
interface ITypeCheckerOptionsInterface {
//config file (compared to basepath './tsconfig.json')
tsConfig: string;
// override tsconfig settings, does not override entire compilerOptions object, only parts you set
tsConfigOverride: Object
// base path to use
basePath: string;
// name, will be displayed when it runs, useful when you have more then 1 checker
name?: string;
// throw options
throwOnSyntactic?: boolean;
throwOnSemantic?: boolean;
throwOnGlobal?: boolean;
throwOnOptions?: boolean;
// use shortened filenames in order to make output less noisy
shortenFilenames?: boolean;
// skip ts errors
skipTsErrors?: number[];
// print settings
print_summary?: boolean; //default false
print_runtime?: boolean //default false
printFirstRun?: boolean //default false /plugin only
}
// result from inspect code, u need this to run print
export interface IResults {
oldProgram: ts.EmitAndSemanticDiagnosticsBuilderProgram;
optionsErrors: ts.Diagnostic[];
globalErrors: ts.Diagnostic[];
syntacticErrors: ts.Diagnostic[];
semanticErrors: ts.Diagnostic[];
elapsedInspectionTime: number;
}
```