@travetto/doc 4.1.0 → 5.0.0-rc.0

package/package.json

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

package/src/mapping/lib-mapping.ts

@@ -66,6 +66,7 @@ export const LIB_MAPPING = {
   Fetch: { title: 'fetch', href: 'https://nodejs.org/api/globals.html#fetch' },
   ParcelWatcher: { title: '@parcel/watcher', href: 'https://www.npmjs.com/package/@parcel/watcher' },
   Preact: { title: 'preact', href: 'https://preactjs.com' },
+  NodeYaml: { title: 'yaml', href: 'https://github.com/eemeli/yaml' },
 
   // JWT
   JWT: { title: 'JWT', href: 'https://jwt.io/' },

package/src/mapping/mod-mapping.ts

@@ -215,6 +215,10 @@ export const MOD_MAPPING = {
     name: '@travetto/rest-session', folder: '@travetto/rest-session', displayName: 'REST Session',
     description: 'Session provider for the travetto rest module.'
   },
+  RestUpload: {
+    name: '@travetto/rest-upload', folder: '@travetto/rest-upload', displayName: 'Rest Upload Support',
+    description: 'Provides integration between the travetto asset and rest module.'
+  },
   Scaffold: {
     name: '@travetto/scaffold', folder: '@travetto/scaffold', displayName: 'App Scaffold',
     description: 'App Scaffold for the Travetto framework'
@@ -246,9 +250,5 @@ export const MOD_MAPPING = {
   Worker: {
     name: '@travetto/worker', folder: '@travetto/worker', displayName: 'Worker',
     description: 'Process management utilities, with a focus on inter-process communication'
-  },
-  Yaml: {
-    name: '@travetto/yaml', folder: '@travetto/yaml', displayName: 'YAML',
-    description: 'Simple YAML support, provides only clean subset of yaml'
   }
 };

package/src/render/context.ts

@@ -1,6 +1,6 @@
 import { createElement, JSXRuntimeTag } from '@travetto/doc/jsx-runtime';
 
-import { PackageUtil, path, RuntimeIndex } from '@travetto/manifest';
+import { path, PackageUtil, RuntimeIndex } from '@travetto/manifest';
 
 import { JSXElementByFn, c } from '../jsx';
 import { DocResolveUtil, ResolvedCode, ResolvedRef, ResolvedSnippetLink } from '../util/resolve';

package/src/render/renderer.ts

@@ -1,5 +1,6 @@
-import { ManifestContext, PackageUtil, path, RuntimeIndex } from '@travetto/manifest';
+import path from 'node:path';
 
+import { ManifestContext, PackageUtil, RuntimeIndex } from '@travetto/manifest';
 import { isJSXElement, JSXElement, JSXFragmentType } from '@travetto/doc/jsx-runtime';
 
 import { EMPTY_ELEMENT, getComponentName, JSXElementByFn, c } from '../jsx';

package/src/util/file.ts

@@ -1,6 +1,7 @@
 import fs from 'node:fs/promises';
+import path from 'node:path';
 
-import { ManifestModuleUtil, path, RuntimeIndex } from '@travetto/manifest';
+import { ManifestModuleUtil, RuntimeIndex } from '@travetto/manifest';
 
 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, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
 import { Env, ExecUtil } from '@travetto/base';
-import { StyleUtil } from '@travetto/terminal';
 
 export const COMMON_DATE = new Date('2029-03-14T00:00:00.000').getTime();
 
@@ -50,7 +50,7 @@ export class DocRunUtil {
    */
   static cleanRunOutput(text: string, cfg: RunConfig): string {
     const cwd = path.toPosix((cfg.module ? RuntimeIndex.getModule(cfg.module)! : RuntimeIndex.mainModule).sourcePath);
-    text = StyleUtil.cleanText(text.trim())
+    text = util.stripVTControlCharacters(text.trim())
       .replaceAll(cwd, '.')
       .replaceAll(os.tmpdir(), '/tmp')
       .replaceAll(RuntimeContext.workspace.path, '<workspace-root>')
@@ -104,7 +104,7 @@ export class DocRunUtil {
       if (!res.valid) {
         throw new Error(res.stderr);
       }
-      final = StyleUtil.cleanText(res.stdout).trim() || StyleUtil.cleanText(res.stderr).trim();
+      final = util.stripVTControlCharacters(res.stdout).trim() || util.stripVTControlCharacters(res.stderr).trim();
     } catch (err) {
       if (err instanceof Error) {
         final = err.message;

package/support/cli.doc.ts

@@ -1,7 +1,8 @@
 import fs from 'node:fs/promises';
 import { spawn } from 'node:child_process';
+import path from 'node:path';
 
-import { PackageUtil, path, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
+import { PackageUtil, RuntimeIndex, RuntimeContext } from '@travetto/manifest';
 import { ExecUtil, Env, watchCompiler } from '@travetto/base';
 import { CliCommandShape, CliCommand, CliValidationError, CliUtil } from '@travetto/cli';
 import { MinLength } from '@travetto/schema';