@travetto/compiler 3.0.3 → 3.1.0-rc.0

package/README.md

@@ -45,26 +45,21 @@ $ TRV_BUILD=debug trv build
 2029-03-14T04:00:04.003Z [manifest       ] Started
 2029-03-14T04:00:04.495Z [manifest       ] Completed
 2029-03-14T04:00:05.066Z [transformers   ] Started
-2029-03-14T04:00:05.307Z [transformers   ] @travetto-test/transformer Skipped
-2029-03-14T04:00:05.952Z [transformers   ] @travetto/app Skipped
-2029-03-14T04:00:06.859Z [transformers   ] @travetto/base Skipped
-2029-03-14T04:00:07.720Z [transformers   ] @travetto/cache Skipped
-2029-03-14T04:00:08.179Z [transformers   ] @travetto/di Skipped
-2029-03-14T04:00:08.588Z [transformers   ] @travetto/manifest Skipped
-2029-03-14T04:00:09.493Z [transformers   ] @travetto/registry Skipped
-2029-03-14T04:00:10.395Z [transformers   ] @travetto/rest Skipped
-2029-03-14T04:00:10.407Z [transformers   ] @travetto/schema Skipped
-2029-03-14T04:00:10.799Z [transformers   ] @travetto/test Skipped
-2029-03-14T04:00:11.013Z [transformers   ] Completed
-2029-03-14T04:00:11.827Z [delta          ] Started
-2029-03-14T04:00:11.894Z [delta          ] Completed
-2029-03-14T04:00:12.133Z [manifest       ] Started
-2029-03-14T04:00:13.123Z [manifest       ] Wrote manifest @travetto/mono-repo
-2029-03-14T04:00:14.014Z [manifest       ] Completed
-2029-03-14T04:00:14.924Z [compile        ] Started action=build changed=
-2029-03-14T04:00:15.690Z [compile        ] Skipped
-2029-03-14T04:00:15.865Z [lock           ] Releasing build
-2029-03-14T04:00:16.757Z [build          ] Successfully built
+2029-03-14T04:00:05.307Z [transformers   ] @travetto/base Skipped
+2029-03-14T04:00:05.952Z [transformers   ] @travetto/cli Skipped
+2029-03-14T04:00:06.859Z [transformers   ] @travetto/manifest Skipped
+2029-03-14T04:00:07.720Z [transformers   ] @travetto/registry Skipped
+2029-03-14T04:00:08.179Z [transformers   ] @travetto/schema Skipped
+2029-03-14T04:00:08.588Z [transformers   ] Completed
+2029-03-14T04:00:09.493Z [delta          ] Started
+2029-03-14T04:00:10.395Z [delta          ] Completed
+2029-03-14T04:00:10.407Z [manifest       ] Started
+2029-03-14T04:00:10.799Z [manifest       ] Wrote manifest @travetto-doc/compiler
+2029-03-14T04:00:11.013Z [manifest       ] Completed
+2029-03-14T04:00:11.827Z [compile        ] Started action=build changed=
+2029-03-14T04:00:11.894Z [compile        ] Skipped
+2029-03-14T04:00:12.133Z [lock           ] Releasing build
+2029-03-14T04:00:13.123Z [build          ] Successfully built
 ```
 
 **Terminal: Sample trv output with default log level**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/compiler",
-  "version": "3.0.3",
+  "version": "3.1.0-rc.0",
   "description": "The compiler infrastructure for the Travetto framework",
   "keywords": [
     "compiler",
@@ -31,12 +31,12 @@
   },
   "dependencies": {
     "@parcel/watcher": "^2.1.0",
-    "@travetto/manifest": "^3.0.3",
-    "@travetto/terminal": "^3.0.3",
-    "@travetto/transformer": "^3.0.3"
+    "@travetto/manifest": "^3.1.0-rc.0",
+    "@travetto/terminal": "^3.1.0-rc.0",
+    "@travetto/transformer": "^3.1.0-rc.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.3"
+    "@travetto/cli": "^3.1.0-rc.0"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/compiler.ts

@@ -39,20 +39,6 @@ export class Compiler {
     this.#watch = watch;
   }
 
-  /**
-   * Watches local modules
-   */
-  #watchLocalModules(emit: CompileEmitter): Promise<() => Promise<void>> {
-    return new CompilerWatcher(this.#state).watchFiles(async file => {
-      const err = await emit(file, true);
-      if (err) {
-        Log.info('Compilation Error', CompilerUtil.buildTranspileError(file, err));
-      } else {
-        Log.info(`Compiled ${file.split('node_modules/')[1]}`);
-      }
-      return err;
-    });
-  }
 
   /**
    * Compile in a single pass, only emitting dirty files
@@ -119,7 +105,7 @@ export class Compiler {
     };
 
     if (this.#dirtyFiles.length) {
-      await GlobalTerminal.trackProgress(this.emit(this.#dirtyFiles, emitter), resolveEmittedFile, { position: 'bottom' });
+      await GlobalTerminal.trackProgress(this.emit(this.#dirtyFiles, emitter), resolveEmittedFile, { position: 'bottom', minDelay: 50 });
       if (failed) {
         Log.debug('Compilation failed');
         process.exit(1);
@@ -136,13 +122,21 @@ export class Compiler {
 
     if (this.#watch) {
       Log.info('Watch is ready');
-      await this.#watchLocalModules(emitter);
-      const output = this.#state.resolveOutputFile('.');
-      for await (const _ of fs.watch(output)) {
-        if (!await fs.stat(output).catch(() => false)) {
-          process.send?.('restart');
+      for await (const { file, action } of CompilerWatcher.watch(this.#state)) {
+        if (action !== 'delete') {
+          const err = await emitter(file, true);
+          if (err) {
+            Log.info('Compilation Error', CompilerUtil.buildTranspileError(file, err));
+          } else {
+            Log.info(`Compiled ${file.split('node_modules/')[1]}`);
+          }
+        } else {
+          Log.info(`Removed ${file.split('node_modules/')[1]}`);
         }
       }
+      if (!process.exitCode) {
+        process.send?.('restart');
+      }
     }
   }
 }

package/src/util.ts

@@ -3,7 +3,6 @@ import ts from 'typescript';
 import { ManifestContext, ManifestModuleFileType, ManifestModuleUtil, ManifestRoot, Package, path } from '@travetto/manifest';
 
 type OutputToSource = (outputFile: string) => ({ source: string } | undefined);
-export type FileWatchEvent = { type: 'create' | 'delete' | 'update', path: string };
 
 const nativeCwd = process.cwd();
 

package/src/watch.ts

@@ -1,21 +1,28 @@
 import { readFileSync } from 'fs';
-import fs from 'fs/promises';
 
 import {
   ManifestContext, ManifestModuleUtil, ManifestUtil, WatchEvent, ManifestModuleFolderType,
-  ManifestModuleFileType, path, ManifestModule, watchFolders, WatchEventListener, watchFolderImmediate, WatchConfig
+  ManifestModuleFileType, path, ManifestModule, watchFolders, WatchFolder, RootIndex, WatchStream
 } from '@travetto/manifest';
 import { getManifestContext } from '@travetto/manifest/bin/context';
 
 import { CompilerState } from './state';
 import { CompilerUtil } from './util';
-import { CompileEmitter, CompileWatcherHandler } from './types';
 
 /**
  * Utils for watching
  */
 export class CompilerWatcher {
 
+  /**
+   * Watch state
+   * @param state
+   * @returns
+   */
+  static watch(state: CompilerState): AsyncIterable<WatchEvent> {
+    return new CompilerWatcher(state).watchChanges();
+  }
+
   #sourceHashes = new Map<string, number>();
   #manifestContexts = new Map<string, ManifestContext>();
   #dirtyFiles: { modFolder: string, mod: string, moduleFile?: string, folderKey?: ManifestModuleFolderType, type?: ManifestModuleFileType }[] = [];
@@ -62,15 +69,21 @@ export class CompilerWatcher {
   }
 
   /**
-   * Get a watcher for a given compiler state
-   * @param state
-   * @param handler
-   * @returns
-   */
-  #getWatcher(handler: CompileWatcherHandler): WatchEventListener {
+ * Get a watcher for a given compiler state
+ * @param state
+ * @param handler
+ * @returns
+ */
+  async * watchChanges(): AsyncIterable<WatchEvent> {
+    const stream = this.#watchFiles();
+
     const mods = this.#getModuleMap();
+    for await (const { file: sourceFile, action, folder } of stream) {
+
+      if (folder === '.trv_internal') {
+        break;
+      }
 
-    return async ({ file: sourceFile, action }: WatchEvent, folder: string): Promise<void> => {
       const mod = mods[folder];
       const moduleFile = mod.sourceFolder ?
         (sourceFile.includes(mod.sourceFolder) ? sourceFile.split(`${mod.sourceFolder}/`)[1] : sourceFile) :
@@ -91,7 +104,7 @@ export class CompilerWatcher {
             const hash = CompilerUtil.naiveHash(readFileSync(sourceFile, 'utf8'));
             const input = this.#state.registerInput(mod, moduleFile);
             this.#sourceHashes.set(sourceFile, hash);
-            handler.create(input);
+            yield { action, file: input, folder };
           }
           break;
         }
@@ -103,7 +116,7 @@ export class CompilerWatcher {
             if (this.#sourceHashes.get(sourceFile) !== hash) {
               this.#state.resetInputSource(entry.input);
               this.#sourceHashes.set(sourceFile, hash);
-              handler.update(entry.input);
+              yield { action, file: entry.input, folder };
             }
           }
           break;
@@ -114,49 +127,58 @@ export class CompilerWatcher {
             this.#state.removeInput(entry.input);
             if (entry.output) {
               this.#dirtyFiles.push({ mod: mod.name, modFolder: folder });
-              handler.delete(entry.output);
+              yield { action, file: entry.output, folder };
             }
           }
         }
       }
-    };
+    }
   }
 
   /**
    * Watch files based on root index
    */
-  async watchFiles(emit: CompileEmitter): Promise<() => Promise<void>> {
-    let watchRoot: (() => Promise<void>) | undefined = undefined;
-
+  #watchFiles(): WatchStream {
     const idx = this.#state.manifestIndex;
     const modules = [...idx.getModuleList('all')].map(x => idx.getModule(x)!);
-    const remove = (outputFile: string): Promise<void> => fs.rm(outputFile, { force: true });
-    const handler = this.#getWatcher({ create: emit, update: emit, delete: remove });
-    const options: WatchConfig = {
-      filter: ev => {
+    const options: Partial<WatchFolder> = {
+      filter: (ev: WatchEvent): boolean => {
         const type = ManifestModuleUtil.getFileType(ev.file);
         return type === 'ts' || type === 'typings' || type === 'js' || type === 'package-json';
       },
-      ignore: ['node_modules']
+      ignore: ['node_modules', '**/.trv_*'],
     };
 
-    const moduleFolders = modules
+    const moduleFolders: WatchFolder[] = modules
       .filter(x => !idx.manifest.monoRepo || x.sourcePath !== idx.manifest.workspacePath)
-      .map(x => [x.sourcePath, x.sourcePath] as const);
+      .map(x => ({ src: x.sourcePath, target: x.sourcePath }));
 
     // Add monorepo folders
     if (idx.manifest.monoRepo) {
       const mono = modules.find(x => x.sourcePath === idx.manifest.workspacePath)!;
       for (const folder of Object.keys(mono.files)) {
         if (!folder.startsWith('$')) {
-          moduleFolders.push([path.resolve(mono.sourcePath, folder), mono.sourcePath]);
+          moduleFolders.push({ src: path.resolve(mono.sourcePath, folder), target: mono.sourcePath });
         }
       }
-      watchRoot = await watchFolderImmediate(mono.sourcePath, handler, options);
+      moduleFolders.push({ src: mono.sourcePath, target: mono.sourcePath, immediate: true });
     }
 
-    const watchAll = await watchFolders(moduleFolders, handler, options);
+    // Watch output folders
+    const outputWatch = (root: string, sources: string[]): WatchFolder => {
+      const valid = new Set(sources.map(src => path.resolve(root, src)));
+      return {
+        src: root, target: '.trv_internal', immediate: true, includeHidden: true,
+        filter: ev => ev.action === 'delete' && valid.has(path.resolve(root, ev.file))
+      };
+    };
+    moduleFolders.push(
+      outputWatch(RootIndex.manifest.workspacePath, [
+        RootIndex.manifest.outputFolder,
+        RootIndex.manifest.compilerFolder
+      ])
+    );
 
-    return () => Promise.all([watchRoot?.(), watchAll()]).then(() => { });
+    return watchFolders(moduleFolders, options);
   }
 }

package/support/transpile.ts

@@ -1,6 +1,7 @@
 import path from 'path';
 import fs from 'fs/promises';
 import os from 'os';
+import timers from 'timers/promises';
 import cp from 'child_process';
 import { createRequire } from 'module';
 
@@ -204,7 +205,7 @@ export class TranspileUtil {
     try {
       await this.writeTextFile(deltaFile, changedFiles.join('\n'));
 
-      return await LogUtil.withLogger('compiler-exec', log => new Promise<CompileResult>((res, rej) => {
+      const result = await LogUtil.withLogger('compiler-exec', log => new Promise<CompileResult>((res, rej) => {
         proc = cp.spawn(process.argv0, [main, deltaFile, `${watch}`], {
           env: {
             ...process.env,
@@ -225,10 +226,19 @@ export class TranspileUtil {
         kill = (): void => { proc?.kill('SIGKILL'); };
         process.on('exit', kill);
       }));
+
+      if (result === 'restart') {
+        await timers.setTimeout(150 + 100 * Math.random());
+      }
+
+      return result;
     } finally {
       if (proc?.killed === false) { proc.kill('SIGKILL'); }
       if (kill) {
-        process.removeListener('exit', kill);
+        process.off('exit', kill);
+      }
+      if (process.stdout.isTTY) {
+        process.stdout.write('\x1b[s\x1b[?25h\x1b[r\x1b[u');
       }
       await fs.rm(deltaFile, { force: true });
     }