@travetto/compiler 3.0.2 → 3.0.3

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/compiler/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/compiler/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Compiler
+
 ## The compiler infrastructure for the Travetto framework
 
 **Install: @travetto/compiler**
@@ -13,37 +14,57 @@ yarn add @travetto/compiler
 ```
 
 This module expands upon the [Typescript](https://typescriptlang.org) compiler, with the additional features:
-   
    *  Integration with the [Transformation](https://github.com/travetto/travetto/tree/main/module/transformer#readme "Functionality for AST transformations, with transformer registration, and general utils") module, allowing for rich, type-aware transformations
    *  Automatic conversion to either [Ecmascript Module](https://nodejs.org/api/esm.html) or [CommonJS](https://nodejs.org/api/modules.html) based on the [Package JSON](https://docs.npmjs.com/cli/v9/configuring-npm/package-json) `type` value
    *  Removal of type only imports which can break [Ecmascript Module](https://nodejs.org/api/esm.html)-style output
    *  Automatic addition of `.js` extension to imports to also support  [Ecmascript Module](https://nodejs.org/api/esm.html)-style output
-
-Beyond the [Typescript](https://typescriptlang.org) compiler functionality, the module provides the primary entry point into the development process.  
+Beyond the [Typescript](https://typescriptlang.org) compiler functionality, the module provides the primary entry point into the development process.
 
 ## CLI
-
-The cli, [trv](https://github.com/travetto/travetto/tree/main/module/compiler/bin/trv.js#L60) is a compilation aware entry point, that has the ability to check for active builds, and ongoing watch operations to ensure only one process is building at a time.  Within the framework, regardless of mono-repo or not, always builds the entire project.  With the efficient caching behavior, this leads to generally a minimal overhead but allows for centralization of all operations.
+The cli, [trv](https://github.com/travetto/travetto/tree/main/module/compiler/bin/trv.js#L60) is a compilation aware entry point, that has the ability to check for active builds, and ongoing watch operations to ensure only one process is building at a time.  Within the framework, regardless of mono-repo or not, always builds the entire project.  With the efficient caching behavior, this leads to generally a minimal overhead but allows for centralization of all operations. 
 
 The CLI supports the following operations:
-
-   
    *  `clean` - Removes the output folder, and if `-a` is also passed, will also clean out the compiler folder
    *  `build` - Will attempt to build the project.  If the project is already built, will return immediately.  If the project is being built somewhere else, will wait until a build is completed.
    *  `watch` - If nothing else is watching, will start the watch operation.  Otherwise will return immediately.
-   *  `manifest` - Will produce a manifest. If no file is passed in the command line arguments, will output to stdout
+   *  `manifest` - Will produce a manifest. If no file is passed in the command line arguments, will output to stdout.
    *  `<other>` - Will be delegated to the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") entry point after a successful build.
-
 In addition to the normal output, the compiler supports an environment variable `TRV_BUILD` that supports the following values: `debug`, `info`, `warn` or `none`.  This provides different level of logging during the build process which is helpful to diagnose any odd behaviors.  When invoking an unknown command (e.g. `<other>` from above), the default level is `warn`.  Otherwise the default logging level is `info`.
 
 **Terminal: Sample trv output with debug logging**
 ```bash
 $ TRV_BUILD=debug trv build
 
-2029-03-14T04:00:00.618Z [lock           ] watch pid=000000 Started
-2029-03-14T04:00:00.837Z [lock           ] watch pid=000000 Already running, and has built
-2029-03-14T04:00:01.510Z [lock           ] watch pid=000000 Completed
-2029-03-14T04:00:02.450Z [build          ] Successfully built
+2029-03-14T04:00:00.618Z [lock           ] Acquiring build
+2029-03-14T04:00:00.837Z [precompile     ] Started
+2029-03-14T04:00:01.510Z [precompile     ] @travetto/terminal Skipped
+2029-03-14T04:00:02.450Z [precompile     ] @travetto/manifest Skipped
+2029-03-14T04:00:02.762Z [precompile     ] @travetto/transformer Skipped
+2029-03-14T04:00:02.947Z [precompile     ] @travetto/compiler Skipped
+2029-03-14T04:00:03.093Z [precompile     ] Completed
+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
 ```
 
 **Terminal: Sample trv output with default log level**
@@ -52,9 +73,7 @@ $ trv build
 ```
 
 ## Compilation Architecture
