@travetto/doc 4.0.0-rc.0 → 4.0.0-rc.1

package/package.json

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

package/src/mapping/lib-mapping.ts

@@ -98,7 +98,7 @@ export const LIB_MAPPING = {
   // Rest
   Express: { title: 'express', href: 'https://expressjs.com' },
   Passport: { title: 'passport', href: 'http://passportjs.org' },
-  Busboy: { title: 'busboy', href: 'https://github.com/mscdex/busboy' },
+  Busboy: { title: '@fastify/busboy', href: 'https://github.com/fastify/busboy' },
   Cookies: { title: 'cookies', href: 'https://www.npmjs.com/package/cookies' },
   ServerlessExpress: { title: 'aws-serverless-express', href: 'https://github.com/awslabs/aws-serverless-express/blob/master/README.md' },
   AwsLambdaFastify: { title: '@fastify/aws-lambda', href: 'https://github.com/fastify/aws-lambda-fastify/blob/master/README.md' },

package/src/render/renderer.ts

@@ -19,8 +19,10 @@ export class DocRenderer {
 
   static async get(file: string, manifest: ManifestContext): Promise<DocRenderer> {
     const mod = RuntimeIndex.getFromSource(file)?.import;
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const res = await import(mod!) as DocumentShape;
+    if (!mod) {
+      throw new Error(`Unable to render ${file}, not in the manifest`);
+    }
+    const res: DocumentShape = await import(mod);
 
     const pkg = PackageUtil.readPackage(manifest.workspace.path);
     const repoBaseUrl = pkg.travetto?.doc?.baseUrl ?? manifest.workspace.path;
@@ -55,7 +57,7 @@ export class DocRenderer {
     } else if (isJSXElement(node)) {
       let final: JSXElement = node;
       // Render simple element if needed
-      if (typeof node.type === 'function') {
+      if (typeof node.type === 'function' && node.type !== JSXFragmentType) {
         // @ts-expect-error
         const out = node.type(node.props);
         final = out !== EMPTY_ELEMENT ? out : final;

package/src/util/run.ts

@@ -1,7 +1,8 @@
 import os from 'node:os';
+import { spawn, ChildProcess } from 'node:child_process';
 
 import { path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
-import { Env, ExecUtil, ExecutionOptions, ExecutionState } from '@travetto/base';
+import { Env, ExecUtil } from '@travetto/base';
 import { StyleUtil } from '@travetto/terminal';
 
 export const COMMON_DATE = new Date('2029-03-14T00:00:00.000').getTime();
@@ -15,12 +16,6 @@ export type RunConfig = {
   cwd?: string;
 };
 
-type RunState = {
-  cmd: string;
-  args: string[];
-  opts: ExecutionOptions;
-};
-
 class DocState {
   baseline = COMMON_DATE;
   _s = 37;
@@ -50,31 +45,6 @@ class DocState {
 export class DocRunUtil {
   static #docState = new DocState();
 
-  static runState(cmd: string, args: string[], config: RunConfig = {}): RunState {
-    const cwd = config.cwd ?? (config.module ? RuntimeIndex.getModule(config.module)! : RuntimeIndex.mainModule).sourcePath;
-    args = [...args];
-    return {
-      cmd,
-      args,
-      opts: {
-        cwd: path.toPosix(cwd),
-        shell: '/bin/bash',
-        env: {
-          ...process.env,
-          ...Env.DEBUG.export(false),
-          ...Env.TRV_CAN_RESTART.export(false),
-          ...Env.TRV_CLI_IPC.export(undefined),
-          ...Env.TRV_MANIFEST.export(''),
-          ...Env.TRV_BUILD.export('none'),
-          ...Env.TRV_ROLE.export(undefined),
-          ...Env.TRV_MODULE.export(config.module ?? ''),
-          ...(config.envName ? Env.TRV_ENV.export(config.envName) : {}),
-          ...(config.env ?? {})
-        }
-      }
-    };
-  }
-
   /**
    * Clean run output
    */
@@ -102,11 +72,25 @@ export class DocRunUtil {
   }
 
   /**
-   * Run process in the background
+   * Spawn command with appropriate environment, and cwd
    */
-  static runBackground(cmd: string, args: string[], config: RunConfig = {}): ExecutionState {
-    const state = this.runState(cmd, args, config);
-    return ExecUtil.spawn(state.cmd, state.args, { ...state.opts, stdio: 'pipe' });
+  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),
+      shell: '/bin/bash',
+      env: {
+        ...process.env,
+        ...Env.DEBUG.export(false),
+        ...Env.TRV_CAN_RESTART.export(false),
+        ...Env.TRV_CLI_IPC.export(undefined),
+        ...Env.TRV_MANIFEST.export(''),
+        ...Env.TRV_BUILD.export('none'),
+        ...Env.TRV_ROLE.export(undefined),
+        ...Env.TRV_MODULE.export(config.module ?? ''),
+        ...(config.envName ? Env.TRV_ENV.export(config.envName) : {}),
+        ...config.env
+      }
+    });
   }
 
   /**
@@ -115,12 +99,12 @@ export class DocRunUtil {
   static async run(cmd: string, args: string[], config: RunConfig = {}): Promise<string> {
     let final: string;
     try {
-      const state = this.runState(cmd, args, config);
-      const res = await ExecUtil.spawn(state.cmd, state.args, { stdio: 'pipe', ...state.opts, catchAsResult: true }).result;
+      const proc = this.spawn(cmd, args, config);
+      const res = await ExecUtil.getResult(proc, { catch: true });
       if (!res.valid) {
         throw new Error(res.stderr);
       }
-      final = StyleUtil.cleanText(res.stdout.toString()).trim() || StyleUtil.cleanText(res.stderr.toString()).trim();
+      final = StyleUtil.cleanText(res.stdout).trim() || StyleUtil.cleanText(res.stderr).trim();
     } catch (err) {
       if (err instanceof Error) {
         final = err.message;

package/support/cli.doc.ts

@@ -1,4 +1,5 @@
 import fs from 'node:fs/promises';
+import { spawn } from 'node:child_process';
 
 import { PackageUtil, path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
 import { ExecUtil, Env, watchCompiler } from '@travetto/base';
@@ -51,15 +52,17 @@ export class DocCommand implements CliCommandShape {
     }
 
     const args = process.argv.slice(2).filter(x => !/(-w|--watch)/.test(x));
-    await watchCompiler(async ({ action, file }) => {
+    for await (const { action, file } of watchCompiler({ restartOnExit: true })) {
       if (action === 'update' && file === this.input) {
-        await ExecUtil.spawn('npx', ['trv', ...args], {
+        const proc = spawn('npx', ['trv', ...args], {
           cwd: RuntimeIndex.mainModule.sourcePath,
-          env: { ...Env.TRV_QUIET.export(true) },
-          stdio: 'inherit', catchAsResult: true
+          shell: false,
+          env: { ...process.env, ...Env.TRV_QUIET.export(true) },
+          stdio: 'inherit'
         });
+        await ExecUtil.getResult(proc, { catch: true });
       }
-    }, { restartOnExit: true });
+    }
   }
 
   async render(): Promise<void> {