@travetto/doc 5.0.0-rc.0 → 5.0.0-rc.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/doc",
-  "version": "5.0.0-rc.0",
+  "version": "5.0.0-rc.2",
   "description": "Documentation support for the Travetto framework",
   "keywords": [
     "docs",
@@ -24,12 +24,12 @@
     "directory": "module/doc"
   },
   "dependencies": {
-    "@travetto/base": "^5.0.0-rc.0",
+    "@travetto/runtime": "^5.0.0-rc.2",
     "@types/prismjs": "^1.26.4",
     "prismjs": "^1.29.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^5.0.0-rc.0"
+    "@travetto/cli": "^5.0.0-rc.2"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/jsx.ts

@@ -1,5 +1,5 @@
 import { createElement, JSXElement, JSXComponentFunction as CompFn } from '@travetto/doc/jsx-runtime';
-import { TypedObject } from '@travetto/base';
+import { TypedObject } from '@travetto/runtime';
 
 import { LIB_MAPPING } from './mapping/lib-mapping';
 import { MOD_MAPPING } from './mapping/mod-mapping';

package/src/mapping/mod-mapping.ts

@@ -32,7 +32,7 @@ export const MOD_MAPPING = {
     description: 'Rest authentication session integration support for the Travetto framework'
   },
   Base: {
-    name: '@travetto/base', folder: '@travetto/base', displayName: 'Base',
+    name: '@travetto/runtime', folder: '@travetto/runtime', displayName: 'Base',
     description: 'Environment config and common utilities for travetto applications.'
   },
   Cache: {

package/src/render/context.ts

@@ -1,6 +1,9 @@
+import path from 'node:path';
+
 import { createElement, JSXRuntimeTag } from '@travetto/doc/jsx-runtime';
 
-import { path, PackageUtil, RuntimeIndex } from '@travetto/manifest';
+import { PackageUtil } from '@travetto/manifest';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
 
 import { JSXElementByFn, c } from '../jsx';
 import { DocResolveUtil, ResolvedCode, ResolvedRef, ResolvedSnippetLink } from '../util/resolve';
@@ -37,7 +40,7 @@ export class RenderContext {
 
     const manifestPkg = PackageUtil.readPackage(RuntimeIndex.getModule('@travetto/manifest')!.sourcePath);
 
-    this.file = path.toPosix(file);
+    this.file = path.resolve(file);
     this.baseUrl = baseUrl;
     this.repoRoot = repoRoot;
     this.travettoBaseUrl = repoRoot.includes('travetto.github') ? repoRoot : manifestPkg.travetto!.doc!.baseUrl!;
@@ -105,7 +108,7 @@ export class RenderContext {
    * Resolve code link
    */
   async resolveCodeLink(node: JSXElementByFn<'CodeLink'>): Promise<ResolvedSnippetLink> {
-    const src = typeof node.props.src === 'string' ? node.props.src : RuntimeIndex.getFunctionMetadata(node.props.src)!.source;
+    const src = typeof node.props.src === 'string' ? node.props.src : Runtime.getSource(node.props.src);
     return DocResolveUtil.resolveCodeLink(src, node.props.startRe);
   }
 
@@ -113,7 +116,7 @@ export class RenderContext {
    * Resolve code/config
    */
   async resolveCode(node: JSXElementByFn<'Code' | 'Config'>): Promise<ResolvedCode> {
-    const src = typeof node.props.src === 'string' ? node.props.src : RuntimeIndex.getFunctionMetadata(node.props.src)!.source;
+    const src = typeof node.props.src === 'string' ? node.props.src : Runtime.getSource(node.props.src);
     return node.props.startRe ?
       DocResolveUtil.resolveSnippet(src, node.props.startRe, node.props.endRe, node.props.outline) :
       DocResolveUtil.resolveCode(src, node.props.language, node.props.outline);

package/src/render/html.ts

@@ -1,7 +1,8 @@
 import fs from 'node:fs/promises';
 
 import { JSXElement } from '@travetto/doc/jsx-runtime';
-import { RuntimeIndex, PackageUtil, RuntimeContext } from '@travetto/manifest';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
+import { PackageUtil } from '@travetto/manifest';
 
 import { highlight } from './code-highlight';
 import { RenderProvider, RenderState } from '../types';
@@ -144,7 +145,7 @@ yarn add ${el.props.pkg}
   Header: async ({ props }) => `<h1>${props.title} ${props.description ? `\n<small>${props.description}</small>\n` : ''}</h1>\n`,
 
   StdHeader: async state => {
-    const mod = state.el.props.mod ?? RuntimeContext.main.name;
+    const mod = state.el.props.mod ?? Runtime.main.name;
     const pkg = PackageUtil.readPackage(RuntimeIndex.getModule(mod)!.sourcePath);
     const title = pkg.travetto?.displayName ?? pkg.name;
     const desc = pkg.description;

package/src/render/markdown.ts

@@ -1,5 +1,6 @@
 import fs from 'node:fs/promises';
-import { PackageUtil, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
+import { PackageUtil } from '@travetto/manifest';
 
 import { RenderProvider } from '../types';
 import { c, getComponentName } from '../jsx';
@@ -108,7 +109,7 @@ ${context.cleanText(content.text)}
   Header: async ({ props }) => `# ${props.title}\n${props.description ? `## ${props.description}\n` : ''}\n`,
 
   StdHeader: async state => {
-    const mod = state.el.props.mod ?? RuntimeContext.main.name;
+    const mod = state.el.props.mod ?? Runtime.main.name;
     const pkg = PackageUtil.readPackage(RuntimeIndex.getModule(mod)!.sourcePath);
     const title = pkg.travetto?.displayName ?? pkg.name;
     const desc = pkg.description;

package/src/render/renderer.ts

@@ -1,7 +1,8 @@
 import path from 'node:path';
 
-import { ManifestContext, PackageUtil, RuntimeIndex } from '@travetto/manifest';
+import { type ManifestContext, PackageUtil } from '@travetto/manifest';
 import { isJSXElement, JSXElement, JSXFragmentType } from '@travetto/doc/jsx-runtime';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
 
 import { EMPTY_ELEMENT, getComponentName, JSXElementByFn, c } from '../jsx';
 import { DocumentShape, RenderProvider, RenderState } from '../types';
@@ -93,11 +94,11 @@ export class DocRenderer {
         case 'bigint':
         case 'boolean': return `${node}`;
         default: {
-          const meta = (typeof node === 'function' ? RuntimeIndex.getFunctionMetadata(node) : undefined);
-          if (meta && typeof node === 'function') {
-            const title = (await DocFileUtil.isDecorator(node.name, meta.source)) ? `@${node.name}` : node.name;
+          const source = typeof node === 'function' ? Runtime.getSource(node) : undefined;
+          if (source && typeof node === 'function') {
+            const title = (await DocFileUtil.isDecorator(node.name, source)) ? `@${node.name}` : node.name;
             const el = this.#support.createElement('CodeLink', {
-              src: meta.source,
+              src: source,
               startRe: new RegExp(`(class|function)\\s+(${node.name})`),
               title
             });

package/src/util/file.ts

@@ -1,7 +1,8 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { ManifestModuleUtil, RuntimeIndex } from '@travetto/manifest';
+import { ManifestModuleUtil } from '@travetto/manifest';
+import { RuntimeIndex } from '@travetto/runtime';
 
 const ESLINT_PATTERN = /\s*\/\/ eslint.*$/g;
 const ENV_KEY = /Env.([^.]+)[.]key/g;

package/src/util/run.ts

@@ -1,9 +1,9 @@
 import os from 'node:os';
 import util from 'node:util';
 import { spawn, ChildProcess } from 'node:child_process';
+import path from 'node:path';
 
-import { path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
-import { Env, ExecUtil } from '@travetto/base';
+import { Env, ExecUtil, Runtime, RuntimeIndex } from '@travetto/runtime';
 
 export const COMMON_DATE = new Date('2029-03-14T00:00:00.000').getTime();
 
@@ -45,15 +45,20 @@ class DocState {
 export class DocRunUtil {
   static #docState = new DocState();
 
+  /** Build cwd from config */
+  static cwd(cfg: RunConfig): string {
+    return path.resolve(cfg.module ? RuntimeIndex.getModule(cfg.module)?.sourcePath! : Runtime.mainSourcePath);
+  }
+
   /**
    * Clean run output
    */
   static cleanRunOutput(text: string, cfg: RunConfig): string {
-    const cwd = path.toPosix((cfg.module ? RuntimeIndex.getModule(cfg.module)! : RuntimeIndex.mainModule).sourcePath);
+    const cwd = this.cwd(cfg);
     text = util.stripVTControlCharacters(text.trim())
       .replaceAll(cwd, '.')
       .replaceAll(os.tmpdir(), '/tmp')
-      .replaceAll(RuntimeContext.workspace.path, '<workspace-root>')
+      .replaceAll(Runtime.workspace.path, '<workspace-root>')
       .replace(/[/]tmp[/][a-z_A-Z0-9\/\-]+/g, '/tmp/<temp-folder>')
       .replace(/^(\s*framework:\s*')(\d+[.]\d+)[^']*('[,]?\s*)$/gm, (_, pre, ver, post) => `${pre}${ver}.x${post}`)
       .replace(/^(\s*nodeVersion:\s*'v)(\d+)[^']*('[,]?\s*)$/gm, (_, pre, ver, post) => `${pre}${ver}.x.x${post}`)
@@ -76,7 +81,7 @@ export class DocRunUtil {
    */
   static spawn(cmd: string, args: string[], config: RunConfig = {}): ChildProcess {
     return spawn(cmd, args, {
-      cwd: path.toPosix(config.cwd ?? (config.module ? RuntimeIndex.getModule(config.module)! : RuntimeIndex.mainModule).sourcePath),
+      cwd: config.cwd ?? this.cwd(config),
       shell: '/bin/bash',
       env: {
         ...process.env,

package/support/cli.doc.ts

@@ -2,8 +2,8 @@ import fs from 'node:fs/promises';
 import { spawn } from 'node:child_process';
 import path from 'node:path';
 
-import { PackageUtil, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
-import { ExecUtil, Env, watchCompiler } from '@travetto/base';
+import { PackageUtil } from '@travetto/manifest';
+import { ExecUtil, Env, watchCompiler, Runtime } from '@travetto/runtime';
 import { CliCommandShape, CliCommand, CliValidationError, CliUtil } from '@travetto/cli';
 import { MinLength } from '@travetto/schema';
 
@@ -32,7 +32,7 @@ export class DocCommand implements CliCommandShape {
   }
 
   preBind(): void {
-    const workspacePkg = PackageUtil.readPackage(RuntimeContext.workspace.path);
+    const workspacePkg = PackageUtil.readPackage(Runtime.workspace.path);
     this.outputs = workspacePkg.travetto?.doc?.outputs ?? ['README.md'];
   }
 
@@ -56,7 +56,7 @@ export class DocCommand implements CliCommandShape {
     for await (const { action, file } of watchCompiler({ restartOnExit: true })) {
       if (action === 'update' && file === this.input) {
         const proc = spawn('npx', ['trv', ...args], {
-          cwd: RuntimeIndex.mainModule.sourcePath,
+          cwd: Runtime.mainSourcePath,
           shell: false,
           env: { ...process.env, ...Env.TRV_QUIET.export(true) },
           stdio: 'inherit'
@@ -68,7 +68,7 @@ export class DocCommand implements CliCommandShape {
 
   async render(): Promise<void> {
     const { DocRenderer } = await import('../src/render/renderer');
-    const ctx = await DocRenderer.get(this.input, RuntimeContext);
+    const ctx = await DocRenderer.get(this.input, Runtime);
     const outputs = this.outputs.map(output =>
       output.includes('.') ? [path.extname(output).replace('.', ''), path.resolve(output)] :
         [output, null] as const