@travetto/manifest 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/manifest/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/manifest/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Manifest
+
 ## Support for project indexing, manifesting, along with file watching
 
 **Install: @travetto/manifest**
@@ -13,8 +14,6 @@ yarn add @travetto/manifest
 ```
 
 This module aims to be the boundary between the file system and the code.  The module provides:
-
-   
    *  Project Manifesting
    *  Manifest Delta
    *  Class and Function Metadata
@@ -26,7 +25,7 @@ This module aims to be the boundary between the file system and the code.  The m
 The project manifest fulfills two main goals: Compile-time Support, and Runtime Knowledge of the project.
 
 ### Compile-time Support
-During the compilation process, the compiler needs to know every file that is eligible for compilation, when the file was last created/modified, and any specific patterns for interacting with a given file (e.g. transformers vs. testing code vs. support files that happen to share a common extension with code). 
+During the compilation process, the compiler needs to know every file that is eligible for compilation, when the file was last created/modified, and any specific patterns for interacting with a given file (e.g. transformers vs. testing code vs. support files that happen to share a common extension with code).
 
 ### Runtime Knowledge
 Additionally, once the code has been compiled (or even bundled after that), the executing process needs to know what files are available for loading, and any patterns necessary for knowing which files to load versus which ones to ignore. This allows for dynamic loading of modules/files without knowledge/access to the file system, and in a more performant manner.
@@ -35,10 +34,9 @@ Additionally, once the code has been compiled (or even bundled after that), the
 During the compilation process, it is helpful to know how the output content differs from the manifest, which is produced from the source input. The [ManifestDeltaUtil](https://github.com/travetto/travetto/tree/main/module/manifest/src/delta.ts#L21) provides the functionality for a given manifest, and will produce a stream of changes grouped by module.  This is the primary input into the [Compiler](https://github.com/travetto/travetto/tree/main/module/compiler#readme "The compiler infrastructure for the Travetto framework")'s incremental behavior to know when a file has changed and needs to be recompiled.
 
 ## Class and Function Metadata
+For the framework to work properly, metadata needs to be collected about files, classes and functions to uniquely identify them, with support for detecting changes during live reloads.  To achieve this, every `class` is decorated with an additional field of `Ⲑid`.  `Ⲑid` represents a computed id that is tied to the file/class combination. 
 
-For the framework to work properly, metadata needs to be collected about files, classes and functions to uniquely identify them, with support for detecting changes during live reloads.  To achieve this, every `class` is decorated with an additional field of `Ⲑid`.  `Ⲑid` represents a computed id that is tied to the file/class combination.
-
-`Ⲑid` is used heavily throughout the framework for determining which classes are owned by the framework, and being able to lookup the needed data from the [RootIndex](https://github.com/travetto/travetto/tree/main/module/manifest/src/root-index.ts) using the `getFunctionMetadata` method.
+`Ⲑid` is used heavily throughout the framework for determining which classes are owned by the framework, and being able to lookup the needed data from the [RootIndex](https://github.com/travetto/travetto/tree/main/module/manifest/src/root-index.ts#L12) using the `getFunctionMetadata` method.
 
 **Code: Test Class**
 ```typescript
@@ -78,7 +76,6 @@ $ trv main ./doc/lookup.ts
 
 ## Module Indexing
 Once the manifest is created, the application runtime can now read this manifest, which allows for influencing runtime behavior. The most common patterns include:
-   
    *  Loading all source files
    *  Iterating over every test file
    *  Finding all source folders for watching
@@ -168,7 +165,7 @@ This method allows for watching one or more folders, and registering a callback
           [ "README.md", "md", 1868155200000 ]
         ],
         "doc": [
-          [ "DOC.ts", "ts", 1868155200000, "doc" ],
+          [ "DOC.tsx", "ts", 1868155200000, "doc" ],
           [ "doc/lookup.ts", "ts", 1868155200000, "doc" ],
           [ "doc/test-class.ts", "ts", 1868155200000, "doc" ]
         ],
