@travetto/manifest 6.0.0-rc.1 → 6.0.0

package/README.md

@@ -43,7 +43,7 @@ Once the manifest is created, the application runtime can now read this manifest
    *  Providing contextual information when provided a filename, import name, etc (e.g. logging, testing output)
 
 ## Path Normalization
-By default, all paths within the framework are assumed to be in a POSIX style, and all input paths are converted to the POSIX style.  This works appropriately within a Unix and a Windows environment.  This module offers up [path](https://github.com/travetto/travetto/tree/main/module/manifest/src/path.ts#L9) as an equivalent to [Node](https://nodejs.org)'s [http](https://nodejs.org/api/path.html) library.  This allows for consistent behavior across all file-interactions.
+By default, all paths within the framework are assumed to be in a POSIX style, and all input paths are converted to the POSIX style.  This works appropriately within a Unix and a Windows environment.  This module offers up [path](https://github.com/travetto/travetto/tree/main/module/manifest/src/path.ts#L9) as an equivalent to [Node](https://nodejs.org)'s [path](https://nodejs.org/api/path.html) library.  This allows for consistent behavior across all file-interactions.
 
 ## Anatomy of a Manifest
 
@@ -171,6 +171,7 @@ The module files are a simple categorization of files into a predetermined set o
    *  `doc` - Documentation files. `DOC.tsx` and All .ts/.tsx 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/__index__.ts

@@ -1,12 +1,12 @@
-export * from './src/context';
-export * from './src/module';
-export * from './src/delta';
-export * from './src/manifest-index';
-export * from './src/package';
-export * from './src/util';
-export * from './src/file';
-export * from './src/types/context';
-export * from './src/types/package';
-export * from './src/types/manifest';
-export * from './src/types/common';
-export { path } from './src/path';
+export * from './src/context.ts';
+export * from './src/module.ts';
+export * from './src/delta.ts';
+export * from './src/manifest-index.ts';
+export * from './src/package.ts';
+export * from './src/util.ts';
+export * from './src/file.ts';
+export * from './src/types/context.ts';
+export * from './src/types/package.ts';
+export * from './src/types/manifest.ts';
+export * from './src/types/common.ts';
+export { path } from './src/path.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/manifest",
-  "version": "6.0.0-rc.1",
+  "version": "6.0.0",
   "description": "Support for project indexing, manifesting, along with file watching",
   "keywords": [
     "path",
@@ -26,7 +26,7 @@
     "node": ">=23.0.0"
   },
   "dependencies": {
-    "@types/node": "^22.13.0"
+    "@types/node": "^22.15.0"
   },
   "repository": {
     "url": "git+https://github.com/travetto/travetto.git",

package/src/context.ts

@@ -2,8 +2,8 @@ import { existsSync, readFileSync } from 'node:fs';
 import path from 'node:path';
 import { createRequire } from 'node:module';
 
-import type { Package } from './types/package';
-import type { ManifestContext } from './types/context';
+import type { Package } from './types/package.ts';
+import type { ManifestContext } from './types/context.ts';
 
 type Pkg = Package & { path: string };
 

package/src/delta.ts

@@ -1,11 +1,11 @@
 import fs from 'node:fs/promises';
 
-import { ManifestModuleUtil } from './module';
-import { path } from './path';
+import { ManifestModuleUtil } from './module.ts';
+import { path } from './path.ts';
 
-import type { ManifestModule, ManifestModuleCore, ManifestModuleFile, ManifestRoot } from './types/manifest';
-import type { ManifestModuleFileType, ManifestModuleFolderType } from './types/common';
-import type { ManifestContext } from './types/context';
+import type { ManifestModule, ManifestModuleCore, ManifestModuleFile, ManifestRoot } from './types/manifest.ts';
+import type { ManifestModuleFileType, ManifestModuleFolderType } from './types/common.ts';
+import type { ManifestContext } from './types/context.ts';
 
 type DeltaEventType = 'added' | 'changed' | 'removed' | 'missing' | 'dirty';
 type DeltaModule = ManifestModuleCore & { files: Record<string, ManifestModuleFile> };

package/src/dependencies.ts

@@ -1,9 +1,9 @@
-import { PackageUtil } from './package';
-import { path } from './path';
+import { PackageUtil } from './package.ts';
+import { path } from './path.ts';
 
-import type { Package, PackageDepType } from './types/package';
-import type { ManifestContext } from './types/context';
-import type { PackageModule } from './types/manifest';
+import type { Package, PackageDepType } from './types/package.ts';
+import type { ManifestContext } from './types/context.ts';
+import type { PackageModule } from './types/manifest.ts';
 
 type CreateOpts = Partial<Pick<PackageModule, 'main' | 'workspace' | 'prod'>> & { roleRoot?: boolean, parent?: PackageModule };
 
@@ -146,7 +146,7 @@ export class PackageModuleVisitor {
       dep.state.roleSet = new Set(['std']);
     }
 
-    return [...mods].sort((a, b) => a.name.localeCompare(b.name));
+    return [...mods].toSorted((a, b) => a.name.localeCompare(b.name));
   }
 
   /**

package/src/file.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs/promises';
 import { readFileSync } from 'node:fs';
 import os from 'node:os';
 
-import { path } from './path';
+import { path } from './path.ts';
 
 export class ManifestFileUtil {
   /**

package/src/manifest-index.ts

@@ -1,10 +1,10 @@
 import { existsSync } from 'node:fs';
 
-import { ManifestModuleUtil } from './module';
-import { path } from './path';
-import { ManifestUtil } from './util';
+import { ManifestModuleUtil } from './module.ts';
+import { path } from './path.ts';
+import { ManifestUtil } from './util.ts';
 
-import type { ManifestModule, ManifestRoot, ManifestModuleFile, IndexedModule, IndexedFile, FindConfig } from './types/manifest';
+import type { ManifestModule, ManifestRoot, ManifestModuleFile, IndexedModule, IndexedFile, FindConfig } from './types/manifest.ts';
 
 const TypedObject: {
   keys<T = unknown, K extends keyof T = keyof T>(o: T): K[];
@@ -57,7 +57,7 @@ export class ManifestIndex {
   }
 
   #moduleFiles(m: ManifestModule, files: ManifestModuleFile[]): IndexedFile[] {
-    return files.map(([f, type, ts, role = 'std']) => {
+    return files.map(([f, type, _ts, role = 'std']) => {
       const isSource = type === 'ts' || type === 'js';
       const sourceFile = path.resolve(this.#manifest.workspace.path, m.sourceFolder, f);
       const js = isSource ? ManifestModuleUtil.withOutputExtension(f) : f;
@@ -202,7 +202,7 @@ export class ManifestIndex {
   }
 
   /**
-   * Build module list from an expression list (e.g. `@travetto/rest,-@travetto/log)
+   * Build module list from an expression list (e.g. `@travetto/web,-@travetto/log)
    */
   getModuleList(mode: 'workspace' | 'all', exprList: string = ''): Set<string> {
     const allMods = Object.keys(this.#manifest.modules);

package/src/module.ts

@@ -1,11 +1,11 @@
 import fs from 'node:fs/promises';
 
-import { path } from './path';
-import { PackageModuleVisitor } from './dependencies';
+import { path } from './path.ts';
+import { PackageModuleVisitor } from './dependencies.ts';
 
-import type { ManifestModuleFileType, ManifestModuleRole, ManifestModuleFolderType } from './types/common';
-import type { ManifestModuleFile, ManifestModule, PackageModule } from './types/manifest';
-import type { ManifestContext } from './types/context';
+import type { ManifestModuleFileType, ManifestModuleRole, ManifestModuleFolderType } from './types/common.ts';
+import type { ManifestModuleFile, ManifestModule, PackageModule } from './types/manifest.ts';
+import type { ManifestContext } from './types/context.ts';
 
 const EXT_MAPPING: Record<string, ManifestModuleFileType> = {
   '.js': 'js',
@@ -41,6 +41,13 @@ const SUPPORT_FILE_RE = new RegExp(`^support[/](?<name>${Object.keys(SUPPORT_FIL
 
 export class ManifestModuleUtil {
 
+  static TYPINGS_EXT = '.d.ts';
+  static OUTPUT_EXT = '.js';
+  static SOURCE_DEF_EXT = '.ts';
+  static SOURCE_EXT_RE = /[.][cm]?[tj]sx?$/;
+  static TYPINGS_EXT_RE = /[.]d[.][cm]?ts$/;
+  static TYPINGS_WITH_MAP_EXT_RE = /[.]d[.][cm]?ts([.]map)?$/;
+
   static #scanCache: Record<string, string[]> = {};
 
   static #getNewest(stat: { mtimeMs: number, ctimeMs: number }): number {
@@ -51,7 +58,7 @@ export class ManifestModuleUtil {
    * Replace a source file's extension with a given value
    */
   static #pathToExtension(sourceFile: string, ext: string): string {
-    return sourceFile.replace(/[.][cm]?[tj]sx?$/, ext);
+    return sourceFile.replace(ManifestModuleUtil.SOURCE_EXT_RE, ext);
   }
 
   /**
@@ -127,7 +134,7 @@ export class ManifestModuleUtil {
       moduleFile.startsWith('support/resources/')
     ) {
       return 'fixture';
-    } else if (moduleFile.endsWith('.d.ts')) {
+    } else if (moduleFile.endsWith(this.TYPINGS_EXT)) {
       return 'typings';
     } else {
       const ext = path.extname(moduleFile);
@@ -216,8 +223,8 @@ export class ManifestModuleUtil {
 
     return {
       ...rest,
-      roles: [...state.roleSet].sort(),
-      parents: [...state.parentSet].sort(),
+      roles: [...state.roleSet].toSorted(),
+      parents: [...state.parentSet].toSorted(),
       files
     };
   }
@@ -235,17 +242,17 @@ export class ManifestModuleUtil {
    * Get the output file name for a given input
    */
   static withOutputExtension(sourceFile: string): string {
-    if (sourceFile.endsWith('.d.ts')) {
+    if (sourceFile.endsWith(this.TYPINGS_EXT)) {
       return sourceFile;
     }
-    return this.#pathToExtension(sourceFile, '.js');
+    return this.#pathToExtension(sourceFile, ManifestModuleUtil.OUTPUT_EXT);
   }
 
   /**
    * Get the file without an extension
    */
   static withoutSourceExtension(sourceFile: string): string {
-    if (sourceFile.endsWith('.d.ts')) {
+    if (sourceFile.endsWith(this.TYPINGS_EXT)) {
       return sourceFile;
     }
     return this.#pathToExtension(sourceFile, '');

package/src/package.ts

@@ -2,12 +2,12 @@ import { createRequire } from 'node:module';
 import { execSync } from 'node:child_process';
 import { existsSync } from 'node:fs';
 
-import { path } from './path';
-import { ManifestFileUtil } from './file';
+import { path } from './path.ts';
+import { ManifestFileUtil } from './file.ts';
 
-import { PackagePath, type Package, type PackageWorkspaceEntry } from './types/package';
-import type { ManifestContext } from './types/context';
-import type { NodePackageManager } from './types/common';
+import { PackagePathSymbol, type Package, type PackageWorkspaceEntry } from './types/package.ts';
+import type { ManifestContext } from './types/context.ts';
+import type { NodePackageManager } from './types/common.ts';
 
 /**
  * Utilities for querying, traversing and reading package.json files.
@@ -76,21 +76,21 @@ export class PackageUtil {
     if (forceRead) {
       delete this.#cache[modulePath];
     }
-    const res = this.#cache[modulePath] ??= ManifestFileUtil.readAsJsonSync(
+    const nodePackage = this.#cache[modulePath] ??= ManifestFileUtil.readAsJsonSync(
       modulePath.endsWith('.json') ? modulePath : path.resolve(modulePath, 'package.json'),
     );
 
-    res.name ??= 'untitled'; // If a package.json (root-only) is missing a name, allows for npx execution
+    nodePackage.name ??= 'untitled'; // If a package.json (root-only) is missing a name, allows for npx execution
 
-    res[PackagePath] = modulePath;
-    return res;
+    nodePackage[PackagePathSymbol] = modulePath;
+    return nodePackage;
   }
 
   /**
    * Get the package path
    */
   static getPackagePath(pkg: Package): string {
-    return pkg[PackagePath]!;
+    return pkg[PackagePathSymbol]!;
   }
 
   /**
@@ -105,8 +105,8 @@ export class PackageUtil {
         switch (ctx.workspace.manager) {
           case 'yarn':
           case 'npm': {
-            const res = await this.#exec<{ location: string, name: string }[]>(rootPath, 'npm query .workspace');
-            out = res.map(d => ({ path: path.resolve(ctx.workspace.path, d.location), name: d.name }));
+            const workspaces = await this.#exec<{ location: string, name: string }[]>(rootPath, 'npm query .workspace');
+            out = workspaces.map(d => ({ path: path.resolve(ctx.workspace.path, d.location), name: d.name }));
             break;
           }
         }

package/src/types/context.ts

@@ -1,4 +1,4 @@
-import type { NodeModuleType, NodePackageManager } from './common';
+import type { NodeModuleType, NodePackageManager } from './common.ts';
 
 export type ManifestContext = {
   workspace: {

package/src/types/manifest.ts

@@ -1,6 +1,6 @@
-import type { ManifestModuleFileType, ManifestModuleFolderType, ManifestModuleRole } from './common';
-import type { ManifestContext } from './context';
-import { Package } from './package';
+import type { ManifestModuleFileType, ManifestModuleFolderType, ManifestModuleRole } from './common.ts';
+import type { ManifestContext } from './context.ts';
+import { Package } from './package.ts';
 
 export type ManifestModuleFile =
   [path: string, type: ManifestModuleFileType, updated: number] |

package/src/types/package.ts

@@ -1,10 +1,10 @@
-import type { ManifestModuleRole, NodeModuleType } from './common';
-import type { ManifestContext } from './context';
+import type { ManifestModuleRole, NodeModuleType } from './common.ts';
+import type { ManifestContext } from './context.ts';
 
-export const PackagePath = Symbol.for('@travetto/manifest:package-path');
+export const PackagePathSymbol = Symbol.for('@travetto/manifest:package-path');
 
 export type Package = {
-  [PackagePath]?: string;
+  [PackagePathSymbol]?: string;
   name: string;
   type?: NodeModuleType;
   version: string;

package/src/util.ts

@@ -1,10 +1,10 @@
-import { path } from './path';
-import { ManifestModuleUtil } from './module';
-import { ManifestFileUtil } from './file';
-import { PackageUtil } from './package';
+import { path } from './path.ts';
+import { ManifestModuleUtil } from './module.ts';
+import { ManifestFileUtil } from './file.ts';
+import { PackageUtil } from './package.ts';
 
-import type { ManifestContext } from './types/context';
-import type { ManifestRoot } from './types/manifest';
+import type { ManifestContext } from './types/context.ts';
+import type { ManifestRoot } from './types/manifest.ts';
 
 const MANIFEST_FILE = 'manifest.json';