@travetto/doc 3.3.4 → 3.4.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/doc",
-  "version": "3.3.4",
+  "version": "3.4.0-rc.1",
   "description": "Documentation support for the Travetto framework",
   "keywords": [
     "docs",
@@ -24,12 +24,12 @@
     "directory": "module/doc"
   },
   "dependencies": {
-    "@travetto/base": "^3.3.4",
-    "@types/prismjs": "^1.26.0",
+    "@travetto/base": "^3.4.0-rc.1",
+    "@types/prismjs": "^1.26.2",
     "prismjs": "^1.29.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.3.6"
+    "@travetto/cli": "^3.4.0-rc.2"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {
@@ -37,7 +37,7 @@
     }
   },
   "travetto": {
-    "profiles": [
+    "roles": [
       "doc"
     ],
     "displayName": "Documentation"

package/src/util/run.ts

@@ -1,3 +1,5 @@
+import os from 'os';
+
 import { path, RootIndex } from '@travetto/manifest';
 import { ExecUtil, ExecutionOptions, ExecutionState } from '@travetto/base';
 import { stripAnsiCodes } from '@travetto/terminal';
@@ -9,7 +11,7 @@ export type RunConfig = {
   rewrite?: (text: string) => string;
   module?: string;
   env?: Record<string, string>;
-  profiles?: string[];
+  envName?: string;
   cwd?: string;
 };
 
@@ -60,10 +62,12 @@ export class DocRunUtil {
         env: {
           ...process.env,
           DEBUG: '0',
+          TRV_CAN_RESTART: '0',
+          TRV_CLI_IPC: '',
           TRV_MANIFEST: '',
           TRV_BUILD: 'none',
           TRV_MODULE: config.module ?? '',
-          ...(config.profiles ? { TRV_PROFILES: config.profiles.join(' ') } : {}),
+          ...(config.envName ? { TRV_ENV: config.envName } : {}),
           ...(config.env ?? {})
         }
       }
@@ -77,6 +81,7 @@ export class DocRunUtil {
     const cwd = path.toPosix((cfg.module ? RootIndex.getModule(cfg.module)! : RootIndex.mainModule).sourcePath);
     text = stripAnsiCodes(text.trim())
       .replaceAll(cwd, '.')
+      .replaceAll(os.tmpdir(), '/tmp')
       .replaceAll(RootIndex.manifest.workspacePath, '<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}`)

package/support/cli.doc.ts

@@ -1,8 +1,8 @@
 import fs from 'fs/promises';
 
-import { PackageUtil, path, RootIndex, watchFolders } from '@travetto/manifest';
-import { ExecUtil, GlobalEnvConfig } from '@travetto/base';
-import { CliCommandShape, CliCommand, CliValidationError } from '@travetto/cli';
+import { PackageUtil, path, RootIndex } from '@travetto/manifest';
+import { ExecUtil, GlobalEnvConfig, CompilerClient } from '@travetto/base';
+import { CliCommandShape, CliCommand, CliValidationError, CliUtil } from '@travetto/cli';
 import { MinLength } from '@travetto/schema';
 
 /**
@@ -49,9 +49,12 @@ export class DocCommand implements CliCommandShape {
   }
 
   async runWatch(): Promise<void> {
+    if (await CliUtil.runWithRestart(this)) {
+      return;
+    }
+
     const args = process.argv.slice(2).filter(x => !/(-w|--watch)/.test(x));
-    const stream = watchFolders([{ src: path.dirname(this.input), immediate: true }]);
-    for await (const { action, file } of stream) {
+    await new CompilerClient().onFileChange(async ({ action, file }) => {
       if (action === 'update' && file === this.input) {
         await ExecUtil.spawn('npx', ['trv', ...args], {
           cwd: RootIndex.mainModule.sourcePath,
@@ -59,7 +62,7 @@ export class DocCommand implements CliCommandShape {
           stdio: 'inherit', catchAsResult: true
         });
       }
-    }
+    }, true);
   }
 
   async render(): Promise<void> {