@travetto/doc 6.0.0-rc.2 → 6.0.0-rc.4

package/__index__.ts

@@ -1,4 +1,5 @@
-export { JSXElement as DocJSXElement, isJSXElement as isDocJSXElement } from './jsx-runtime';
-export { c, d, JSXElementByFn as DocJSXElementByFn } from './src/jsx';
-export { MOD_MAPPING as mod } from './src/mapping/mod-mapping';
-export { DocFileUtil } from './src/util/file';
+export { JSXElement as DocJSXElement, isJSXElement as isDocJSXElement } from './jsx-runtime.ts';
+export { c, d, JSXElementByFn as DocJSXElementByFn } from './src/jsx.ts';
+export { MOD_MAPPING as mod } from './src/mapping/mod-mapping.ts';
+export { DocFileUtil } from './src/util/file.ts';
+export { DocRunUtil, COMMON_DATE } from './src/util/run.ts';

package/package.json

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

package/src/jsx.ts

@@ -1,11 +1,10 @@
 import { createElement, JSXElement, JSXComponentFunction as CompFn } from '@travetto/doc/jsx-runtime';
 import { castTo, TypedObject } from '@travetto/runtime';
 
-import { LIB_MAPPING } from './mapping/lib-mapping';
-import { MOD_MAPPING } from './mapping/mod-mapping';
-import { RunConfig } from './util/run';
+import { LIB_MAPPING } from './mapping/lib-mapping.ts';
+import { MOD_MAPPING } from './mapping/mod-mapping.ts';
+import { CodeProps, RunConfig } from './util/types.ts';
 
-type CodeProps = { title: string, src: string | Function, language?: string, outline?: boolean, startRe?: RegExp, endRe?: RegExp };
 type InstallProps = { title: string, pkg: string };
 type ExecProps = { title: string, cmd: string, args?: string[], config?: RunConfig & { formatCommand?(cmd: string, args: string[]): string } };
 type StdHeaderProps = { mod?: string, install?: boolean };