-
 The compiler will move through the following phases on a given compilation execution:
-   
    *  `Bootstrapping` - Initial compilation of [Compiler](https://github.com/travetto/travetto/tree/main/module/compiler#readme "The compiler infrastructure for the Travetto framework")'s `support/*.ts` files
    *  `Lock Management` - Manages cross-process interaction to ensure single compiler
    *  `Build Compiler` - Leverages [Typescript](https://typescriptlang.org) to build files needed to execute compiler
@@ -66,17 +85,12 @@ The compiler will move through the following phases on a given compilation execu
    *  `Invoke Compiler` - Run [Typescript](https://typescriptlang.org) compiler with the aforementioned enhancements
 
 ### Bootstrapping
-
-Given that the framework is distributed as [Typescript](https://typescriptlang.org) only files, there is a bootstrapping problem that needs to be mitigated.  The [trv](https://github.com/travetto/travetto/tree/main/module/compiler/bin/trv.js#L60) entrypoint, along with a small context utility in [Manifest](https://github.com/travetto/travetto/tree/main/module/manifest#readme "Support for project indexing, manifesting, along with file watching") are the only [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) files needed to run the project.  The [trv](https://github.com/travetto/travetto/tree/main/module/compiler/bin/trv.js#L60) entry point will compile `@travetto/compiler/support/*` files as the set that is used at startup.  These files are also accessible to the compiler as they get re-compiled after the fact.  
+Given that the framework is distributed as [Typescript](https://typescriptlang.org) only files, there is a bootstrapping problem that needs to be mitigated.  The [trv](https://github.com/travetto/travetto/tree/main/module/compiler/bin/trv.js#L60) entrypoint, along with a small context utility in [Manifest](https://github.com/travetto/travetto/tree/main/module/manifest#readme "Support for project indexing, manifesting, along with file watching") are the only [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) files needed to run the project.  The [trv](https://github.com/travetto/travetto/tree/main/module/compiler/bin/trv.js#L60) entry point will compile `@travetto/compiler/support/*` files as the set that is used at startup.  These files are also accessible to the compiler as they get re-compiled after the fact.
 
 ### Lock Management
-
 The compiler supports invocation from multiple locations at the same time, and provides a layer of orchestration to ensure a single process is building at a time.  For a given project, there are four main states:
-
-   
    *  No Watch - Building
    *  Watch    - No Build
    *  Watch    - Building
    *  Inactive / Stale
-
 Depending on what state the project is in (depending on various processes), will influence what the supporting tooling should do. [LockManager](https://github.com/travetto/travetto/tree/main/module/compiler/support/lock.ts#L25) represents the majority of the logic for tracking various states, and informing what action should happen when in the above states.

package/bin/trv.js

@@ -9,7 +9,7 @@ import { getManifestContext } from '@travetto/manifest/bin/context.js';
 
 const VALID_OPS = { watch: 'watch', build: 'build', clean: 'clean', manifest: 'manifest' };
 
-const COMPILER_FILES = [...['launcher', 'transpile', 'lock', 'log', 'lock-pinger'].map(x => `support/${x}.js`), 'package.json'];
+const COMPILER_FILES = [...['launcher', 'transpile', 'lock', 'log', 'lock-pinger'].map(x => `support/${x}.ts`), 'package.json'];
 
 /**
  * @param {import('@travetto/manifest').ManifestContext} ctx
@@ -20,12 +20,12 @@ const $getLauncher = async (ctx) => {
   if (!(await fs.stat(tsconfigFile).catch(() => undefined))) {
     await fs.writeFile(tsconfigFile, JSON.stringify({ extends: '@travetto/compiler/tsconfig.trv.json' }), 'utf8');
   }
-  const compPkg = createRequire(path.resolve(ctx.workspacePath, 'node_modules')).resolve('@travetto/compiler/package.json');
+  const compMod = path.dirname(createRequire(path.resolve(ctx.workspacePath, 'node_modules')).resolve('@travetto/compiler/package.json'));
   const files = [];
 
   for (const file of COMPILER_FILES) {
-    const target = path.resolve(ctx.workspacePath, ctx.compilerFolder, 'node_modules', '@travetto/compiler', file);
-    const src = compPkg.replace('package.json', file.replace(/[.]js$/, '.ts'));
+    const target = path.resolve(ctx.workspacePath, ctx.compilerFolder, 'node_modules', '@travetto/compiler', file).replace(/[.]tsx?$/, '.js');
+    const src = path.resolve(compMod, file);
 
     const targetTime = await fs.stat(target).then(s => Math.max(s.mtimeMs, s.ctimeMs)).catch(() => 0);
     const srcTime = await fs.stat(src).then(s => Math.max(s.mtimeMs, s.ctimeMs));
@@ -35,7 +35,7 @@ const $getLauncher = async (ctx) => {
       const module = ctx.moduleType === 'module' ? ts.ModuleKind.ESNext : ts.ModuleKind.CommonJS;
       await fs.mkdir(path.dirname(target), { recursive: true });
       const text = await fs.readFile(src, 'utf8');
-      if (file.endsWith('.js')) {
+      if (/[.]tsx?$/.test(file)) {
         const content = ts.transpile(
           text,
           { target: ts.ScriptTarget.ES2020, module, esModuleInterop: true, allowSyntheticDefaultImports: true }

package/package.json

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

package/src/compiler.ts

@@ -3,7 +3,7 @@ import ts from 'typescript';
 import fs from 'fs/promises';
 
 import { GlobalTerminal, TerminalProgressEvent } from '@travetto/terminal';
-import { RootIndex } from '@travetto/manifest';
+import { ManifestModuleUtil, RootIndex } from '@travetto/manifest';
 
 import { CompilerUtil } from './util';
 import { CompilerState } from './state';
@@ -22,7 +22,7 @@ export class Compiler {
   static async main(): Promise<void> {
     const [dirty, watch] = process.argv.slice(2);
     const state = await CompilerState.get(RootIndex);
-    const dirtyFiles = (await fs.readFile(dirty, 'utf8')).split(/\n/).filter(x => !!x);
+    const dirtyFiles = ManifestModuleUtil.getFileType(dirty) === 'ts' ? [dirty] : (await fs.readFile(dirty, 'utf8')).split(/\n/).filter(x => !!x);
     await new Compiler(state, dirtyFiles, watch === 'true').run();
     process.exit(0);
   }

package/src/state.ts

@@ -104,17 +104,18 @@ export class CompilerState implements ts.CompilerHost {
     return prog;
   }
 
-  writeInputFile(program: ts.Program, inputFile: string): ts.EmitResult | undefined {
-    if (inputFile.endsWith('.json')) {
-      this.writeFile(this.#inputToEntry.get(inputFile)!.output!, this.readFile(inputFile)!, false);
-    } else if (inputFile.endsWith('.js')) {
-      this.writeFile(this.#inputToEntry.get(inputFile)!.output!, ts.transpile(this.readFile(inputFile)!, this.#compilerOptions), false);
-    } else if (inputFile.endsWith('.ts')) {
-      return program.emit(
-        program.getSourceFile(inputFile)!,
-        (...args) => this.writeFile(...args), undefined, false,
-        this.#transformerManager.get()
-      );
+  writeInputFile(program: ts.Program, inputFile: string): ts.EmitResult | undefined | void {
+    switch (ManifestModuleUtil.getFileType(inputFile)) {
+      case 'package-json':
+        return this.writeFile(this.#inputToEntry.get(inputFile)!.output!, this.readFile(inputFile)!, false);
+      case 'js':
+        return this.writeFile(this.#inputToEntry.get(inputFile)!.output!, ts.transpile(this.readFile(inputFile)!, this.#compilerOptions), false);
+      case 'ts':
+        return program.emit(
+          program.getSourceFile(inputFile)!,
+          (...args) => this.writeFile(...args), undefined, false,
+          this.#transformerManager.get()
+        );
     }
   }
 
@@ -131,7 +132,7 @@ export class CompilerState implements ts.CompilerHost {
     const fileType = ManifestModuleUtil.getFileType(moduleFile);
     const outputFile = fileType === 'typings' ?
       undefined :
-      path.resolve(this.#outputPath, CompilerUtil.inputToOutput(relativeInput));
+      path.resolve(this.#outputPath, ManifestModuleUtil.sourceToOutputExt(relativeInput));
 
     const entry = { source: sourceFile, input: inputFile, output: outputFile, module, relativeInput };
 

package/src/util.ts

@@ -1,6 +1,6 @@
 import ts from 'typescript';
 
-import { ManifestContext, ManifestModuleFileType, ManifestRoot, Package, path } from '@travetto/manifest';
+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 };
@@ -17,15 +17,6 @@ export class CompilerUtil {
    */
   static validFile = (type: ManifestModuleFileType): boolean => type === 'ts' || type === 'package-json' || type === 'js';
 
-  /**
-   * Map input file to output format, generally converting ts extensions to js
-   * @param file
-   * @returns
-   */
-  static inputToOutput(file: string): string {
-    return file.replace(/[.][tj]s$/, '.js');
-  }
-
   /**
    * Determines if write callback data has sourcemap information
    * @param data
@@ -41,7 +32,7 @@ export class CompilerUtil {
    */
   static rewriteSourceMap(ctx: ManifestContext, text: string, outputToSource: OutputToSource): string {
     const data: { sourceRoot?: string, sources: string[] } = JSON.parse(text);
-    const output = this.inputToOutput(path.resolve(ctx.workspacePath, ctx.outputFolder, data.sources[0]));
+    const output = ManifestModuleUtil.sourceToOutputExt(path.resolve(ctx.workspacePath, ctx.outputFolder, data.sources[0]));
     const { source: file } = outputToSource(output) ?? {};
 
     if (file) {
@@ -77,7 +68,7 @@ export class CompilerUtil {
   }
 
   /**
-   * Rewrites the package.json to target .js files instead of .ts files, and pins versions
+   * Rewrites the package.json to target output file names, and pins versions
    * @param manifest
    * @param file
    * @param text
@@ -86,10 +77,10 @@ export class CompilerUtil {
   static rewritePackageJSON(manifest: ManifestRoot, text: string): string {
     const pkg: Package = JSON.parse(text);
     if (pkg.files) {
-      pkg.files = pkg.files.map(x => this.inputToOutput(x));
+      pkg.files = pkg.files.map(x => ManifestModuleUtil.sourceToOutputExt(x));
     }
     if (pkg.main) {
-      pkg.main = this.inputToOutput(pkg.main);
+      pkg.main = ManifestModuleUtil.sourceToOutputExt(pkg.main);
     }
     pkg.type = manifest.moduleType;
     for (const key of ['devDependencies', 'dependencies', 'peerDependencies'] as const) {

package/src/watch.ts

@@ -133,7 +133,10 @@ export class CompilerWatcher {
     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 => ev.file.endsWith('.ts') || ev.file.endsWith('.js') || ev.file.endsWith('package.json'),
+      filter: ev => {
+        const type = ManifestModuleUtil.getFileType(ev.file);
+        return type === 'ts' || type === 'typings' || type === 'js' || type === 'package-json';
+      },
       ignore: ['node_modules']
     };
 

package/support/transpile.ts

@@ -19,6 +19,27 @@ const RECENT_STAT = (stat: { ctimeMs: number, mtimeMs: number }): number => Math
  * Transpile utilities for launching
  */
 export class TranspileUtil {
+  /**
+   * Determine file type
+   */
+  static getFileType(file: string): 'ts' | 'js' | 'package-json' | 'typings' | undefined {
+    return file.endsWith('package.json') ? 'package-json' :
+      (file.endsWith('.js') ? 'js' :
+        (file.endsWith('.d.ts') ? 'typings' : (/[.]tsx?$/.test(file) ? 'ts' : undefined)));
+  }
+
+  /**  Convert a file to a given ext */
+  static #sourceToExtension(inputFile: string, ext: string): string {
+    return inputFile.replace(/[.][tj]sx?$/, ext);
+  }
+
+  /**
+   * Get the output file name for a given input
+   */
+  static sourceToOutputExt(inputFile: string): string {
+    return this.#sourceToExtension(inputFile, '.js');
+  }
+
   /**
    * Write text file, and ensure folder exists
    */
@@ -45,8 +66,6 @@ export class TranspileUtil {
       OPT_CACHE[ctx.workspacePath] = {
         ...options,
         allowJs: true,
-        sourceMap: false,
-        inlineSourceMap: true,
         resolveJsonModule: true,
         sourceRoot: ctx.workspacePath,
         rootDir: ctx.workspacePath,
@@ -61,7 +80,8 @@ export class TranspileUtil {
    * Output a file, support for ts, js, and package.json
    */
   static async transpileFile(ctx: ManifestContext, inputFile: string, outputFile: string): Promise<void> {
-    if (inputFile.endsWith('.ts') || inputFile.endsWith('.js')) {
+    const type = this.getFileType(inputFile);
+    if (type === 'js' || type === 'ts') {
       const compilerOut = path.resolve(ctx.workspacePath, ctx.compilerFolder, 'node_modules');
 
       const text = (await fs.readFile(inputFile, 'utf8'))
@@ -69,12 +89,16 @@ export class TranspileUtil {
         .replace(/from '(@travetto\/(.*?))'/g, (_, i, s) => `from '${path.resolve(compilerOut, `${i}${s.includes('/') ? '.js' : '/__index__.js'}`)}'`);
 
       const ts = (await import('typescript')).default;
-      const content = ts.transpile(text, await this.getCompilerOptions(ctx), inputFile);
+      const content = ts.transpile(text, {
+        ...await this.getCompilerOptions(ctx),
+        sourceMap: false,
+        inlineSourceMap: true,
+      }, inputFile);
       await this.writeTextFile(outputFile, content);
-    } else if (inputFile.endsWith('package.json')) {
+    } else if (type === 'package-json') {
       const pkg: Package = JSON.parse(await fs.readFile(inputFile, 'utf8'));
-      const main = pkg.main?.replace(/[.]ts$/, '.js');
-      const files = pkg.files?.map(x => x.replace('.ts', '.js'));
+      const main = pkg.main ? this.sourceToOutputExt(pkg.main) : undefined;
+      const files = pkg.files?.map(x => this.sourceToOutputExt(x));
 
       const content = JSON.stringify({ ...pkg, main, type: ctx.moduleType, files }, null, 2);
       await this.writeTextFile(outputFile, content);
@@ -107,10 +131,12 @@ export class TranspileUtil {
 
         if (stat.isDirectory()) {
           folders.push(resolvedInput);
-        } else if (file.endsWith('.d.ts')) {
-          // Do nothing
-        } else if (file.endsWith('.ts') || file.endsWith('.js')) {
-          files.push(resolvedInput);
+        } else {
+          switch (this.getFileType(file)) {
+            case 'js':
+            case 'ts':
+              files.push(resolvedInput);
+          }
         }
       }
     }
@@ -118,7 +144,7 @@ export class TranspileUtil {
     const outputFolder = path.resolve(ctx.workspacePath, ctx.compilerFolder, 'node_modules', module);
     const out: ModFile[] = [];
     for (const input of files) {
-      const output = input.replace(inputFolder, outputFolder).replace(/[.]ts$/, '.js');
+      const output = this.sourceToOutputExt(input.replace(inputFolder, outputFolder));
       const inputTs = await fs.stat(input).then(RECENT_STAT, () => 0);
       if (inputTs) {
         const outputTs = await fs.stat(output).then(RECENT_STAT, () => 0);

package/tsconfig.trv.json

@@ -6,6 +6,7 @@
     "lib": [
       "es2022"
     ],
+    "jsx": "react-jsx",
     "strict": true,
     "esModuleInterop": true,
     "strictPropertyInitialization": false,