@travetto/manifest 3.1.0-rc.0 → 3.1.0-rc.1

package/README.md

@@ -36,7 +36,7 @@ During the compilation process, it is helpful to know how the output content dif
 ## 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. 
 
-`Ⲑ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.
+`Ⲑ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#L11) using the `getFunctionMetadata` method.
 
 **Code: Test Class**
 ```typescript
@@ -153,6 +153,9 @@ export function watchFolders(
   "toolFolder": ".trv_build",
   "compilerFolder": ".trv_compiler",
   "packageManager": "npm",
+  "version": "3.1.0-rc.0",
+  "description": "Support for project indexing, manifesting, along with file watching",
+  "frameworkVersion": "3.1.0-rc.0",
   "modules": {
     "@travetto/manifest": {
       "main": true,

package/bin/context.js

@@ -81,6 +81,7 @@ async function $getWorkspaceRoot(base = process.cwd()) {
  */
 export async function getManifestContext(folder) {
   const workspacePath = path.resolve(await $getWorkspaceRoot(folder));
+  const req = createRequire(`${workspacePath}/node_modules`);
 
   // If manifest specified via env var, and is a package name
   if (!folder && process.env.TRV_MODULE) {
@@ -88,7 +89,6 @@ export async function getManifestContext(folder) {
     if (/[.](t|j)s$/.test(process.env.TRV_MODULE)) {
       process.env.TRV_MODULE = await $getModuleFromFile(process.env.TRV_MODULE) ?? process.env.TRV_MODULE;
     }
-    const req = createRequire(`${workspacePath}/node_modules`);
     try {
       folder = path.dirname(req.resolve(`${process.env.TRV_MODULE}/package.json`));
     } catch {
@@ -102,7 +102,7 @@ export async function getManifestContext(folder) {
   }
 
   const mainPath = await $getModuleRoot(path.resolve(folder ?? '.'));
-  const { name: mainModule, workspaces, travetto } = (await $getPkg(mainPath));
+  const { name: mainModule, workspaces, travetto, version, description } = (await $getPkg(mainPath));
   const monoRepo = workspacePath !== mainPath || !!workspaces;
   const outputFolder = travetto?.outputFolder ?? '.trv_output';
 
@@ -111,6 +111,8 @@ export async function getManifestContext(folder) {
   /** @type {'yarn'|'npm'} */
   const packageManager = await fs.stat(path.resolve(workspacePath, 'yarn.lock')).then(() => 'yarn', () => 'npm');
 
+  const { version: frameworkVersion } = JSON.parse(await fs.readFile(req.resolve('@travetto/manifest/package.json'), 'utf8'));
+
   const res = {
     moduleType,
     mainModule: mainModule ?? 'untitled', // When root package.json is missing a name
@@ -120,7 +122,10 @@ export async function getManifestContext(folder) {
     outputFolder,
     toolFolder: '.trv_build',
     compilerFolder: '.trv_compiler',
-    packageManager
+    packageManager,
+    version,
+    description,
+    frameworkVersion
   };
   return res;
 }

package/package.json

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

package/src/package.ts

@@ -3,13 +3,15 @@ import fs from 'fs/promises';
 import { createRequire } from 'module';
 import { execSync } from 'child_process';
 
-import { ManifestContext, Package, PackageDigest, PackageRel, PackageVisitor, PackageVisitReq, PackageWorkspaceEntry } from './types';
+import { ManifestContext, Package, PackageRel, PackageVisitor, PackageVisitReq, PackageWorkspaceEntry } from './types';
 import { path } from './path';
 
+/**
+ * Utilities for querying, traversing and reading package.json files.
+ */
 export class PackageUtil {
 
   static #req = createRequire(path.resolve('node_modules'));
-  static #framework: Package;
   static #cache: Record<string, Package> = {};
   static #workspaces: Record<string, PackageWorkspaceEntry[]> = {};
 
@@ -114,18 +116,6 @@ export class PackageUtil {
     return this.readPackage(this.resolvePackagePath(moduleName));
   }
 
-  /**
-   * Write package
-   */
-  static async writePackageIfChanged(modulePath: string, pkg: Package): Promise<void> {
-    const final = JSON.stringify(pkg, null, 2);
-    const target = path.resolve(modulePath, 'package.json');
-    const current = (await fs.readFile(target, 'utf8').catch(() => '')).trim();
-    if (final !== current) {
-      await fs.writeFile(target, `${final}\n`, 'utf8');
-    }
-  }
-
   /**
    * Visit packages with ability to track duplicates
    */
@@ -164,21 +154,6 @@ export class PackageUtil {
     return (await visitor.complete?.(out)) ?? out;
   }
 
-  /**
-   * Get version of manifest package
-   */
-  static getFrameworkVersion(): string {
-    return (this.#framework ??= this.importPackage('@travetto/manifest')).version;
-  }
-
-  /**
-   * Produce simple digest of
-   */
-  static digest(pkg: Package): PackageDigest {
-    const { main, name, author, license, version } = pkg;
-    return { name, main, author, license, version, framework: this.getFrameworkVersion() };
-  }
-
   /**
    * Find workspace values from rootPath
    */
@@ -210,34 +185,4 @@ export class PackageUtil {
     }
     return this.#workspaces[rootPath];
   }
-
-  /**
-   * Sync versions across a series of folders
-   */
-  static async syncVersions(folders: string[], versionMapping: Record<string, string> = {}): Promise<void> {
-    const packages = folders.map(folder => {
-      const pkg = this.readPackage(folder, true);
-      versionMapping[pkg.name] = `^${pkg.version}`;
-      return { folder, pkg };
-    });
-
-    for (const { pkg } of packages) {
-      for (const group of [
-        pkg.dependencies ?? {},
-        pkg.devDependencies ?? {},
-        pkg.optionalDependencies ?? {},
-        pkg.peerDependencies ?? {}
-      ]) {
-        for (const [mod, ver] of Object.entries(versionMapping)) {
-          if (mod in group && !/^[*]|(file:.*)$/.test(group[mod])) {
-            group[mod] = ver;
-          }
-        }
-      }
-    }
-
-    for (const { folder, pkg } of packages) {
-      await this.writePackageIfChanged(folder, pkg);
-    }
-  }
 }

package/src/root-index.ts

@@ -1,7 +1,6 @@
 import { path } from './path';
 import { IndexedModule, ManifestIndex } from './manifest-index';
-import { FunctionMetadata, Package, PackageDigest } from './types';
-import { PackageUtil } from './package';
+import { FunctionMetadata, ManifestContext, Package } from './types';
 
 const METADATA = Symbol.for('@travetto/manifest:metadata');
 type Metadated = { [METADATA]: FunctionMetadata };
@@ -11,7 +10,6 @@ type Metadated = { [METADATA]: FunctionMetadata };
  */
 class $RootIndex extends ManifestIndex {
 
-  #config: Package | undefined;
   #metadata = new Map<string, FunctionMetadata>();
 
   /**
@@ -20,7 +18,6 @@ class $RootIndex extends ManifestIndex {
    */
   reinitForModule(module: string): void {
     this.init(`${this.outputRoot}/node_modules/${module}`);
-    this.#config = undefined;
   }
 
   /**
@@ -49,32 +46,28 @@ class $RootIndex extends ManifestIndex {
   }
 
   /**
-   * Get main module for manifest
+   * Get main module name
    */
-  get mainModule(): IndexedModule {
-    return this.getModule(this.mainPackage.name)!;
+  get mainModuleName(): string {
+    return this.manifest.mainModule;
   }
 
   /**
-   * Get main package for manifest
+   * Get main module for manifest
    */
-  get mainPackage(): Package {
-    if (!this.#config) {
-      const { outputPath } = this.getModule(this.manifest.mainModule)!;
-      this.#config = {
-        ...{
-          name: 'untitled',
-          description: 'A Travetto application',
-          version: '0.0.0',
-        },
-        ...PackageUtil.readPackage(outputPath)
-      };
-    }
-    return this.#config;
+  get mainModule(): IndexedModule {
+    return this.getModule(this.mainModuleName)!;
   }
 
-  mainDigest(): PackageDigest {
-    return PackageUtil.digest(this.mainPackage);
+  /**
+   * Digest manifest
+   */
+  manifestDigest(): Pick<ManifestContext, 'mainModule' | 'frameworkVersion' | 'version'> {
+    return {
+      mainModule: this.manifest.mainModule,
+      frameworkVersion: this.manifest.frameworkVersion,
+      version: this.manifest.version,
+    };
   }
 
   /**

package/src/types.ts

@@ -35,6 +35,9 @@ export type ManifestContext = {
   monoRepo?: boolean;
   moduleType: 'module' | 'commonjs';
   packageManager: 'yarn' | 'npm';
+  frameworkVersion: string;
+  description: string;
+  version: string;
 };
 
 export type ManifestRoot = ManifestContext & {
@@ -86,9 +89,6 @@ export type Package = {
   publishConfig?: { access?: 'restricted' | 'public' };
 };
 
-export type PackageDigestField = 'name' | 'main' | 'author' | 'license' | 'version';
-export type PackageDigest = Pick<Package, PackageDigestField> & { framework: string };
-
 type OrProm<T> = T | Promise<T>;
 
 export type PackageVisitReq<T> = { pkg: Package, rel: PackageRel, sourcePath: string, parent?: T };