@travetto/transformer 3.0.2 → 3.1.0-rc.0

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/transformer/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/transformer/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Transformation
+
 ## Functionality for AST transformations, with transformer registration, and general utils
 
 **Install: @travetto/transformer**
@@ -14,16 +15,15 @@ yarn add @travetto/transformer
 
 This module provides support for enhanced AST transformations, and declarative transformer registration, with common patterns to support all the transformers used throughout the framework. Transformations are located by `support/transformer.<name>.ts` as the filename. 
 
-The module is primarily aimed at extremely advanced usages for things that cannot be detected at runtime.  The [Registry](https://github.com/travetto/travetto/tree/main/module/registry#readme "Patterns and utilities for handling registration of metadata and functionality for run-time use") module already has knowledge of all `class`es and `field`s, and is able to listen to changes there.  Many of the modules build upon work by some of the foundational transformers defined in [Manifest](https://github.com/travetto/travetto/tree/main/module/manifest#readme "Support for project indexing, manifesting, along with file watching"), [Registry](https://github.com/travetto/travetto/tree/main/module/registry#readme "Patterns and utilities for handling registration of metadata and functionality for run-time use"), [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.") and [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.").  These all center around defining a registry of classes, and associated type information.
+The module is primarily aimed at extremely advanced usages for things that cannot be detected at runtime.  The [Registry](https://github.com/travetto/travetto/tree/main/module/registry#readme "Patterns and utilities for handling registration of metadata and functionality for run-time use") module already has knowledge of all `class`es and `field`s, and is able to listen to changes there.  Many of the modules build upon work by some of the foundational transformers defined in [Manifest](https://github.com/travetto/travetto/tree/main/module/manifest#readme "Support for project indexing, manifesting, along with file watching"), [Registry](https://github.com/travetto/travetto/tree/main/module/registry#readme "Patterns and utilities for handling registration of metadata and functionality for run-time use"), [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.") and [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.").  These all center around defining a registry of classes, and associated type information. 
 
-Because working with the [Typescript](https://typescriptlang.org) API can be delicate (and open to breaking changes), creating new transformers should be done cautiously. 
+Because working with the [Typescript](https://typescriptlang.org) API can be delicate (and open to breaking changes), creating new transformers should be done cautiously.
 
 ## Monorepos and Idempotency
 Within the framework, any build or compile step will target the entire workspace, and for mono-repo projects, will include all modules.  The optimization this provides is great, but comes with a strict requirement that all compilation processes need to be idempotent.  This means that compiling a module directly, versus as a dependency should always produce the same output. This produces a requirement that all transformers are opt-in by the source code, and which transformers are needed in a file should be code-evident.  This also means that no transformers are optional, as that could produce different output depending on the dependency graph for a given module.
 
 ## Custom Transformer
-
-Below is an example of a transformer that upper cases all `class`, `method` and `param` declarations.  This will break any code that depends upon it as we are redefining all the identifiers at compile time.  
+Below is an example of a transformer that upper cases all `class`, `method` and `param` declarations.  This will break any code that depends upon it as we are redefining all the identifiers at compile time.
 
 **Code: Sample Transformer - Upper case all declarations**
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/transformer",
-  "version": "3.0.2",
+  "version": "3.1.0-rc.0",
   "description": "Functionality for AST transformations, with transformer registration, and general utils",
   "keywords": [
     "typescript",
@@ -24,9 +24,9 @@
     "directory": "module/transformer"
   },
   "dependencies": {
-    "@travetto/manifest": "^3.0.2",
+    "@travetto/manifest": "^3.1.0-rc.0",
     "tslib": "^2.5.0",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.2"
   },
   "travetto": {
     "displayName": "Transformation",

package/src/resolver/service.ts

@@ -1,6 +1,6 @@
 import ts from 'typescript';
 
-import { ManifestIndex, path } from '@travetto/manifest';
+import { ManifestIndex, ManifestModuleUtil, path } from '@travetto/manifest';
 
 import type { AnyType, TransformResolver } from './types';
 import { TypeCategorize, TypeBuilder } from './builder';
@@ -34,16 +34,18 @@ export class SimpleResolver implements TransformResolver {
   getFileImportName(file: string, removeExt?: boolean): string {
     let sourceFile = path.toPosix(file);
 
-    if (!sourceFile.endsWith('.js') && !sourceFile.endsWith('.ts')) {
+    const type = ManifestModuleUtil.getFileType(file);
+
+    if (type !== 'js' && type !== 'ts') {
       sourceFile = `${sourceFile}.ts`;
     }
 
     const imp =
-      this.#manifestIndex.getEntry(/[.]ts$/.test(sourceFile) ? sourceFile : `${sourceFile}.js`)?.import ??
-      this.#manifestIndex.getFromImport(sourceFile.replace(/^.*node_modules\//, '').replace(/[.]ts$/, ''))?.import ??
+      this.#manifestIndex.getEntry(ManifestModuleUtil.getFileType(sourceFile) === 'ts' ? sourceFile : `${sourceFile}.js`)?.import ??
+      this.#manifestIndex.getFromImport(ManifestModuleUtil.sourceToBlankExt(sourceFile).replace(/^.*node_modules\//, ''))?.import ??
       file;
 
-    return removeExt ? imp.replace(/[.]js$/, '') : imp;
+    return removeExt ? ManifestModuleUtil.sourceToBlankExt(imp) : imp;
   }
 
   /**

package/src/util/doc.ts

@@ -12,7 +12,7 @@ export class DocUtil {
    * See if node has js docs
    */
   static hasJSDoc(o: ts.Node): o is (ts.Node & { jsDoc: ts.JSDoc[] }) {
-    return 'jsDoc' in o;
+    return 'jsDoc' in o && o.jsDoc !== null && o.jsDoc !== undefined && Array.isArray(o.jsDoc) && o.jsDoc.length > 0;
   }
 
   /**

package/src/util/import.ts

@@ -1,6 +1,6 @@
 import ts from 'typescript';
 
-import { PackageUtil, path } from '@travetto/manifest';
+import { ManifestModuleUtil, PackageUtil, path } from '@travetto/manifest';
 
 import { Import } from '../types/shared';
 
@@ -12,7 +12,7 @@ export class ImportUtil {
    * useful for handling failed imports, but still transpiling
    */
   static optionalResolve(file: string, base?: string): string {
-    if (base?.endsWith('.ts')) {
+    if (base && ManifestModuleUtil.getFileType(base) === 'ts') {
       base = path.dirname(base);
     }
     if (base && file.startsWith('.')) {

package/src/visitor.ts

@@ -2,6 +2,7 @@ import ts from 'typescript';
 
 import { DecoratorMeta, TransformerType, NodeTransformer, TransformerSet, State, TransformPhase } from './types/visitor';
 import { CoreUtil } from './util/core';
+import { ManifestModuleUtil } from '@travetto/manifest';
 
 /**
  * AST Visitor Factory, combines all active transformers into a single pass transformer for the ts compiler
@@ -77,7 +78,8 @@ export class VisitorFactory<S extends State = State> {
    */
   visitor(): ts.TransformerFactory<ts.SourceFile> {
     return (context: ts.TransformationContext) => (file: ts.SourceFile): ts.SourceFile => {
-      if (!file.fileName.endsWith('.ts')) { // Skip all non-ts files
+      const type = ManifestModuleUtil.getFileType(file.fileName);
+      if (type !== 'ts') { // Skip all non-ts files
         return file;
       }