@@ -214,25 +211,21 @@ This method allows for watching one or more folders, and registering a callback
 ```
 
 ### General Context
-The general context describes the project-space and any important information for how to build/execute the code.
+The general context describes the project-space and any important information for how to build/execute the code. 
 
 The context contains:
-   
    *  A generated timestamp
-   *  Module Type: [commonjs](https://nodejs.org/api/modules.html) or [module](https://nodejs.org/api/esm.html)
-   *  The main module to execute. **Note**: This primarily pertains to mono-repo support when there are multiple modules in the project
+   *  Module Type: `commonjs`([CommonJS](https://nodejs.org/api/modules.html)) or `module`([Ecmascript Module](https://nodejs.org/api/esm.html))
+   *  The main module to execute. (*This primarily pertains to mono-repo support when there are multiple modules in the project*)
    *  The root path of the project/workspace
-   *  Whether or not the project is a mono-repo. **Note**: This is determined by using the 'workspaces' field in your [object Object]
-   *  The location where all compiled code will be stored.  Defaults to: `.trv_output`.  **Note**: Can be overridden in your [object Object] in 'travetto.outputFolder'
+   *  Whether or not the project is a mono-repo. (*This is determined by using the 'workspaces' field in your [Package JSON](https://docs.npmjs.com/cli/v9/configuring-npm/package-json)*)
+   *  The location where all compiled code will be stored.  Defaults to: `.trv_output`. (*Can be overridden in your [Package JSON](https://docs.npmjs.com/cli/v9/configuring-npm/package-json) in 'travetto.outputFolder'*)
    *  The location where the intermediate compiler will be created. Defaults to: `.trv_compiler`
    *  The location where tooling will be able to write to. Defaults to: `.trv_output`
    *  Which package manager is in use [Npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or [Yarn](https://yarnpg.com)
 
 ### Modules
-The modules represent all of the [Travetto](https://travetto.dev)-aware dependencies (including dev dependencies) used for compiling, testing and executing.  A prod-only version is produced when packaging the final output.
-
-Each module contains:
-   
+The modules represent all of the [Travetto](https://travetto.dev)-aware dependencies (including dev dependencies) used for compiling, testing and executing.  A prod-only version is produced when packaging the final output. Each module contains:
    *  The dependency npm name
    *  The dependency version
    *  A flag to determine if its a local module
@@ -245,7 +238,6 @@ Each module contains:
 
 ### Module Files
 The module files are a simple categorization of files into a predetermined set of folders:
-   
    *  $root - All uncategorized files at the module root
    *  $index - __index__.ts, index.ts files at the root of the project
    *  $package - The [Package JSON](https://docs.npmjs.com/cli/v9/configuring-npm/package-json) for the project
@@ -259,7 +251,6 @@ The module files are a simple categorization of files into a predetermined set o
    *  doc - Documentation files. All .ts files under the doc/ folder
    *  $transformer - All .ts files under the pattern support/transform*.  These are used during compilation and never at runtime
    *  bin - Entry point .js files.  All .js files under the bin/ folder
-
 Within each file there is a pattern of either a 3 or 4 element array:
 
 **Code: Sample file**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/manifest",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Support for project indexing, manifesting, along with file watching",
   "keywords": [
     "path",

package/src/delta.ts

@@ -36,15 +36,18 @@ export class ManifestDeltaUtil {
     const root = `${ctx.workspacePath}/${ctx.outputFolder}/${left.outputFolder}`;
     const right = new Set(
       (await ManifestModuleUtil.scanFolder(root, left.main))
-        .filter(x => (x.endsWith('.ts') || x.endsWith('.js') || x.endsWith('package.json')))
-        .map(x => x.replace(`${root}/`, '').replace(/[.][tj]s$/, ''))
+        .filter(x => {
+          const type = ManifestModuleUtil.getFileType(x);
+          return type === 'ts' || type === 'typings' || type === 'js' || type === 'package-json';
+        })
+        .map(x => ManifestModuleUtil.sourceToBlankExt(x.replace(`${root}/`, '')))
     );
 
     for (const el of Object.keys(left.files)) {
-      const output = `${outputFolder}/${left.outputFolder}/${el.replace(/[.]ts$/, '.js')}`;
+      const output = ManifestModuleUtil.sourceToOutputExt(`${outputFolder}/${left.outputFolder}/${el}`);
       const [, , leftTs] = left.files[el];
       const stat = await fs.stat(output).catch(() => { });
-      right.delete(el.replace(/[.][tj]s$/, ''));
+      right.delete(ManifestModuleUtil.sourceToBlankExt(el));
 
       if (!stat) {
         add(el, 'added');

package/src/manifest-index.ts

@@ -1,3 +1,4 @@
+import { ManifestModuleUtil } from './module';
 import { path } from './path';
 
 import {
@@ -78,13 +79,14 @@ export class ManifestIndex {
 
   #moduleFiles(m: ManifestModule, files: ManifestModuleFile[]): IndexedFile[] {
     return files.map(([f, type, ts, profile = 'std']) => {
+      const isSource = type === 'ts' || type === 'js';
       const sourceFile = path.resolve(this.#manifest.workspacePath, m.sourceFolder, f);
-      const js = (type === 'ts' ? f.replace(/[.]ts$/, '.js') : f);
+      const js = isSource ? ManifestModuleUtil.sourceToOutputExt(f) : f;
       const outputFile = this.#resolveOutput(m.outputFolder, js);
       const modImport = `${m.name}/${js}`;
       let id = modImport.replace(`${m.name}/`, _ => _.replace(/[/]$/, ':'));
-      if (type === 'ts' || type === 'js') {
-        id = id.replace(/[.]js$/, '');
+      if (isSource) {
+        id = ManifestModuleUtil.sourceToBlankExt(id);
       }
 
       return { id, type, sourceFile, outputFile, import: modImport, profile, relativeFile: f, module: m.name };
@@ -117,7 +119,6 @@ export class ManifestIndex {
           this.#sourceToEntry.set(entry.sourceFile, entry);
           this.#importToEntry.set(entry.import, entry);
           this.#importToEntry.set(entry.import.replace(/[.]js$/, ''), entry);
-          this.#importToEntry.set(entry.import.replace(/[.]js$/, '.ts'), entry);
         }
       }
     }
@@ -221,7 +222,7 @@ export class ManifestIndex {
    * Resolve import
    */
   resolveFileImport(name: string): string {
-    return this.#importToEntry.get(name)?.outputFile ?? name;
+    return this.getFromImport(name)?.outputFile ?? name;
   }
 
   /**
@@ -237,6 +238,8 @@ export class ManifestIndex {
    * @param source
    */
   getFromImport(imp: string): IndexedFile | undefined {
+    // Strip ext
+    imp = ManifestModuleUtil.sourceToBlankExt(imp);
     return this.#importToEntry.get(imp);
   }
 

package/src/module.ts

@@ -15,17 +15,15 @@ const EXT_MAPPING: Record<string, ManifestModuleFileType> = {
   '.cjs': 'js',
   '.json': 'json',
   '.ts': 'ts',
+  '.tsx': 'ts',
   '.md': 'md'
 };
 
-const INDEX_FILES = new Set([
-  'index.ts',
-  'index.js',
-  '__index__.ts',
-  '__index__.js',
-  '__index.ts',
-  '__index.js'
-]);
+const INDEX_FILES = new Set(
+  ['__index__', '__index', 'index', 'jsx-runtime'].flatMap(f =>
+    ['ts', 'tsx', 'js'].map(ext => `${f}.${ext}`)
+  )
+);
 
 export class ManifestModuleUtil {
 
@@ -35,6 +33,13 @@ export class ManifestModuleUtil {
     return Math.max(stat.mtimeMs, stat.ctimeMs);
   }
 
+  /**
+   * Replace a source file's extension with a given value
+   */
+  static #sourceToExtension(inputFile: string, ext: string): string {
+    return inputFile.replace(/[.][tj]sx?$/, ext);
+  }
+
   /**
    * Simple file scanning
    */
@@ -93,7 +98,7 @@ export class ManifestModuleUtil {
    * Get file type for a file name
    */
   static getFileType(moduleFile: string): ManifestModuleFileType {
-    if (moduleFile === 'package.json') {
+    if (moduleFile.endsWith('package.json')) {
       return 'package-json';
     } else if (
       moduleFile.startsWith('support/fixtures/') ||
@@ -117,7 +122,7 @@ export class ManifestModuleUtil {
       return 'compile';
     } else if (moduleFile.startsWith('support/test/') || moduleFile.startsWith('test/')) {
       return 'test';
-    } else if (moduleFile.startsWith('doc/') || moduleFile === 'DOC.ts') {
+    } else if (moduleFile.startsWith('doc/') || /^DOC[.]tsx?$/.test(moduleFile)) {
       return 'doc';
     } else {
       return;
@@ -149,7 +154,7 @@ export class ManifestModuleUtil {
         case 'support': return key;
         default: return '$other';
       }
-    } else if (moduleFile === 'DOC.ts') {
+    } else if (/^DOC[.]tsx?$/.test(moduleFile)) {
       return 'doc';
     } else if (INDEX_FILES.has(moduleFile)) {
       return '$index';
@@ -210,4 +215,18 @@ export class ManifestModuleUtil {
     const modules = await Promise.all(sorted.map(x => this.describeModule(ctx, x)));
     return Object.fromEntries(modules.map(m => [m.name, m]));
   }
+
+  /**
+   * Get the output file name for a given input
+   */
+  static sourceToOutputExt(inputFile: string): string {
+    return this.#sourceToExtension(inputFile, '.js');
+  }
+
+  /**
+   * Get the file without an extension
+   */
+  static sourceToBlankExt(inputFile: string): string {
+    return this.#sourceToExtension(inputFile, '');
+  }
 }