@travetto/compiler 2.1.3 → 2.2.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/compiler",
   "displayName": "Compiler",
-  "version": "2.1.3",
+  "version": "2.2.1",
   "description": "Node-integration of Typescript Compiler with advanced functionality for detecting changes in classes and methods.",
   "keywords": [
     "tsc",
@@ -29,9 +29,9 @@
     "directory": "module/compiler"
   },
   "dependencies": {
-    "@travetto/base": "^2.1.3",
-    "@travetto/transformer": "^2.1.3",
-    "@travetto/watch": "^2.1.3"
+    "@travetto/base": "^2.2.1",
+    "@travetto/transformer": "^2.2.1",
+    "@travetto/watch": "^2.2.1"
   },
   "publishConfig": {
     "access": "public"

package/src/compiler.ts

@@ -43,7 +43,7 @@ class $Compiler {
       }
       this.#program = ts.createProgram({
         rootNames: [...rootFiles],
-        options: TranspileUtil.compilerOptions as ts.CompilerOptions,
+        options: TranspileUtil.compilerOptions,
         host: this.#host,
         oldProgram: this.#program
       });
@@ -55,7 +55,7 @@ class $Compiler {
   /**
    * Perform actual transpilation
    */
-  #transpile(filename: string, force = false) {
+  #transpile(filename: string, force = false): string {
     if (force || !AppCache.hasEntry(filename)) {
       console.debug('Emitting', { filename: filename.replace(PathUtil.cwd, '.') });
 
@@ -70,8 +70,11 @@ class $Compiler {
           this.#transformerManager.getTransformers()
         );
 
-        TranspileUtil.checkTranspileErrors(filename, result.diagnostics as []);
+        TranspileUtil.checkTranspileErrors(filename, result.diagnostics);
       } catch (err) {
+        if (!(err instanceof Error)) {
+          throw err;
+        }
         const errContent = TranspileUtil.transpileError(filename, err);
         this.#host.contents.set(filename, errContent);
       }
@@ -87,14 +90,14 @@ class $Compiler {
    * Get program
    * @private
    */
-  getProgram() {
+  getProgram(): ts.Program {
     return this.#getProgram();
   }
 
   /**
    * Initialize the compiler
    */
-  async init() {
+  async init(): Promise<void> {
     if (this.active) {
       return;
     }
@@ -110,7 +113,7 @@ class $Compiler {
 
     ModuleManager.onUnload((f, unlink) => this.#host.unload(f, unlink)); // Remove source
 
-    // Update source map support to read from tranpsiler cache
+    // Update source map support to read from transpiler cache
     sourceMapSupport.install({
       retrieveFile: p => this.#host.contents.get(PathUtil.toUnixTs(p))!
     });
@@ -121,7 +124,7 @@ class $Compiler {
   /**
    * Reset the compiler
    */
-  reset() {
+  reset(): void {
     if (!EnvUtil.isReadonly()) {
       this.#transformerManager.reset();
       this.#host.reset();
@@ -135,7 +138,7 @@ class $Compiler {
   /**
    * Notify of an add/remove/change event
    */
-  notify(type: EventType, filename: string) {
+  notify(type: EventType, filename: string): void {
     console.debug('File Event', { type, filename: filename.replace(PathUtil.cwd, '.') });
     this.#emitter.emit(type, filename);
   }
@@ -143,7 +146,7 @@ class $Compiler {
   /**
    * Listen for events
    */
-  on(type: EventType, handler: FileListener) {
+  on(type: EventType, handler: FileListener): this {
     this.#emitter.on(type, handler);
     return this;
   }
@@ -151,7 +154,7 @@ class $Compiler {
   /**
    * Unload if file is known
    */
-  added(filename: string) {
+  added(filename: string): void {
     if (filename in require.cache) { // if already loaded
       ModuleManager.unload(filename);
     }
@@ -163,7 +166,7 @@ class $Compiler {
   /**
    * Handle when a file is removed during watch
    */
-  removed(filename: string) {
+  removed(filename: string): void {
     ModuleManager.unload(filename, true);
     this.notify('removed', filename);
   }
@@ -171,7 +174,7 @@ class $Compiler {
   /**
    * When a file changes during watch
    */
-  changed(filename: string) {
+  changed(filename: string): void {
     if (this.#host.hashChanged(filename)) {
       ModuleManager.unload(filename);
       // Load Synchronously

package/src/host.ts

@@ -19,24 +19,24 @@ export class SourceHost implements ts.CompilerHost {
   #sources = new Map<string, ts.SourceFile>();
   readonly contents = new Map<string, string>();
 
-  #trackFile(filename: string, content: string) {
+  #trackFile(filename: string, content: string): void {
     this.contents.set(filename, content);
     this.#hashes.set(filename, SystemUtil.naiveHash(readFileSync(filename, 'utf8'))); // Get og content for hashing
   }
 
-  getCanonicalFileName = (f: string) => f;
-  getCurrentDirectory = () => PathUtil.cwd;
-  getDefaultLibFileName = (opts: ts.CompilerOptions) => ts.getDefaultLibFileName(opts);
-  getNewLine = () => ts.sys.newLine;
-  useCaseSensitiveFileNames = () => ts.sys.useCaseSensitiveFileNames;
-  getDefaultLibLocation() {
-    return path.dirname(ts.getDefaultLibFilePath(TranspileUtil.compilerOptions as ts.CompilerOptions));
+  getCanonicalFileName: (file: string) => string = (f: string) => f;
+  getCurrentDirectory: () => string = () => PathUtil.cwd;
+  getDefaultLibFileName: (opts: ts.CompilerOptions) => string = (opts: ts.CompilerOptions) => ts.getDefaultLibFileName(opts);
+  getNewLine: () => string = () => ts.sys.newLine;
+  useCaseSensitiveFileNames: () => boolean = () => ts.sys.useCaseSensitiveFileNames;
+  getDefaultLibLocation(): string {
+    return path.dirname(ts.getDefaultLibFilePath(TranspileUtil.compilerOptions));
   }
 
   /**
    * Get root files
    */
-  getRootFiles() {
+  getRootFiles(): Set<string> {
     if (!this.#rootFiles.size) {
       // Only needed for compilation
       this.#rootFiles = new Set(SourceIndex.findByFolders(AppManifest.source, 'required').map(x => x.file));
@@ -47,7 +47,7 @@ export class SourceHost implements ts.CompilerHost {
   /**
    * Read file from disk, using the transpile pre-processor on .ts files
    */
-  readFile(filename: string) {
+  readFile(filename: string): string {
     filename = PathUtil.toUnixTs(filename);
     let content = ts.sys.readFile(filename);
     if (content === undefined) {
@@ -62,7 +62,7 @@ export class SourceHost implements ts.CompilerHost {
   /**
    * Write file to disk, and set value in cache as well
    */
-  writeFile(filename: string, content: string) {
+  writeFile(filename: string, content: string): void {
     filename = PathUtil.toUnixTs(filename);
     this.#trackFile(filename, content);
     AppCache.writeEntry(filename, content);
@@ -71,7 +71,7 @@ export class SourceHost implements ts.CompilerHost {
   /**
    * Fetch file
    */
-  fetchFile(filename: string) {
+  fetchFile(filename: string): void {
     filename = PathUtil.toUnixTs(filename);
     const cached = AppCache.readEntry(filename);
     this.#trackFile(filename, cached);
@@ -81,20 +81,21 @@ export class SourceHost implements ts.CompilerHost {
    * Get a source file on demand
    * @returns
    */
-  getSourceFile(filename: string, __tgt: unknown, __onErr: unknown, force?: boolean) {
+  getSourceFile(filename: string, __tgt: unknown, __onErr: unknown, force?: boolean): ts.SourceFile {
     if (!this.#sources.has(filename) || force) {
       const content = this.readFile(filename)!;
       this.#sources.set(filename, ts.createSourceFile(filename, content ?? '',
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         (TranspileUtil.compilerOptions as ts.CompilerOptions).target!
       ));
     }
-    return this.#sources.get(filename);
+    return this.#sources.get(filename)!;
   }
 
   /**
    * See if a file exists
    */
-  fileExists(filename: string) {
+  fileExists(filename: string): boolean {
     filename = PathUtil.toUnixTs(filename);
     return this.contents.has(filename) || ts.sys.fileExists(filename);
   }
@@ -102,7 +103,7 @@ export class SourceHost implements ts.CompilerHost {
   /**
    * See if a file's hash code has changed
    */
-  hashChanged(filename: string, content?: string) {
+  hashChanged(filename: string, content?: string): boolean {
     content ??= readFileSync(filename, 'utf8');
     // Let's see if they are really different
     const hash = SystemUtil.naiveHash(content);
@@ -116,7 +117,7 @@ export class SourceHost implements ts.CompilerHost {
   /**
    * Unload a file from the transpiler
    */
-  unload(filename: string, unlink = true) {
+  unload(filename: string, unlink = true): void {
     if (this.contents.has(filename)) {
       AppCache.removeExpiredEntry(filename, unlink);
 
@@ -132,7 +133,7 @@ export class SourceHost implements ts.CompilerHost {
   /**
    * Reset the transpiler
    */
-  reset() {
+  reset(): void {
     this.contents.clear();
     this.#rootFiles.clear();
     this.#hashes.clear();

package/src/transformer.ts

@@ -6,18 +6,21 @@ import {
   NodeTransformer, VisitorFactory, TransformerState, getAllTransformers
 } from '@travetto/transformer'; // Narrow import to minimize scope
 
+type TransformerList = { before: ts.TransformerFactory<ts.SourceFile>[] };
+
+
 /**
  * Manages the typescript transformers
  */
 export class TransformerManager {
 
-  #cached: { before: ts.TransformerFactory<ts.SourceFile>[] } | undefined;
+  #cached: TransformerList | undefined;
   #transformers: NodeTransformer<TransformerState>[] = [];
 
   /**
    * Read all transformers from disk under the pattern support/transformer.*
    */
-  async init() {
+  async init(): Promise<void> {
     if (this.#cached) {
       return;
     }
@@ -43,7 +46,7 @@ export class TransformerManager {
     // Prepare a new visitor factory with a given type checker
   }
 
-  build(checker: ts.TypeChecker) {
+  build(checker: ts.TypeChecker): void {
     const visitor = new VisitorFactory(
       (ctx, src) => new TransformerState(src, ctx.factory, checker),
       this.#transformers
@@ -58,14 +61,14 @@ export class TransformerManager {
   /**
    * Get typescript transformer object
    */
-  getTransformers() {
+  getTransformers(): TransformerList | undefined {
     return this.#cached!;
   }
 
   /**
    * Reset state
    */
-  reset() {
+  reset(): void {
     this.#transformers = [];
     this.#cached = undefined;
   }

package/support/dynamic.compiler.ts

@@ -11,7 +11,7 @@ import { Compiler } from '../src/compiler';
 /**
  * Wraps the compiler supporting real-time changes to files
  */
-export function init($Compiler: Class<typeof Compiler>) {
+export function init($Compiler: Class<typeof Compiler>): typeof $Compiler {
   /**
    * Extending the $Compiler class to add some functionality
    */
@@ -62,7 +62,7 @@ export function init($Compiler: Class<typeof Compiler>) {
       });
     }
 
-    reset() {
+    reset(): void {
       super.reset();
       this.#modules.clear();
     }

package/support/phase.init.ts

@@ -5,7 +5,7 @@ export const init = {
   key: '@trv:compiler/init',
   after: ['@trv:base/init'],
   before: ['@trv:base/transpile'],
-  action: async () => {
+  action: async (): Promise<void> => {
     // Overrides the require behavior
     const { Compiler } = await import('../src/compiler');
     await Compiler.init();

package/support/phase.reset.ts

@@ -3,7 +3,7 @@
  */
 export const init = {
   key: '@trv:compiler/reset',
-  action: async () => {
+  action: async (): Promise<void> => {
     const { Compiler } = await import('../src/compiler');
     Compiler.reset();
   }