Merge pull request #27 from vegarringdal/master

v2.3.3

Author: vegarringdal

README.md

@@ -76,7 +76,7 @@ doTypeCheck();
 
 
 ```typescript
-interface OptionsInterface {
+interface IOptionsInterface {
     tsConfig: string; //config file (compared to basepath './tsconfig.json')
     throwOnSyntactic?: boolean; // if you want it to throwe error
     throwOnSemantic?: boolean; // if you want it to throwe error
@@ -86,7 +86,7 @@ interface OptionsInterface {
     basePath: string; // base path to use
     name?: string; // name, will be displayed when it runs, useful when you have more then 1
     tsLint: string; // config file (compared to basepath './tslint.json')
-    lintoptions? LintOptions; // see below, optional
+    lintoptions? ILintOptions; // see below, optional
     yellowLint?: boolean; // use yellow color instead of red on TSLint errors
     yellowOnOptions?: boolean; // use yellow color instead of red on Options errors
     yellowOnGlobal?: boolean; // use yellow color instead of red on Global errors
@@ -95,7 +95,7 @@ interface OptionsInterface {
 }
 
 
-interface LintOptions {
+interface ILintOptions {
     fix?: boolean; // default is false
     formatter?: string; //JSON, can not be edited
     formattersDirectory?: string; //default is null

dist/commonjs/checker.d.ts

@@ -1,12 +1,12 @@
-import { InternalTypeCheckerOptions } from './interfaces';
+import { IInternalTypeCheckerOptions } from './interfaces';
 export declare class Checker {
     private options;
     private program;
     private elapsedInspectionTime;
     private tsDiagnostics;
     private lintFileResult;
     constructor();
-    inspectCode(options: InternalTypeCheckerOptions): void;
+    inspectCode(options: IInternalTypeCheckerOptions): void;
     printResult(isWorker?: boolean): number;
     private writeText(text);
     private processLintFiles();

dist/commonjs/checker.js.map

@@ -1,12 +1,12 @@
-import { TypeCheckerOptions } from './interfaces';
+import { ITypeCheckerOptions } from './interfaces';
 export declare class TypeHelperClass {
     private options;
     private worker;
     private checker;
     private monitor;
     private watchTimeout;
     private isWorkerInspectPreformed;
-    constructor(options: TypeCheckerOptions);
+    constructor(options: ITypeCheckerOptions);
     runAsync(): void;
     runSync(): number;
     runPromise(): Promise<number>;
@@ -18,4 +18,4 @@ export declare class TypeHelperClass {
     private writeText(text);
     private getPath(usePath);
 }
-export declare const TypeHelper: (options: TypeCheckerOptions) => TypeHelperClass;
+export declare const TypeHelper: (options: ITypeCheckerOptions) => TypeHelperClass;

dist/commonjs/index.d.ts

@@ -1,4 +1,4 @@
-export interface TypeCheckerOptions {
+export interface ITypeCheckerOptions {
     basePath: string;
     tsConfig: string;
     throwOnSyntactic?: boolean;
@@ -13,22 +13,22 @@ export interface TypeCheckerOptions {
     yellowOnSyntactic?: boolean;
     tsLint?: string;
     name?: string;
-    lintoptions?: LintOptions;
+    lintoptions?: ILintOptions;
 }
-export interface LintOptions {
+export interface ILintOptions {
     fix?: boolean;
     formatter?: string;
     formattersDirectory?: string | null;
     rulesDirectory?: string | null;
 }
-export interface InternalTypeCheckerOptions extends TypeCheckerOptions {
+export interface IInternalTypeCheckerOptions extends ITypeCheckerOptions {
     type: TypecheckerRunType;
     tsConfigJsonContent?: any;
     quit?: boolean;
 }
 export interface IWorkerOptions {
     type: WorkerCommand;
-    options?: InternalTypeCheckerOptions;
+    options?: IInternalTypeCheckerOptions;
 }
 export declare enum WorkerCommand {
     inspectCode = 0,

dist/commonjs/index.js.map

@@ -2,13 +2,13 @@ import * as ts from 'typescript';
 import * as chalk from 'chalk';
 import * as tslint from 'tslint';
 import * as path from 'path';
-import { InternalTypeCheckerOptions, END_LINE } from './interfaces';
+import { IInternalTypeCheckerOptions, END_LINE } from './interfaces';
 
 
 export class Checker {
 
     // options that will be used when checking and printing results
-    private options: InternalTypeCheckerOptions;
+    private options: IInternalTypeCheckerOptions;
 
     // typescript program
     private program: ts.Program;
@@ -28,7 +28,7 @@ export class Checker {
     }
 
 
-    public inspectCode(options: InternalTypeCheckerOptions) {
+    public inspectCode(options: IInternalTypeCheckerOptions) {
         this.options = options;
 
 

dist/commonjs/interfaces.d.ts

@@ -2,23 +2,23 @@
 
 import * as child from 'child_process';
 import * as path from 'path';
-import { LintOptions, TypeCheckerOptions, WorkerCommand, TypecheckerRunType, InternalTypeCheckerOptions } from './interfaces';
+import { ILintOptions, ITypeCheckerOptions, WorkerCommand, TypecheckerRunType, IInternalTypeCheckerOptions } from './interfaces';
 import { Checker } from './checker';
 import * as watch from 'watch';
 import * as ts from 'typescript';
 import * as chalk from 'chalk';
 
 
 export class TypeHelperClass {
-    private options: TypeCheckerOptions;
+    private options: ITypeCheckerOptions;
     private worker: child.ChildProcess;
     private checker: Checker;
     private monitor: any;
     private watchTimeout: NodeJS.Timer;
     private isWorkerInspectPreformed: boolean;
 
 
-    constructor(options: TypeCheckerOptions) {
+    constructor(options: ITypeCheckerOptions) {
         this.checker = new Checker();
         this.options = options;
 
@@ -31,7 +31,7 @@ export class TypeHelperClass {
 
         // tslint options
         let lintOp = this.options.lintoptions;
-        this.options.lintoptions = lintOp ? lintOp : ({} as LintOptions);
+        this.options.lintoptions = lintOp ? lintOp : ({} as ILintOptions);
 
         // fix tslint options so tslint do not complain
         this.options.lintoptions = {
@@ -43,7 +43,7 @@ export class TypeHelperClass {
 
         // get tsconfig path and options
         let tsconf = this.getPath(options.tsConfig);
-        (<InternalTypeCheckerOptions>this.options).tsConfigJsonContent = require(tsconf);
+        (<IInternalTypeCheckerOptions>this.options).tsConfigJsonContent = require(tsconf);
         this.writeText(chalk.yellow(`Typechecker tsconfig: ${chalk.white(`${tsconf}${'\n'}`)}`));
 
         // get tslint path and options
@@ -62,7 +62,7 @@ export class TypeHelperClass {
     public runAsync(): void {
 
         // set options, add if it need to quit and run type
-        let options: InternalTypeCheckerOptions = Object.assign(this.options, { quit: true, type: TypecheckerRunType.async });
+        let options: IInternalTypeCheckerOptions = Object.assign(this.options, { quit: true, type: TypecheckerRunType.async });
 
         // create thread
         this.createThread();
@@ -82,7 +82,7 @@ export class TypeHelperClass {
     public runSync(): number {
 
         // set options, add if it need to quit and run type
-        let options: InternalTypeCheckerOptions = Object.assign(this.options, { quit: true, type: TypecheckerRunType.sync });
+        let options: IInternalTypeCheckerOptions = Object.assign(this.options, { quit: true, type: TypecheckerRunType.sync });
 
         // inspect our code
         this.checker.inspectCode(options);
@@ -105,7 +105,7 @@ export class TypeHelperClass {
             try {
 
                 // set options, add if it need to quit and run type
-                let options: InternalTypeCheckerOptions = Object.assign(this.options, { quit: true, type: TypecheckerRunType.promiseSync });
+                let options: IInternalTypeCheckerOptions = Object.assign(this.options, { quit: true, type: TypecheckerRunType.promiseSync });
 
                 // inspect our code
                 this.checker.inspectCode(options);
@@ -130,7 +130,7 @@ export class TypeHelperClass {
     public runWatch(pathToWatch: string): void {
 
         // set options, add if it need to quit and run type
-        let options: InternalTypeCheckerOptions = Object.assign(this.options, { quit: false, type: TypecheckerRunType.watch });
+        let options: IInternalTypeCheckerOptions = Object.assign(this.options, { quit: false, type: TypecheckerRunType.watch });
 
         // const
         const write = this.writeText;
@@ -218,7 +218,7 @@ export class TypeHelperClass {
      * Configure worker, internal function
      *
      */
-    private inspectCodeWithWorker(options: TypeCheckerOptions): void {
+    private inspectCodeWithWorker(options: ITypeCheckerOptions): void {
         this.worker.send({ type: WorkerCommand.inspectCode, options: options });
 
         // we set this so we can stop worker print from trying to run
@@ -296,7 +296,7 @@ export class TypeHelperClass {
 }
 
 // return new typechecker
-export const TypeHelper = (options: TypeCheckerOptions): TypeHelperClass => {
+export const TypeHelper = (options: ITypeCheckerOptions): TypeHelperClass => {
     return new TypeHelperClass(options);
 };
 

dist/commonjs/interfaces.js.map

@@ -1,6 +1,6 @@
 
 // options they can use to create the typechecker
-export interface TypeCheckerOptions {
+export interface ITypeCheckerOptions {
     // base path
     basePath: string;
 
@@ -29,19 +29,19 @@ export interface TypeCheckerOptions {
 
     // lint options that can be passed in
     // todo: rename to lintOptions, but thats a breaking change, so will do that later
-    lintoptions?: LintOptions;
+    lintoptions?: ILintOptions;
 }
 
 // lint options,this is the same as tsLint uses all paths will be from basepath
-export interface LintOptions {
+export interface ILintOptions {
     fix?: boolean;
     formatter?: string;
     formattersDirectory?: string | null;
     rulesDirectory?: string | null;
 }
 
 // extended internal options, needed for some interal usage
-export interface InternalTypeCheckerOptions extends TypeCheckerOptions {
+export interface IInternalTypeCheckerOptions extends ITypeCheckerOptions {
     type: TypecheckerRunType;
     tsConfigJsonContent?: any;
     quit?: boolean;
@@ -50,7 +50,7 @@ export interface InternalTypeCheckerOptions extends TypeCheckerOptions {
 // params used when calling worker to tell it what to do
 export interface IWorkerOptions {
     type: WorkerCommand;
-    options?: InternalTypeCheckerOptions;
+    options?: IInternalTypeCheckerOptions;
 }
 
 // run options for worker