Export main plugin class and update all imports ? = require(?) to named exports (TypeStrong#163)

* export main plugin class and update all imports ? = require(?) to named exports

* add commonjs export

* revert export back to the original state

* update version and changelog

Author: milewski

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.4.10
+
+* [Allow fork-ts-checker-webpack-plugin to be imported in .ts files using ESM import syntax](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/163) (#163)
+
 ## v0.4.9
 
 * [Set "compilationDone" before resolving "forkTsCheckerServiceBeforeStart"](https://github.com/Realytics/fork-ts-checker-webpack-plugin/pull/146) (#146)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fork-ts-checker-webpack-plugin",
-  "version": "0.4.9",
+  "version": "0.4.10",
   "description": "Runs typescript type checker and linter on separate process.",
   "main": "lib/index.js",
   "types": "lib/types/index.d.ts",

src/CancellationToken.ts

@@ -1,15 +1,15 @@
-import crypto = require('crypto');
-import fs = require('fs');
-import os = require('os');
-import path = require('path');
-import ts = require('typescript');
+import * as crypto from 'crypto';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import * as ts from 'typescript';
 
 interface CancellationTokenData {
   isCancelled: boolean;
   cancellationFileName: string;
 }
 
-class CancellationToken {
+export class CancellationToken {
   isCancelled: boolean;
   cancellationFileName: string;
   lastCancellationCheckTime: number;
@@ -72,5 +72,3 @@ class CancellationToken {
     }
   }
 }
-
-export = CancellationToken;

src/FilesRegister.ts

@@ -1,12 +1,12 @@
-import ts = require('typescript');
+import * as ts from 'typescript';
 
 interface DataShape {
   source: ts.SourceFile;
   linted: boolean;
   lints: any[];
 }
 
-class FilesRegister {
+export class FilesRegister {
   files: { [filePath: string]: { mtime: number; data: DataShape; }};
   dataFactory: (_data?: any) => DataShape; // It doesn't seem that the _data parameter is ever used?
 
@@ -74,4 +74,4 @@ class FilesRegister {
     }
   }
 }
-export = FilesRegister;
+

src/FilesWatcher.ts

@@ -1,8 +1,8 @@
-import chokidar = require('chokidar');
-import path = require('path');
+import * as chokidar from 'chokidar';
+import * as path from 'path';
 import startsWith = require('lodash.startswith');
 
-class FilesWatcher {
+export class FilesWatcher {
   watchPaths: string[];
   watchExtensions: string[];
   watchers: chokidar.FSWatcher[];
@@ -71,5 +71,3 @@ class FilesWatcher {
     }
   }
 }
-
-export = FilesWatcher;

src/IncrementalChecker.ts

@@ -1,26 +1,26 @@
-import fs = require('fs');
+import * as fs from 'fs';
 import endsWith = require('lodash.endswith');
-import path = require('path');
-import ts = require('typescript');
-import tslintTypes = require('tslint'); // Imported for types alone; actual requires take place in methods below
-import FilesRegister = require('./FilesRegister');
-import FilesWatcher = require('./FilesWatcher');
-import WorkSet = require('./WorkSet');
-import NormalizedMessage = require('./NormalizedMessage');
-import CancellationToken = require('./CancellationToken');
-import minimatch = require('minimatch');
-import VueProgram = require('./VueProgram');
+import * as path from 'path';
+import * as ts from 'typescript';
+import { Configuration, Linter } from 'tslint'; // Imported for types alone; actual requires take place in methods below
+import { FilesRegister } from './FilesRegister';
+import { FilesWatcher } from './FilesWatcher';
+import { WorkSet } from './WorkSet';
+import { NormalizedMessage } from './NormalizedMessage';
+import { CancellationToken } from './CancellationToken';
+import * as minimatch from 'minimatch';
+import { VueProgram } from './VueProgram';
 
 // Need some augmentation here - linterOptions.exclude is not (yet) part of the official
 // types for tslint.
-interface ConfigurationFile extends tslintTypes.Configuration.IConfigurationFile {
+interface ConfigurationFile extends Configuration.IConfigurationFile {
   linterOptions?: {
     typeCheck?: boolean;
     exclude?: string[];
   };
 }
 
-class IncrementalChecker {
+export class IncrementalChecker {
   programConfigFile: string;
   linterConfigFile: string | false;
   watchPaths: string[];
@@ -29,7 +29,7 @@ class IncrementalChecker {
   checkSyntacticErrors: boolean;
   files: FilesRegister;
 
-  linter: tslintTypes.Linter;
+  linter: Linter;
   linterConfig: ConfigurationFile;
   linterExclusions: minimatch.IMinimatch[];
 
@@ -78,7 +78,7 @@ class IncrementalChecker {
   }
 
   static loadLinterConfig(configFile: string): ConfigurationFile {
-    const tslint: typeof tslintTypes = require('tslint');
+    const tslint = require('tslint');
 
     return tslint.Configuration.loadConfigurationFromPath(configFile) as ConfigurationFile;
   }
@@ -124,7 +124,7 @@ class IncrementalChecker {
   }
 
   static createLinter(program: ts.Program) {
-    const tslint: typeof tslintTypes = require('tslint');
+    const tslint = require('tslint');
 
     return new tslint.Linter({ fix: false }, program);
   }
@@ -279,5 +279,3 @@ class IncrementalChecker {
     );
   }
 }
-
-export = IncrementalChecker;

src/Message.ts

@@ -1,6 +1,6 @@
-import NormalizedMessage = require('./NormalizedMessage');
+import { NormalizedMessage } from './NormalizedMessage';
 
-export default interface Message {
+export interface Message {
     diagnostics: NormalizedMessage[];
     lints: NormalizedMessage[];
 }

src/NormalizedMessage.ts

@@ -1,6 +1,5 @@
-// Imported for types alone; actual requires take place in methods below
-import tsTypes = require('typescript');
-import tslintTypes = require('tslint');
+import { Diagnostic, DiagnosticCategory, flattenDiagnosticMessageText } from 'typescript';
+import { RuleFailure } from 'tslint';
 
 type ErrorType = 'diagnostic' | 'lint';
 type Severity = 'error' | 'warning';
@@ -15,7 +14,7 @@ interface NormalizedMessageJson {
   character: number;
 }
 
-class NormalizedMessage {
+export class NormalizedMessage {
   static TYPE_DIAGNOSTIC: ErrorType = 'diagnostic';
   static TYPE_LINT: ErrorType = 'lint';
 
@@ -42,8 +41,7 @@ class NormalizedMessage {
   }
 
   // message types
-  static createFromDiagnostic(diagnostic: tsTypes.Diagnostic) {
-    const ts: typeof tsTypes = require('typescript');
+  static createFromDiagnostic(diagnostic: Diagnostic) {
     let file: string;
     let line: number;
     let character: number;
@@ -57,15 +55,15 @@ class NormalizedMessage {
     return new NormalizedMessage({
       type: NormalizedMessage.TYPE_DIAGNOSTIC,
       code: diagnostic.code,
-      severity: ts.DiagnosticCategory[diagnostic.category].toLowerCase() as Severity,
-      content: ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
+      severity: DiagnosticCategory[diagnostic.category].toLowerCase() as Severity,
+      content: flattenDiagnosticMessageText(diagnostic.messageText, '\n'),
       file: file,
       line: line,
       character: character
     });
   }
 
-  static createFromLint(lint: tslintTypes.RuleFailure) {
+  static createFromLint(lint: RuleFailure) {
     const position = lint.getStartPosition().getLineAndCharacter();
 
     return new NormalizedMessage({
@@ -216,5 +214,3 @@ class NormalizedMessage {
     return this.character;
   }
 }
-
-export = NormalizedMessage;

src/VueProgram.ts

@@ -1,17 +1,17 @@
-import fs = require('fs');
-import path = require('path');
-import ts = require('typescript');
-import FilesRegister = require('./FilesRegister');
-import FilesWatcher = require('./FilesWatcher');
+import * as fs from 'fs';
+import * as path from 'path';
+import * as ts from 'typescript';
+import { FilesRegister } from './FilesRegister';
+import { FilesWatcher } from './FilesWatcher';
 // tslint:disable-next-line
-import vueCompiler = require('vue-template-compiler');
+import * as vueCompiler from 'vue-template-compiler';
 
 interface ResolvedScript {
   scriptKind: ts.ScriptKind;
   content: string;
 }
 
-class VueProgram {
+export class VueProgram {
   static loadProgramConfig(configFile: string) {
     const extraExtensions = ['vue'];
 
@@ -252,5 +252,3 @@ class VueProgram {
     };
   }
 }
-
-export = VueProgram;

src/WorkResult.ts

@@ -1,6 +1,6 @@
-import Message from './Message';
+import { Message } from './Message';
 
-class WorkResult {
+export class WorkResult {
   workResult: {};
   workDomain: any[];
 
@@ -47,5 +47,3 @@ class WorkResult {
     }, initial);
   }
 }
-
-export = WorkResult;