@@ -82,8 +81,9 @@ function CodeLinker(titleOrNode: string | JSXElement, src?: string, startRe?: Re
     props = { title: titleOrNode, src: src!, startRe: startRe! };
   } else if (titleOrNode.type === Code) {
     const node: JSXElementByFn<'Code'> = castTo(titleOrNode);
+    const srcName = typeof node.props.src === 'string' ? node.props.src : node.props.src.name;
     props = {
-      title: node.props.title,
+      title: node.props.title ?? srcName,
       src: node.props.src,
       startRe: node.props.startRe!
     };

package/src/mapping/lib-mapping.ts

@@ -39,17 +39,22 @@ export const LIB_MAPPING = {
   UUID: { title: 'UUID', href: 'https://en.wikipedia.org/wiki/Universally_unique_identifier' },
 
   // Node
-  Process: { title: 'process', href: 'https://nodejs.org/api/process.html' },
-  ChildProcess: { title: 'child_process', href: 'https://nodejs.org/api/child_process.html' },
-  AsyncHooks: { title: 'async_hooks', href: 'https://nodejs.org/api/async_hooks.html' },
-  Http: { title: 'http', href: 'https://nodejs.org/api/http.html' },
-  Path: { title: 'http', href: 'https://nodejs.org/api/path.html' },
-  Https: { title: 'https', href: 'https://nodejs.org/api/https.html' },
-  Console: { title: 'console', href: 'https://nodejs.org/api/console.html' },
-  Assert: { title: 'assert', href: 'https://nodejs.org/api/assert.html' },
+  NodeProcess: { title: 'process', href: 'https://nodejs.org/api/process.html' },
+  NodeChildProcess: { title: 'child_process', href: 'https://nodejs.org/api/child_process.html' },
+  NodeAsyncHooks: { title: 'async_hooks', href: 'https://nodejs.org/api/async_hooks.html' },
+  NodeHttp: { title: 'http', href: 'https://nodejs.org/api/http.html' },
+  NodePath: { title: 'path', href: 'https://nodejs.org/api/path.html' },
+  NodeHttps: { title: 'https', href: 'https://nodejs.org/api/https.html' },
+  NodeConsole: { title: 'console', href: 'https://nodejs.org/api/console.html' },
+  NodeAssert: { title: 'assert', href: 'https://nodejs.org/api/assert.html' },
+  NodeEventEmitter: { title: 'EventEmitter', href: 'https://nodejs.org/api/events.html#class-eventemitter' },
+  NodeBuffer: { title: 'Buffer', href: 'https://nodejs.org/api/buffer.html' },
+  NodeZlib: { title: 'Buffer', href: 'https://nodejs.org/api/zlib.html' },
+  NodeFile: { title: 'Buffer', href: 'https://nodejs.org/api/buffer.html#class-file' },
 
   // Cloud
   AwsCloudwatch: { title: 'AWS Cloudwatch', href: 'https://aws.amazon.com/cloudwatch/' },
+  AwsLambda: { title: 'AWS Lambda', href: 'https://aws.amazon.com/lambda/' },
 
   // Utils
   Lodash: { title: 'lodash', href: 'https://lodash.com' },
@@ -97,7 +102,8 @@ export const LIB_MAPPING = {
   Firestore: { title: 'Firestore', href: 'https://firebase.google.com/docs/firestore' },
   SQLite: { title: 'SQLite', href: 'https://www.sqlite.org/' },
 
-  // Rest
+  // Web
+  Connect: { title: 'connect', href: 'https://github.com/senchalabs/connect' },
   Express: { title: 'express', href: 'https://expressjs.com' },
   Passport: { title: 'passport', href: 'http://passportjs.org' },
   Busboy: { title: '@fastify/busboy', href: 'https://github.com/fastify/busboy' },

package/src/mapping/mod-mapping.ts

@@ -7,22 +7,22 @@ export const MOD_MAPPING = {
     name: '@travetto/auth-model', folder: '@travetto/auth-model', displayName: 'Authentication Model',
     description: 'Authentication model support for the Travetto framework'
   },
-  AuthRest: {
-    name: '@travetto/auth-rest', folder: '@travetto/auth-rest', displayName: 'Rest Auth',
-    description: 'Rest authentication integration support for the Travetto framework'
-  },
-  AuthRestPassport: {
-    name: '@travetto/auth-rest-passport', folder: '@travetto/auth-rest-passport', displayName: 'Rest Auth Passport',
-    description: 'Rest authentication integration support for the Travetto framework'
-  },
-  AuthRestSession: {
-    name: '@travetto/auth-rest-session', folder: '@travetto/auth-rest-session', displayName: 'Rest Auth Session',
-    description: 'Rest authentication session integration support for the Travetto framework'
-  },
   AuthSession: {
     name: '@travetto/auth-session', folder: '@travetto/auth-session', displayName: 'Auth Session',
     description: 'Session provider for the travetto auth module.'
   },
+  AuthWeb: {
+    name: '@travetto/auth-web', folder: '@travetto/auth-web', displayName: 'Web Auth',
+    description: 'Web authentication integration support for the Travetto framework'
+  },
+  AuthWebPassport: {
+    name: '@travetto/auth-web-passport', folder: '@travetto/auth-web-passport', displayName: 'Web Auth Passport',
+    description: 'Web authentication integration support for the Travetto framework'
+  },
+  AuthWebSession: {
+    name: '@travetto/auth-web-session', folder: '@travetto/auth-web-session', displayName: 'Web Auth Session',
+    description: 'Web authentication session integration support for the Travetto framework'
+  },
   Cache: {
     name: '@travetto/cache', folder: '@travetto/cache', displayName: 'Caching',
     description: 'Caching functionality with decorators for declarative use.'
@@ -159,50 +159,6 @@ export const MOD_MAPPING = {
     name: '@travetto/repo', folder: '@travetto/repo', displayName: 'Repo',
     description: 'Monorepo utilities'
   },
-  Rest: {
-    name: '@travetto/rest', folder: '@travetto/rest', displayName: 'RESTful API',
-    description: 'Declarative api for RESTful APIs with support for the dependency injection module.'
-  },
-  RestAwsLambda: {
-    name: '@travetto/rest-aws-lambda', folder: '@travetto/rest-aws-lambda', displayName: 'RESTful AWS Lambda',
-    description: 'RESTful APIs entry point support for AWS Lambdas.'
-  },
-  RestClient: {
-    name: '@travetto/rest-client', folder: '@travetto/rest-client', displayName: 'RESTful Client Support',
-    description: 'RESTful support for generating clients for controller endpoints'
-  },
-  RestExpress: {
-    name: '@travetto/rest-express', folder: '@travetto/rest-express', displayName: 'Express REST Source',
-    description: 'Express provider for the travetto rest module.'
-  },
-  RestExpressLambda: {
-    name: '@travetto/rest-express-lambda', folder: '@travetto/rest-express-lambda', displayName: 'Express REST AWS Lambda Source',
-    description: 'Express AWS Lambda provider for the travetto rest module.'
-  },
-  RestFastify: {
-    name: '@travetto/rest-fastify', folder: '@travetto/rest-fastify', displayName: 'Fastify REST Source',
-    description: 'Fastify provider for the travetto rest module.'
-  },
-  RestFastifyLambda: {
-    name: '@travetto/rest-fastify-lambda', folder: '@travetto/rest-fastify-lambda', displayName: 'Fastify REST AWS Lambda Source',
-    description: 'Fastify AWS Lambda provider for the travetto rest module.'
-  },
-  RestKoa: {
-    name: '@travetto/rest-koa', folder: '@travetto/rest-koa', displayName: 'Koa REST Source',
-    description: 'Koa provider for the travetto rest module.'
-  },
-  RestKoaLambda: {
-    name: '@travetto/rest-koa-lambda', folder: '@travetto/rest-koa-lambda', displayName: 'Koa REST AWS Lambda Source',
-    description: 'Koa provider for the travetto rest module.'
-  },
-  RestRpc: {
-    name: '@travetto/rest-rpc', folder: '@travetto/rest-rpc', displayName: 'RESTful RPC Support',
-    description: 'RESTful RPC support for a module'
-  },
-  RestUpload: {
-    name: '@travetto/rest-upload', folder: '@travetto/rest-upload', displayName: 'Rest Upload Support',
-    description: 'Provides integration between the travetto asset and rest module.'
-  },
   Runtime: {
     name: '@travetto/runtime', folder: '@travetto/runtime', displayName: 'Runtime',
     description: 'Runtime for travetto applications.'
@@ -235,6 +191,34 @@ export const MOD_MAPPING = {
     name: '@travetto/transformer', folder: '@travetto/transformer', displayName: 'Transformation',
     description: 'Functionality for AST transformations, with transformer registration, and general utils'
   },
+  Web: {
+    name: '@travetto/web', folder: '@travetto/web', displayName: 'Web API',
+    description: 'Declarative api for Web Applications with support for the dependency injection.'
+  },
+  WebAwsLambda: {
+    name: '@travetto/web-aws-lambda', folder: '@travetto/web-aws-lambda', displayName: 'Web AWS Lambda',
+    description: 'Web APIs entry point support for AWS Lambdas.'
+  },
+  WebConnect: {
+    name: '@travetto/web-connect', folder: '@travetto/web-connect', displayName: 'Web Connect Support',
+    description: 'Web integration for Connect-Like Resources'
+  },
+  WebHttp: {
+    name: '@travetto/web-http', folder: '@travetto/web-http', displayName: 'Web HTTP Server Support',
+    description: 'Web HTTP Server Support'
+  },
+  WebNode: {
+    name: '@travetto/web-node', folder: '@travetto/web-node', displayName: 'Node Web Server',
+    description: 'Node provider for the travetto web module.'
+  },
+  WebRpc: {
+    name: '@travetto/web-rpc', folder: '@travetto/web-rpc', displayName: 'Web RPC Support',
+    description: 'RPC support for a Web Application'
+  },
+  WebUpload: {
+    name: '@travetto/web-upload', folder: '@travetto/web-upload', displayName: 'Web Upload Support',
+    description: 'Provides integration between the travetto asset and web module.'
+  },
   Worker: {
     name: '@travetto/worker', folder: '@travetto/worker', displayName: 'Worker',
     description: 'Process management utilities, with a focus on inter-process communication'

package/src/render/context.ts

@@ -5,9 +5,9 @@ import { createElement, JSXRuntimeTag } from '@travetto/doc/jsx-runtime';
 import { PackageUtil } from '@travetto/manifest';
 import { castTo, RuntimeIndex } from '@travetto/runtime';
 
-import { JSXElementByFn, c } from '../jsx';
-import { DocResolveUtil, ResolvedCode, ResolvedRef, ResolvedSnippetLink } from '../util/resolve';
-import { DocRunUtil } from '../util/run';
+import { JSXElementByFn, c } from '../jsx.ts';
+import { DocResolveUtil, ResolvedCode, ResolvedRef, ResolvedSnippetLink } from '../util/resolve.ts';
+import { DocRunUtil } from '../util/run.ts';
 
 /**
  * Render Context
@@ -66,7 +66,7 @@ export class RenderContext {
   link(text: string, line?: number | { [key: string]: unknown, line?: number }): string {
     const num = typeof line === 'number' ? line : line?.line;
     return `${text.replace(this.repoRoot, this.baseUrl)
-      .replace(/.*@travetto\//, `${this.travettoBaseUrl}/module/`)}${num ? `#L${num}` : ''}`;
+      .replace(/.*@travetto\//, `${this.travettoBaseUrl}/module/`)}${num && num > 1 ? `#L${num}` : ''}`;
   }
 
   /**

package/src/render/html.ts

@@ -4,13 +4,13 @@ import { JSXElement } from '@travetto/doc/jsx-runtime';
 import { Runtime, RuntimeIndex } from '@travetto/runtime';
 import { PackageUtil } from '@travetto/manifest';
 
-import { highlight } from './code-highlight';
-import { RenderProvider, RenderState } from '../types';
-import { c, getComponentName } from '../jsx';
-import { MOD_MAPPING } from '../mapping/mod-mapping';
-import { LIB_MAPPING } from '../mapping/lib-mapping';
-import { RenderContext } from './context';
-import { DocResolveUtil } from '../util/resolve';
+import { highlight } from './code-highlight.ts';
+import { RenderProvider, RenderState } from '../types.ts';
+import { c, getComponentName } from '../jsx.ts';
+import { MOD_MAPPING } from '../mapping/mod-mapping.ts';
+import { LIB_MAPPING } from '../mapping/lib-mapping.ts';
+import { RenderContext } from './context.ts';
+import { DocResolveUtil } from '../util/resolve.ts';
 
 const ESCAPE_ENTITIES: Record<string, string> = { '<': '&lt;', '>': '&gt;', '&': '&amp;', '{': "{{'{'}}", '}': "{{'}'}}" };
 const ENTITY_RE = new RegExp(`[${Object.keys(ESCAPE_ENTITIES).join('')}]`, 'gm');
@@ -71,6 +71,8 @@ yarn add ${el.props.pkg}
   Terminal: state => Html.Code(state),
   Config: state => Html.Code(state),
   Code: async ({ context, el, props }) => {
+    DocResolveUtil.applyCodePropDefaults(el.props);
+
     const cls = getComponentName(el.type).replace(/^[A-Z]/g, v => v.toLowerCase());
     const content = await context.resolveCode(el);
     let link: string = '';

package/src/render/markdown.ts

@@ -3,11 +3,12 @@ import fs from 'node:fs/promises';
 import { Runtime, RuntimeIndex } from '@travetto/runtime';
 import { PackageUtil } from '@travetto/manifest';
 
-import { RenderProvider } from '../types';
-import { c, getComponentName } from '../jsx';
-import { MOD_MAPPING } from '../mapping/mod-mapping';
-import { LIB_MAPPING } from '../mapping/lib-mapping';
-import { RenderContext } from './context';
+import { RenderProvider } from '../types.ts';
+import { c, getComponentName } from '../jsx.ts';
+import { MOD_MAPPING } from '../mapping/mod-mapping.ts';
+import { LIB_MAPPING } from '../mapping/lib-mapping.ts';
+import { RenderContext } from './context.ts';
+import { DocResolveUtil } from '../util/resolve.ts';
 
 export const Markdown: RenderProvider<RenderContext> = {
   ext: 'md',
@@ -22,20 +23,20 @@ export const Markdown: RenderProvider<RenderContext> = {
   hr: async () => '\n------------------\n',
   br: async () => '\n\n',
   em: async ({ recurse }) => `*${await recurse()}*`,
-  ul: async ({ recurse }) => `\n${await recurse()}`,
-  ol: async ({ recurse }) => `\n${await recurse()}`,
+  ul: async ({ recurse }) => `\n${await recurse()}\n`,
+  ol: async ({ recurse }) => `\n${await recurse()}\n`,
   li: async ({ recurse, stack }) => {
-    const parent = stack.reverse().find(x => x.type === 'ol' || x.type === 'ul');
+    const parent = stack.toReversed().find(x => x.type === 'ol' || x.type === 'ul');
     const depth = stack.filter(x => x.type === 'ol' || x.type === 'ul').length;
     return `${'   '.repeat(depth)}${(parent && parent.type === 'ol') ? '1.' : '* '} ${await recurse()}\n`;
   },
-  table: async ({ recurse }) => recurse(),
-  tbody: async ({ recurse }) => recurse(),
+  table: async ({ recurse }) => `${await recurse()}`,
+  tbody: async ({ recurse }) => `${await recurse()}`,
   td: async ({ recurse }) => `|${await recurse()}`,
   tr: async ({ recurse }) => `${await recurse()}|\n`,
   thead: async ({ recurse }) => {
     const row = await recurse();
-    return `${row}${row.replace(/[^|\n]/g, '-')}`;
+    return `${row}${row?.replace(/[^|\n]/g, '-')}`;
   },
   h2: async ({ recurse }) => `\n## ${await recurse()}\n\n`,
   h3: async ({ recurse }) => `\n### ${await recurse()}\n\n`,
@@ -61,10 +62,12 @@ npm install ${el.props.pkg}
 yarn add ${el.props.pkg}
 \`\`\`
 `,
-  Code: async ({ context, el }) => {
+  Code: async ({ context, el, props }) => {
+    DocResolveUtil.applyCodePropDefaults(el.props);
+
     const name = getComponentName(el.type);
     const content = await context.resolveCode(el);
-    let lang = el.props.language ?? content.language;
+    let lang = props.language ?? content.language;
     if (!lang) {
       if (el.type === c.Terminal) {
         lang = 'bash';
@@ -72,7 +75,7 @@ yarn add ${el.props.pkg}
         lang = 'typescript';
       }
     }
-    return `\n\n**${name}: ${el.props.title}**
+    return `\n\n**${name}: ${props.title}**
 \`\`\`${lang}
 ${context.cleanText(content.text)}
 \`\`\`\n\n`;

package/src/render/renderer.ts

@@ -2,15 +2,15 @@ import path from 'node:path';
 
 import { type ManifestContext, PackageUtil } from '@travetto/manifest';
 import { isJSXElement, JSXElement, JSXFragmentType } from '@travetto/doc/jsx-runtime';
-import { castTo, Runtime } from '@travetto/runtime';
+import { castTo, Class, Runtime } from '@travetto/runtime';
 
-import { EMPTY_ELEMENT, getComponentName, JSXElementByFn, c } from '../jsx';
-import { DocumentShape, RenderProvider, RenderState } from '../types';
-import { DocFileUtil } from '../util/file';
+import { EMPTY_ELEMENT, getComponentName, JSXElementByFn, c } from '../jsx.ts';
+import { DocumentShape, RenderProvider, RenderState } from '../types.ts';
+import { DocFileUtil } from '../util/file.ts';
 
-import { RenderContext } from './context';
-import { Html } from './html';
-import { Markdown } from './markdown';
+import { RenderContext } from './context.ts';
+import { Html } from './html.ts';
+import { Markdown } from './markdown.ts';
 
 const providers = { [Html.ext]: Html, [Markdown.ext]: Markdown };
 
@@ -37,18 +37,44 @@ export class DocRenderer {
     this.#support = support;
   }
 
+  async #buildLink(
+    renderer: RenderProvider<RenderContext>,
+    cls: Class,
+    title?: string
+  ) {
+    const source = DocFileUtil.readSource(cls);
+    if (source) {
+      title = (await DocFileUtil.isDecorator(cls.name, source.file)) ? `@${title ?? cls.name}` : (title ?? cls.name);
+      const el = this.#support.createElement('CodeLink', {
+        src: source.file,
+        startRe: new RegExp(`(class|function|interface)\\s+(${cls.name.replaceAll('$', '\\$')})`),
+        title
+      });
+      // @ts-expect-error
+      const state: RenderState<JSXElementByFn<'CodeLink'>, RenderContext> = {
+        el, props: el.props, recurse: async () => '', context: this.#support, stack: []
+      };
+      // @ts-expect-error
+      state.createState = (key, props) => this.createState(state, key, props);
+      return renderer.CodeLink(state);
+    }
+  }
+
   async #render(
     renderer: RenderProvider<RenderContext>,
     node: JSXElement[] | JSXElement | string | bigint | object | number | boolean | null | undefined,
     stack: JSXElement[] = []
-  ): Promise<string> {
+  ): Promise<string | undefined> {
 
     if (node === null || node === undefined) {
       return '';
     } else if (Array.isArray(node)) {
       const out: string[] = [];
       for (const el of node) {
-        out.push(await this.#render(renderer, el, stack));
+        const sub = await this.#render(renderer, el, stack);
+        if (sub) {
+          out.push(sub);
+        }
       }
       return out.join('');
     } else if (isJSXElement(node)) {
@@ -87,25 +113,15 @@ export class DocRenderer {
         case 'number':
         case 'bigint':
         case 'boolean': return `${node}`;
-        case 'function': {
-          const source = DocFileUtil.readSource(node);
-          if (source.file) {
-            const title = (await DocFileUtil.isDecorator(node.name, source.file)) ? `@${node.name}` : node.name;
-            const el = this.#support.createElement('CodeLink', {
-              src: source.file,
-              startRe: new RegExp(`(class|function)\\s+(${node.name})`),
-              title
-            });
-            // @ts-expect-error
-            const state: RenderState<JSXElementByFn<'CodeLink'>, RenderContext> = {
-              el, props: el.props, recurse: async () => '', context: this.#support, stack: []
-            };
-            // @ts-expect-error
-            state.createState = (key, props) => this.createState(state, key, props);
-            return await renderer.CodeLink(state);
+        case 'object': {
+          if (node) {
+            return await this.#buildLink(renderer, castTo(node.constructor), node.constructor.name.replace(/^[$]/, ''));
           }
           break;
         }
+        case 'function': {
+          return await this.#buildLink(renderer, castTo(node));
+        }
       }
       throw new Error(`Unknown object type: ${typeof node}`);
     }
@@ -135,7 +151,7 @@ export class DocRenderer {
     }
 
     const text = await this.#render(providers[fmt], this.#rootNode);
-    let cleaned = `${text.replace(/\n{3,100}/msg, '\n\n').trim()}\n`;
+    let cleaned = `${text?.replace(/\n{3,100}/msg, '\n\n').trim()}\n`;
     if (this.#root.wrap?.[fmt]) {
       cleaned = this.#root.wrap[fmt](cleaned);
     }

package/src/types.ts

@@ -1,10 +1,11 @@
 import { JSXElement, ValidHtmlTags } from '@travetto/doc/jsx-runtime';
-import { JSXElementByFn, c } from './jsx';
+import { JSXElementByFn, c } from './jsx.ts';
 
 export type Wrapper = Record<string, (cnt: string) => string>;
 
 /**
  * Document file shape
+ * @concrete
  */
 export interface DocumentShape {
   text: JSXElement | JSXElement[] | (() => Promise<JSXElement | JSXElement[]>);
@@ -14,7 +15,7 @@ export interface DocumentShape {
 export type RenderState<T extends JSXElement, C> = {
   el: T;
   props: T['props'];
-  recurse: () => Promise<string>;
+  recurse: () => Promise<string | undefined>;
   stack: JSXElement[];
   // @ts-expect-error
   createState: <K extends keyof typeof c>(key: K, props: JSXElementByFn<K>['props']) => RenderState<JSXElementByFn<K>, C>;

package/src/util/file.ts

@@ -2,6 +2,7 @@ import { readFileSync, existsSync } from 'node:fs';
 import path from 'node:path';
 
 import { AppError, Runtime, RuntimeIndex } from '@travetto/runtime';
+import { ManifestModuleFileType, ManifestModuleUtil } from '@travetto/manifest';
 
 const ESLINT_PATTERN = /\s{0,10}\/\/ eslint.{0,300}$/g;
 const ENV_KEY = /Env.([^.]{1,100})[.]key/g;
@@ -12,10 +13,18 @@ const ENV_KEY = /Env.([^.]{1,100})[.]key/g;
 export class DocFileUtil {
 
   static #decCache: Record<string, boolean> = {};
+  static #modFileTypeToLang: Record<ManifestModuleFileType, string | undefined> = {
+    ts: 'typescript',
+    js: 'javascript',
+    md: 'markdown',
+    json: 'json',
+    typings: 'typescript',
+    'package-json': 'json',
+    fixture: undefined,
+    unknown: undefined
+  };
   static #extToLang: Record<string, string> = {
-    '.ts': 'typescript',
-    '.tsx': 'typescript',
-    '.js': 'javascript',
+    '.yaml': 'yaml',
     '.yml': 'yaml',
     '.sh': 'bash',
   };
@@ -64,7 +73,8 @@ export class DocFileUtil {
 
     if (file !== undefined) {
       const ext = path.extname(file);
-      const language = this.#extToLang[ext] ?? ext.replace('.', '');
+      const type = ManifestModuleUtil.getFileType(file);
+      const language = this.#modFileTypeToLang[type] ?? this.#extToLang[ext] ?? ext.replace('.', '');
       return { content, file, language };
     } else {
       return { content, file: '', language: '' };
@@ -72,13 +82,13 @@ export class DocFileUtil {
   }
 
   static async readCodeSnippet(src: string | Function, startPattern: RegExp): Promise<{ file: string, startIdx: number, lines: string[], language: string }> {
-    const res = this.readSource(src);
-    const lines = res.content.split(/\n/);
+    const result = this.readSource(src);
+    const lines = result.content.split(/\n/);
     const startIdx = lines.findIndex(l => startPattern.test(l));
     if (startIdx < 0) {
       throw new Error(`Pattern ${startPattern.source} not found in ${src}`);
     }
-    return { file: res.file, startIdx, lines, language: res.language };
+    return { file: result.file, startIdx, lines, language: result.language };
   }
 
   /**
@@ -91,21 +101,21 @@ export class DocFileUtil {
       return this.#decCache[key];
     }
 
-    const res = await this.readSource(file);
-    const text = res.content.split(/\n/g);
+    const text = await this.readSource(file);
+    const lines = text.content.split(/\n/g);
 
-    const start = text.findIndex(x => new RegExp(`function ${name}\\b`).test(x));
-    let ret = false;
+    const start = lines.findIndex(x => new RegExp(`function ${name}\\b`).test(x));
+    let found = false;
     if (start > 0) {
       for (let i = start - 1; i > start - 3; i--) {
-        if (text[i].includes('@augments')) {
-          ret = true;
+        if (lines[i].includes('@augments')) {
+          found = true;
           break;
         }
       }
     }
-    this.#decCache[key] = ret;
-    return ret;
+    this.#decCache[key] = found;
+    return found;
   }
 
   /**

package/src/util/resolve.ts

@@ -1,4 +1,5 @@
-import { DocFileUtil } from './file';
+import { DocFileUtil } from './file.ts';
+import { CodeProps } from './types.ts';
 
 export type ResolvedRef = { title: string, file: string, line: number };
 export type ResolvedCode = { text: string, language: string, file?: string };
@@ -13,12 +14,12 @@ export class DocResolveUtil {
   static async resolveRef(title: string, file: string): Promise<ResolvedRef> {
 
     let line = 0;
-    const res = await DocFileUtil.readSource(file);
-    file = res.file;
+    const result = await DocFileUtil.readSource(file);
+    file = result.file;
 
-    if (res.content) {
-      line = res.content.split(/\n/g)
-        .findIndex(x => new RegExp(`(class|function)[ ]+${title}`).test(x));
+    if (result.content) {
+      line = result.content.split(/\n/g)
+        .findIndex(x => new RegExp(`(class|interface|function)[ ]+${title.replaceAll('$', '\\$')}`).test(x));
       if (line < 0) {
         line = 0;
       } else {
@@ -32,13 +33,13 @@ export class DocResolveUtil {
   }
 
   static async resolveCode(content: string | Function, language?: string, outline = false): Promise<ResolvedCode> {
-    const res = DocFileUtil.readSource(content);
-    let text = res.content;
+    const result = DocFileUtil.readSource(content);
+    let text = result.content;
 
     let file: string | undefined;
-    if (res.file) {
-      language = res.language;
-      file = res.file;
+    if (result.file) {
+      language = result.language;
+      file = result.file;
       if (outline) {
         text = DocFileUtil.buildOutline(text);
       }
@@ -63,4 +64,12 @@ export class DocResolveUtil {
     const { startIdx, file: resolvedFile } = await DocFileUtil.readCodeSnippet(file, startPattern);
     return { file: resolvedFile, line: startIdx + 1 };
   }
+
+  static applyCodePropDefaults(props: CodeProps) {
+    const type = typeof props.src === 'function' ? props.src : undefined;
+    props.startRe ??= (type ? new RegExp(`^(export)?\\s*(interface|class)\\s+${type.name.replaceAll('$', '\\$')}\\b`) : undefined);
+    props.language ??= (type ? 'typescript' : undefined);
+    props.endRe ??= (type ? /^[}]/ : undefined);
+    props.title ??= typeof props.src == 'function' ? props.src.name.replace(/^[$]/, '') : undefined;
+  }
 }

package/src/util/run.ts

@@ -4,18 +4,10 @@ import { spawn, ChildProcess } from 'node:child_process';
 import path from 'node:path';
 
 import { Env, ExecUtil, Runtime, RuntimeIndex } from '@travetto/runtime';
+import { RunConfig } from './types.ts';
 
 export const COMMON_DATE = new Date('2029-03-14T00:00:00.000').getTime();
 
-export type RunConfig = {
-  filter?: (line: string) => boolean;
-  rewrite?: (text: string) => string;
-  module?: string;
-  env?: Record<string, string>;
-  envName?: string;
-  cwd?: string;
-};
-
 class DocState {
   baseline = COMMON_DATE;
   _s = 37;
@@ -105,11 +97,11 @@ export class DocRunUtil {
     let final: string;
     try {
       const proc = this.spawn(cmd, args, config);
-      const res = await ExecUtil.getResult(proc, { catch: true });
-      if (!res.valid) {
-        throw new Error(res.stderr);
+      const result = await ExecUtil.getResult(proc, { catch: true });
+      if (!result.valid) {
+        throw new Error(result.stderr);
       }
-      final = util.stripVTControlCharacters(res.stdout).trim() || util.stripVTControlCharacters(res.stderr).trim();
+      final = util.stripVTControlCharacters(result.stdout).trim() || util.stripVTControlCharacters(result.stderr).trim();
     } catch (err) {
       if (err instanceof Error) {
         final = err.message;

package/src/util/types.ts

@@ -0,0 +1,10 @@
+export type RunConfig = {
+  filter?: (line: string) => boolean;
+  rewrite?: (text: string) => string;
+  module?: string;
+  env?: Record<string, string>;
+  envName?: string;
+  cwd?: string;
+};
+
+export type CodeProps = { title?: string, src: string | Function, language?: string, outline?: boolean, startRe?: RegExp, endRe?: RegExp };

package/support/cli.doc.ts

@@ -67,7 +67,7 @@ export class DocCommand implements CliCommandShape {
   }
 
   async render(): Promise<void> {
-    const { DocRenderer } = await import('../src/render/renderer');
+    const { DocRenderer } = await import('../src/render/renderer.ts');
     const ctx = await DocRenderer.get(this.input, Runtime);
     const outputs = this.outputs.map(output =>
       output.includes('.') ? [path.extname(output).replace('.', ''), path.resolve(output)] :