@travetto/manifest 7.0.0-rc.1 → 7.0.0-rc.3

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 [path](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#L46) 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
 
@@ -56,7 +56,6 @@ By default, all paths within the framework are assumed to be in a POSIX style, a
     "path": "<generated>",
     "mono": true,
     "manager": "npm",
-    "type": "commonjs",
     "defaultEnv": "local"
   },
   "build": {
@@ -132,7 +131,6 @@ The general context describes the project-space and any important information fo
 
 The context contains:
    *  A generated timestamp
-   *  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. (*This is determined by using the 'workspaces' field in your [Package JSON](https://docs.npmjs.com/cli/v9/configuring-npm/package-json)*)

package/__index__.ts

@@ -9,4 +9,4 @@ 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';
+export { default as path } from './src/path.ts';

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@travetto/manifest",
-  "version": "7.0.0-rc.1",
+  "version": "7.0.0-rc.3",
+  "type": "module",
   "description": "Support for project indexing, manifesting, along with file watching",
   "keywords": [
     "path",

package/src/context.ts

@@ -53,13 +53,17 @@ export function getManifestContext(root: string = process.cwd()): ManifestContex
     readPackage(resolve(`${process.env.TRV_MODULE}/package.json`)) :
     findPackage(root, pkg => !!pkg) ?? workspace;
 
+  if (workspace.type !== 'module') {
+    console.error('ERROR: Only ESM modules are supported, package.json must be of type module');
+    process.exit(1);
+  }
+
   return {
     workspace: {
       name: workspace.name ?? 'untitled',
       path: workspace.path,
       mono: !!workspace.workspaces,
       manager: existsSync(path.resolve(workspace.path, 'yarn.lock')) ? 'yarn' : 'npm',
-      type: workspace.type ?? 'commonjs',
       defaultEnv: workspace.travetto?.defaultEnv ?? 'local'
     },
     build: {

package/src/delta.ts

@@ -1,13 +1,13 @@
 import fs from 'node:fs/promises';
 
 import { ManifestModuleUtil } from './module.ts';
-import { path } from './path.ts';
+import path from './path.ts';
 
 import type { ManifestModule, ManifestModuleCore, ManifestModuleFile, ManifestRoot } from './types/manifest.ts';
-import type { ManifestModuleFileType, ManifestModuleFolderType } from './types/common.ts';
+import type { ChangeEventType, ManifestModuleFileType, ManifestModuleFolderType } from './types/common.ts';
 import type { ManifestContext } from './types/context.ts';
 
-type DeltaEventType = 'added' | 'changed' | 'removed' | 'missing' | 'dirty';
+type DeltaEventType = ChangeEventType | 'missing' | 'dirty';
 type DeltaModule = ManifestModuleCore & { files: Record<string, ManifestModuleFile> };
 export type DeltaEvent = { file: string, type: DeltaEventType, module: string, sourceFile: string };
 
@@ -52,17 +52,17 @@ export class ManifestDeltaUtil {
       right.delete(ManifestModuleUtil.withoutSourceExtension(file));
 
       if (!stat) {
-        add(file, 'added');
+        add(file, 'create');
       } else {
         const rightTimestamp = this.#getNewest(stat);
         if (leftTimestamp > rightTimestamp) {
-          add(file, 'changed');
+          add(file, 'update');
         }
       }
     }
     // Deleted
     for (const file of right) {
-      add(file, 'removed');
+      add(file, 'delete');
     }
     return out;
   }

package/src/dependencies.ts

@@ -1,5 +1,5 @@
 import { PackageUtil } from './package.ts';
-import { path } from './path.ts';
+import path from './path.ts';
 
 import type { Package, PackageDependencyType } from './types/package.ts';
 import type { ManifestContext } from './types/context.ts';

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.ts';
+import path from './path.ts';
 
 export class ManifestFileUtil {
   /**
@@ -16,13 +16,6 @@ export class ManifestFileUtil {
     await fs.rm(temp, { force: true });
   }
 
-  /**
-   * Read as json
-   */
-  static async readAsJson<T = unknown>(file: string): Promise<T> {
-    return JSON.parse(await fs.readFile(file, 'utf8'));
-  }
-
   /**
    * Read as json, sync
    */

package/src/manifest-index.ts

@@ -1,7 +1,7 @@
 import { existsSync } from 'node:fs';
 
 import { ManifestModuleUtil } from './module.ts';
-import { path } from './path.ts';
+import path from './path.ts';
 import { ManifestUtil } from './util.ts';
 
 import type { ManifestModule, ManifestRoot, ManifestModuleFile, IndexedModule, IndexedFile, FindConfig } from './types/manifest.ts';
@@ -192,6 +192,14 @@ export class ManifestIndex {
     return this.#importToEntry.get(imp);
   }
 
+  /**
+   * Get from import path or source file
+   * @param importOrSource
+   */
+  getFromImportOrSource(importOrSource: string): IndexedFile | undefined {
+    return this.getFromImport(importOrSource) ?? this.getFromSource(path.resolve(importOrSource));
+  }
+
   /**
    * Get module from source file
    * @param source
@@ -256,6 +264,15 @@ export class ManifestIndex {
     return lookup(file.replace(`${base}/`, '').split('/'));
   }
 
+  /**
+   * Find the module for an arbitrary import
+   */
+  findModuleForArbitraryImport(imp: string): IndexedModule | undefined {
+    const importParts = imp.split('/');
+    const module = imp.startsWith('@') ? importParts.slice(0, 2).join('/') : importParts[0];
+    return this.getModule(module);
+  }
+
   /**
    * Get manifest module by name
    */

package/src/module.ts

@@ -1,6 +1,6 @@
 import fs from 'node:fs/promises';
 
-import { path } from './path.ts';
+import path from './path.ts';
 import { PackageModuleVisitor } from './dependencies.ts';
 
 import type { ManifestModuleFileType, ManifestModuleRole, ManifestModuleFolderType } from './types/common.ts';
@@ -18,7 +18,7 @@ const EXT_MAPPING: Record<string, ManifestModuleFileType> = {
 };
 
 const INDEX_FILES = new Set(
-  ['__index__', '__index', 'index', 'jsx-runtime'].flatMap(file =>
+  ['__index__', '__index', 'index'].flatMap(file =>
     ['ts', 'tsx', 'js'].map(ext => `${file}.${ext}`)
   )
 );

package/src/package.ts

@@ -2,7 +2,7 @@ import { createRequire } from 'node:module';
 import { execSync } from 'node:child_process';
 import { existsSync } from 'node:fs';
 
-import { path } from './path.ts';
+import path from './path.ts';
 import { ManifestFileUtil } from './file.ts';
 
 import { PackagePathSymbol, type Package, type PackageWorkspaceEntry } from './types/package.ts';
@@ -99,20 +99,21 @@ export class PackageUtil {
   static async resolveWorkspaces(ctx: ManifestContext): Promise<PackageWorkspaceEntry[]> {
     const rootPath = ctx.workspace.path;
     const cache = path.resolve(rootPath, ctx.build.outputFolder, 'workspaces.json');
-    return this.#workspaces[rootPath] ??= await ManifestFileUtil.readAsJson<PackageWorkspaceEntry[]>(cache)
-      .catch(async () => {
-        let out: PackageWorkspaceEntry[];
-        switch (ctx.workspace.manager) {
-          case 'yarn':
-          case 'npm': {
-            const workspaces = await this.#exec<{ location: string, name: string }[]>(rootPath, 'npm query .workspace');
-            out = workspaces.map(mod => ({ path: path.resolve(ctx.workspace.path, mod.location), name: mod.name }));
-            break;
-          }
+    try {
+      return this.#workspaces[rootPath] ??= ManifestFileUtil.readAsJsonSync<PackageWorkspaceEntry[]>(cache);
+    } catch {
+      let out: PackageWorkspaceEntry[];
+      switch (ctx.workspace.manager) {
+        case 'yarn':
+        case 'npm': {
+          const workspaces = await this.#exec<{ location: string, name: string }[]>(rootPath, 'npm query .workspace');
+          out = workspaces.map(mod => ({ path: path.resolve(ctx.workspace.path, mod.location), name: mod.name }));
+          break;
         }
-        await ManifestFileUtil.bufferedFileWrite(cache, JSON.stringify(out));
-        return out;
-      });
+      }
+      await ManifestFileUtil.bufferedFileWrite(cache, JSON.stringify(out));
+      return out;
+    }
   }
 
   /**

package/src/path.ts

@@ -6,8 +6,8 @@ const toPosix = (file: string): string => file.replaceAll('\\', '/');
 const toNative = (file: string): string => file.replace(/[\/]/g, native.sep);
 const cwd = (): string => toPosix(process.cwd());
 
-export const path: posix.PlatformPath & {
-  native: posix.PlatformPath;
+const path: typeof posix & {
+  native: typeof posix;
   toPosix: typeof toPosix;
   toNative: typeof toNative;
 } = {

package/src/types/common.ts

@@ -1,4 +1,3 @@
-export type NodeModuleType = 'module' | 'commonjs';
 export type NodePackageManager = 'yarn' | 'npm';
 
 export type ManifestModuleFileType = 'typings' | 'ts' | 'js' | 'json' | 'package-json' | 'unknown' | 'fixture' | 'md';
@@ -8,4 +7,6 @@ export type ManifestModuleFolderType =
   'test/fixtures' | 'support/fixtures' | 'support/resources' |
   '$transformer';
 
-export type ManifestModuleRole = 'std' | 'test' | 'doc' | 'compile' | 'build';
+export type ManifestModuleRole = 'std' | 'test' | 'doc' | 'compile' | 'build';
+
+export type ChangeEventType = 'create' | 'update' | 'delete';

package/src/types/context.ts

@@ -1,4 +1,4 @@
-import type { NodeModuleType, NodePackageManager } from './common.ts';
+import type { NodePackageManager } from './common.ts';
 
 export type ManifestContext = {
   workspace: {
@@ -8,8 +8,6 @@ export type ManifestContext = {
     name: string;
     /** Is the workspace a monorepo? */
     mono?: boolean;
-    /** The module type of the workspace */
-    type: NodeModuleType;
     /** The package manager of the workspace */
     manager: NodePackageManager;
     /** The default env name */

package/src/types/package.ts

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

package/src/util.ts

@@ -1,4 +1,4 @@
-import { path } from './path.ts';
+import path from './path.ts';
 import { ManifestModuleUtil } from './module.ts';
 import { ManifestFileUtil } from './file.ts';
 import { PackageUtil } from './package.ts';