@travetto/doc 3.0.0-rc.2 → 3.0.0-rc.20

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/doc/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/doc/DOC.ts and execute "npx trv doc" to rebuild -->
 # Documentation
 ## Documentation support for the travetto framework
 
@@ -14,7 +14,7 @@ This module provides the ability to generate documentation in [HTML](https://en.
 ```typescript
 import { d, mod } from '@travetto/doc';
 
-export const text = d`
+export const text = () => d`
 ${d.Header()}
 
 Sample documentation for fictional module.  This module fictitiously relies upon ${mod.Cache} functionality.
@@ -27,7 +27,7 @@ ${d.Ordered(
 
 ${d.Section('Content')}
 
-${d.Code('Document Sample', 'docs/test.ts')}
+${d.Code('Document Sample', './src/test.ts')}
 
 ${d.SubSection('Output')}
 
@@ -38,7 +38,7 @@ ${d.Execute('Run program', 'trv')}
 **Code: Document Context**
 ```typescript
 export interface DocumentShape<T extends DocNode = DocNode> {
-  text: T | (() => (T | Promise<T>));
+  text: () => (T | Promise<T>);
   wrap?: Wrapper;
 }
 ```
@@ -81,7 +81,7 @@ As you can see, you need to export a field named `text` as the body of the help
    *  `Table` - Table
    *  `TableOfContents` - Table Of Contents
    *  `Terminal` - Terminal output
-   *  `Text` - Simple Text Content
+   *  `Text` - Simple Text Contentf
 
 ## Libraries
 
@@ -102,31 +102,29 @@ $ trv doc --help
 Usage:  doc [options]
 
 Options:
-  -i, --input <input>    Input File (default: "doc.ts")
-  -o, --output <output>  Output files (default: [])
-  -f, --format <format>  Format (default: "md")
-  -w, --watch            Watch
-  -h, --help             display help for command
+  -i, --input <input>      Input File (default: "DOC.ts")
+  -o, --outputs <outputs>  Outputs (default: [])
+  -w, --watch              Watch
+  -h, --help               display help for command
 ```
 
 By default, running the command will output the [Markdown](https://en.wikipedia.org/wiki/Markdown) content directly to the terminal.
 
 **Terminal: Sample CLI Output**
 ```bash
-$ trv doc -i docs/sample/doc.ts -f html
+$ trv doc -o html
 
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/doc/docs/sample/doc.ts and execute "npx trv doc" to rebuild -->
-<h1>Documentation
-          <small>Documentation support for the travetto framework</small>
-
+<!-- Please modify @travetto/doc/doc-exec/DOC.ts and execute "npx trv doc" to rebuild -->
+<h1>@travetto-doc/doc
+          
         </h1>
 
       <figure class="install">
-      <figcaption class="install">Install @travetto/doc
+      <figcaption class="install">Install @travetto-doc/doc
       
       </figcaption>
-      <pre><code class="language-bash"><span class="token function">npm</span> <span class="token function">install</span> @travetto/doc</code></pre>     
+      <pre><code class="language-bash"><span class="token function">npm</span> <span class="token function">install</span> @travetto-doc/doc</code></pre>     
       </figure>
 
 Sample documentation for fictional module.  This module fictitiously relies upon <a class="module-link" href="https://github.com/travetto/travetto/tree/main/module/cache" title="Caching functionality with decorators for declarative use.">Caching</a> functionality.
@@ -139,7 +137,7 @@ Sample documentation for fictional module.  This module fictitiously relies upon
 
       <figure class="code">
       <figcaption class="code">Document Sample
-      <cite><a target="_blank" href="https://github.com/travetto/travetto/tree/main/module/doc/docs/test.ts">Source</a></cite>
+      <cite><a target="_blank" href="@travetto/doc/doc-exec/src/test.ts">Source</a></cite>
       </figcaption>
       <pre><code class="language-typescript"><span class="token keyword">class</span> <span class="token class-name">TestFile</span> <span class="token punctuation">{{'{'}}</span>
   <span class="token keyword">static</span> <span class="token function">method</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">:</span> <span class="token keyword">void</span> <span class="token punctuation">{{'{'}}</span> <span class="token punctuation">{{'}'}}</span>
@@ -157,14 +155,13 @@ Sample documentation for fictional module.  This module fictitiously relies upon
 Usage:  <span class="token punctuation">[</span>options<span class="token punctuation">]</span> <span class="token punctuation">[</span>command<span class="token punctuation">]</span>
 
 Options:
-  -V, <span class="token parameter variable">--version</span>                output the version number
-  -h, <span class="token parameter variable">--help</span>                   display <span class="token builtin class-name">help</span> <span class="token keyword">for</span> <span class="token builtin class-name">command</span>
+  -V, <span class="token parameter variable">--version</span>                  output the version number
+  -h, <span class="token parameter variable">--help</span>                     display <span class="token builtin class-name">help</span> <span class="token keyword">for</span> <span class="token builtin class-name">command</span>
 
 Commands:
-  build <span class="token punctuation">[</span>options<span class="token punctuation">]</span>
-  clean <span class="token punctuation">[</span>options<span class="token punctuation">]</span>
   doc <span class="token punctuation">[</span>options<span class="token punctuation">]</span>
-  <span class="token builtin class-name">test</span> <span class="token punctuation">[</span>options<span class="token punctuation">]</span> <span class="token punctuation">[</span>regexes<span class="token punctuation">..</span>.<span class="token punctuation">]</span>
-  <span class="token builtin class-name">help</span> <span class="token punctuation">[</span>command<span class="token punctuation">]</span>               display <span class="token builtin class-name">help</span> <span class="token keyword">for</span> <span class="token builtin class-name">command</span></code></pre>     
+  main <span class="token operator">&lt;</span>fileOrImport<span class="token operator">></span> <span class="token punctuation">[</span>args<span class="token punctuation">..</span>.<span class="token punctuation">]</span>
+  <span class="token builtin class-name">help</span> <span class="token punctuation">[</span>command<span class="token punctuation">]</span>                 display <span class="token builtin class-name">help</span> <span class="token keyword">for</span> <span class="token builtin class-name">command</span></code></pre>     
       </figure>
+Wrote docs for DOC.ts
 ```

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/doc",
-  "displayName": "Documentation",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0-rc.20",
   "description": "Documentation support for the travetto framework",
   "keywords": [
     "docs",
@@ -15,27 +14,34 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "bin",
-    "index.ts",
-    "src"
+    "__index__.ts",
+    "src",
+    "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/doc"
   },
   "dependencies": {
-    "@travetto/base": "^3.0.0-rc.2",
+    "@travetto/base": "^3.0.0-rc.20",
+    "@types/prismjs": "^1.26.0",
     "prismjs": "^1.29.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.0-rc.2"
+    "@travetto/cli": "^3.0.0-rc.23"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {
       "optional": true
     }
   },
+  "travetto": {
+    "profiles": [
+      "doc"
+    ],
+    "displayName": "Documentation"
+  },
   "private": false,
   "publishConfig": {
     "access": "public"

package/src/doc.ts

@@ -1,6 +1,6 @@
 import { AllType, node } from './nodes';
 
-export function doc(values: TemplateStringsArray, ...keys: (AllType | { ᚕfile: string, name: string } | string)[]): AllType {
+export function doc(values: TemplateStringsArray, ...keys: (AllType | Function | string)[]): AllType {
   const out: AllType[] = [];
 
   keys.forEach((el, i) =>
@@ -8,7 +8,7 @@ export function doc(values: TemplateStringsArray, ...keys: (AllType | { ᚕfile:
       node.Text(values[i] ?? ''),
       typeof el === 'string' ?
         node.Text(el) :
-        'ᚕfile' in el ? node.Ref(el.name.replace(/[$]/, ''), el.ᚕfile) : el
+        typeof el === 'function' ? node.Ref(el.name, el) : el
     )
   );
 

package/src/mod-mapping.ts

@@ -0,0 +1,258 @@
+export const MOD_MAPPING = {
+  App: {
+    name:'@travetto/app', folder:'@travetto/app', displayName: 'Application',
+    description: 'Application registration/management and run support.'
+  },
+  Asset: {
+    name:'@travetto/asset', folder:'@travetto/asset', displayName: 'Asset',
+    description: 'Modular library for storing and retrieving binary assets'
+  },
+  AssetRest: {
+    name:'@travetto/asset-rest', folder:'@travetto/asset-rest', displayName: 'Asset Rest Support',
+    description: 'Provides integration between the travetto asset and rest module.'
+  },
+  Auth: {
+    name:'@travetto/auth', folder:'@travetto/auth', displayName: 'Authentication',
+    description: 'Authentication scaffolding for the travetto framework'
+  },
+  AuthModel: {
+    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'
+  },
+  AuthRestContext: {
+    name:'@travetto/auth-rest-context', folder:'@travetto/auth-rest-context', displayName: 'Rest Auth Context',
+    description: 'Rest authentication context integration support for the travetto framework'
+  },
+  AuthRestJwt: {
+    name:'@travetto/auth-rest-jwt', folder:'@travetto/auth-rest-jwt', displayName: 'Rest Auth JWT',
+    description: 'Rest authentication JWT 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'
+  },
+  Base: {
+    name:'@travetto/base', folder:'@travetto/base', displayName: 'Base',
+    description: 'Environment config and common utilities for travetto applications.'
+  },
+  Cache: {
+    name:'@travetto/cache', folder:'@travetto/cache', displayName: 'Caching',
+    description: 'Caching functionality with decorators for declarative use.'
+  },
+  Cli: {
+    name:'@travetto/cli', folder:'@travetto/cli', displayName: 'Command Line Interface',
+    description: 'CLI infrastructure for travetto framework'
+  },
+  Command: {
+    name:'@travetto/command', folder:'@travetto/command', displayName: 'Command',
+    description: 'Support for executing complex commands at runtime.'
+  },
+  Compiler: {
+    name:'@travetto/compiler', folder:'@travetto/compiler', displayName: 'Compiler',
+    description: 'Compiler'
+  },
+  Config: {
+    name:'@travetto/config', folder:'@travetto/config', displayName: 'Configuration',
+    description: 'Configuration support'
+  },
+  Context: {
+    name:'@travetto/context', folder:'@travetto/context', displayName: 'Async Context',
+    description: 'Async-aware state management, maintaining context across asynchronous calls.'
+  },
+  Di: {
+    name:'@travetto/di', folder:'@travetto/di', displayName: 'Dependency Injection',
+    description: 'Dependency registration/management and injection support.'
+  },
+  Doc: {
+    name:'@travetto/doc', folder:'@travetto/doc', displayName: 'Documentation',
+    description: 'Documentation support for the travetto framework'
+  },
+  Email: {
+    name:'@travetto/email', folder:'@travetto/email', displayName: 'Email',
+    description: 'Email transmission module.'
+  },
+  EmailNodemailer: {
+    name:'@travetto/email-nodemailer', folder:'@travetto/email-nodemailer', displayName: 'Email Nodemailer Support',
+    description: 'Email transmission module.'
+  },
+  EmailTemplate: {
+    name:'@travetto/email-template', folder:'@travetto/email-template', displayName: 'Email Templating',
+    description: 'Email templating module'
+  },
+  Eslint: {
+    name:'@travetto/eslint', folder:'@travetto/eslint', displayName: 'ES Linting Rules',
+    description: 'ES Linting Rules'
+  },
+  Image: {
+    name:'@travetto/image', folder:'@travetto/image', displayName: 'Image',
+    description: 'Image support, resizing, and optimization'
+  },
+  Jwt: {
+    name:'@travetto/jwt', folder:'@travetto/jwt', displayName: 'JWT',
+    description: 'JSON Web Token implementation'
+  },
+  Log: {
+    name:'@travetto/log', folder:'@travetto/log', displayName: 'Logging',
+    description: 'Logging framework that integrates at the console.log level.'
+  },
+  Manifest: {
+    name:'@travetto/manifest', folder:'@travetto/manifest', displayName: 'Manifest',
+    description: 'Manifest support'
+  },
+  Model: {
+    name:'@travetto/model', folder:'@travetto/model', displayName: 'Data Modeling Support',
+    description: 'Datastore abstraction for core operations.'
+  },
+  ModelDynamodb: {
+    name:'@travetto/model-dynamodb', folder:'@travetto/model-dynamodb', displayName: 'DynamoDB Model Support',
+    description: 'DynamoDB backing for the travetto model module.'
+  },
+  ModelElasticsearch: {
+    name:'@travetto/model-elasticsearch', folder:'@travetto/model-elasticsearch', displayName: 'Elasticsearch Model Source',
+    description: 'Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.'
+  },
+  ModelFirestore: {
+    name:'@travetto/model-firestore', folder:'@travetto/model-firestore', displayName: 'Firestore Model Support',
+    description: 'Firestore backing for the travetto model module.'
+  },
+  ModelMongo: {
+    name:'@travetto/model-mongo', folder:'@travetto/model-mongo', displayName: 'MongoDB Model Support',
+    description: 'Mongo backing for the travetto model module.'
+  },
+  ModelMysql: {
+    name:'@travetto/model-mysql', folder:'@travetto/model-mysql', displayName: 'MySQL Model Service',
+    description: 'MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
+  },
+  ModelPostgres: {
+    name:'@travetto/model-postgres', folder:'@travetto/model-postgres', displayName: 'PostgreSQL Model Service',
+    description: 'PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
+  },
+  ModelQuery: {
+    name:'@travetto/model-query', folder:'@travetto/model-query', displayName: 'Data Model Querying',
+    description: 'Datastore abstraction for advanced query support.'
+  },
+  ModelRedis: {
+    name:'@travetto/model-redis', folder:'@travetto/model-redis', displayName: 'Redis Model Support',
+    description: 'Redis backing for the travetto model module.'
+  },
+  ModelS3: {
+    name:'@travetto/model-s3', folder:'@travetto/model-s3', displayName: 'S3 Model Support',
+    description: 'S3 backing for the travetto model module.'
+  },
+  ModelSql: {
+    name:'@travetto/model-sql', folder:'@travetto/model-sql', displayName: 'SQL Model Service',
+    description: 'SQL backing for the travetto model module, with real-time modeling support for SQL schemas.'
+  },
+  ModelSqlite: {
+    name:'@travetto/model-sqlite', folder:'@travetto/model-sqlite', displayName: 'SQLite Model Service',
+    description: 'SQLite backing for the travetto model module, with real-time modeling support for SQL schemas.'
+  },
+  Openapi: {
+    name:'@travetto/openapi', folder:'@travetto/openapi', displayName: 'OpenAPI Specification',
+    description: 'OpenAPI integration support for the travetto framework'
+  },
+  Overview: {
+    name:'@travetto/overview', folder:'@travetto/overview', displayName: 'Overview Docs',
+    description: 'Documentation overview'
+  },
+  Pack: {
+    name:'@travetto/pack', folder:'@travetto/pack', displayName: 'Pack',
+    description: 'Code packing utilities'
+  },
+  Registry: {
+    name:'@travetto/registry', folder:'@travetto/registry', displayName: 'Registry',
+    description: 'Patterns and utilities for handling registration of metadata and functionality for run-time use'
+  },
+  Repo: {
+    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.'
+  },
+  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.'
+  },
+  RestModel: {
+    name:'@travetto/rest-model', folder:'@travetto/rest-model', displayName: 'RESTful Model Routes',
+    description: 'RESTful support for generating APIs from Model classes.'
+  },
+  RestModelQuery: {
+    name:'@travetto/rest-model-query', folder:'@travetto/rest-model-query', displayName: 'RESTful Model Query Routes',
+    description: 'RESTful support for generating query APIs from Model classes.'
+  },
+  RestSession: {
+    name:'@travetto/rest-session', folder:'@travetto/rest-session', displayName: 'REST Session',
+    description: 'Session provider for the travetto rest module.'
+  },
+  Scaffold: {
+    name:'@travetto/scaffold', folder:'@travetto/scaffold', displayName: 'App Scaffold',
+    description: 'App Scaffold for the Travetto framework'
+  },
+  Schema: {
+    name:'@travetto/schema', folder:'@travetto/schema', displayName: 'Schema',
+    description: 'Data type registry for runtime validation, reflection and binding.'
+  },
+  SchemaFaker: {
+    name:'@travetto/schema-faker', folder:'@travetto/schema-faker', displayName: 'Schema Faker',
+    description: 'Data generation for schema-registered objects.'
+  },
+  Terminal: {
+    name:'@travetto/terminal', folder:'@travetto/terminal', displayName: 'Terminal',
+    description: 'General terminal support'
+  },
+  Test: {
+    name:'@travetto/test', folder:'@travetto/test', displayName: 'Testing',
+    description: 'Declarative test framework'
+  },
+  TodoApp: {
+    name:'@travetto/todo-app', folder:'@travetto/todo-app', displayName: 'Todo Application',
+    description: ''
+  },
+  Transformer: {
+    name:'@travetto/transformer', folder:'@travetto/transformer', displayName: 'Transformation',
+    description: 'Functionality for AST transformations, with transformer registration, and general utils'
+  },
+  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/mod.ts

@@ -1,73 +1,6 @@
-import { AllTypeMap, node } from './nodes';
+import { node } from './nodes';
+import { MOD_MAPPING } from './mod-mapping';
 
-const MAPPING = {
-  App: '@travetto/app',
-  Asset: '@travetto/asset',
-  AssetRest: '@travetto/asset-rest',
-  Auth: '@travetto/auth',
-  AuthRest: '@travetto/auth-rest',
-  AuthRestContext: '@travetto/auth-rest-context',
-  AuthRestJwt: '@travetto/auth-rest-jwt',
-  AuthRestSession: '@travetto/auth-rest-session',
-  AuthRestPassport: '@travetto/auth-rest-passport',
-  Base: '@travetto/base',
-  Boot: '@travetto/boot',
-  Cache: '@travetto/cache',
-  Cli: '@travetto/cli',
-  Command: '@travetto/command',
-  Compiler: '@travetto/compiler',
-  Config: '@travetto/config',
-  Context: '@travetto/context',
-  Di: '@travetto/di',
-  Doc: '@travetto/doc',
-  Email: '@travetto/email',
-  EmailNodemailer: '@travetto/email-nodemailer',
-  EmailTemplate: '@travetto/email-template',
-  Image: '@travetto/image',
-  Jwt: '@travetto/jwt',
-  Log: '@travetto/log',
-  Model: '@travetto/model',
-  ModelDynamodb: '@travetto/model-dynamodb',
-  ModelElasticsearch: '@travetto/model-elasticsearch',
-  ModelFirestore: '@travetto/model-firestore',
-  ModelMongo: '@travetto/model-mongo',
-  ModelQuery: '@travetto/model-query',
-  ModelRedis: '@travetto/model-redis',
-  ModelS3: '@travetto/model-s3',
-  ModelSQLite: '@travetto/model-sqlite',
-  ModelPostgres: '@travetto/model-postgres',
-  ModelMysql: '@travetto/model-mysql',
-  ModelSql: '@travetto/model-sql',
-  Openapi: '@travetto/openapi',
-  Pack: '@travetto/pack',
-  Registry: '@travetto/registry',
-  Rest: '@travetto/rest',
-  RestAwsLambda: '@travetto/rest-aws-lambda',
-  RestExpress: '@travetto/rest-express',
-  RestExpressLambda: '@travetto/rest-express-lambda',
-  RestFastify: '@travetto/rest-fastify',
-  RestFastifyLambda: '@travetto/rest-fastify-lambda',
-  RestKoa: '@travetto/rest-koa',
-  RestKoaLambda: '@travetto/rest-koa-lambda',
-  RestModel: '@travetto/rest-model',
-  RestModelQuery: '@travetto/rest-model-query',
-  RestSession: '@travetto/rest-session',
-  Scaffold: '@travetto/scaffold',
-  Schema: '@travetto/schema',
-  SchemaFaker: '@travetto/schema-faker',
-  Test: '@travetto/test',
-  Transformer: '@travetto/transformer',
-  Watch: '@travetto/watch',
-  Worker: '@travetto/worker',
-  Yaml: '@travetto/yaml'
-};
-
-export const mod = new Proxy<Record<keyof typeof MAPPING, AllTypeMap['Mod']>>(
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-  {} as Record<keyof typeof MAPPING, AllTypeMap['Mod']>,
-  {
-    get(tgt, p: keyof typeof MAPPING): AllTypeMap['Mod'] {
-      return node.Mod(MAPPING[p]);
-    }
-  }
+export const mod = Object.fromEntries(
+  Object.entries(MOD_MAPPING).map(([k, v]) => [k, node.Mod(v.name, v)])
 );

package/src/nodes.ts

@@ -1,5 +1,6 @@
-import { PathUtil, Package, FsUtil } from '@travetto/boot';
-import { readPackage } from '@travetto/boot/src/internal/package';
+import { existsSync } from 'fs';
+
+import { path, RootIndex, PackageUtil } from '@travetto/manifest';
 
 import { FileUtil, } from './util/file';
 import { DocRunUtil, RunConfig } from './util/run';
@@ -18,6 +19,8 @@ const $n = <T extends string, U extends Record<string, unknown>>(t: T, values: U
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   ({ _type: t, ...values } as { _type: T } & U);
 
+type FormattedCommand = { formatCommand?(cmd: string, args: string[]): string };
+
 /* eslint-disable @typescript-eslint/explicit-function-return-type */
 
 /**
@@ -156,27 +159,34 @@ export const node = {
    * @param args
    * @param cfg
    */
-  Execute: (title: Content, cmd: string, args: string[] = [], cfg: RunConfig = {}) => {
+  Execute: (title: Content, cmd: string, args: string[] = [], cfg: RunConfig & FormattedCommand = {}) => {
     if (cmd !== 'trv') {
-      cmd = FileUtil.resolveFile(cmd).resolved.replace(PathUtil.cwd, '.');
+      cmd = FileUtil.resolveFile(cmd).replace(path.cwd(), '.');
     }
 
     const script = DocRunUtil.run(cmd, args, cfg);
-    const prefix = !/.*\/doc\/.*[.]ts$/.test(cmd) ? '$' :
-      `$ node @travetto/${cfg.module ?? 'base'}/bin/main`;
+    const prefix = !/.*\/doc\/.*[.]ts$/.test(cmd) ? '$' : '$ node ';
+
+    const commandDisplay = cfg.formatCommand?.(cmd, args) ?? `${cmd} ${args.join(' ')}`;
 
-    return node.Terminal(title, `${prefix} ${cmd} ${args.join(' ')}\n\n${script}`);
+    return node.Terminal(title, `${prefix} ${commandDisplay}\n\n${script}`);
   },
 
   /**
    * Node Module Reference
-   * @param folder
-   */
-  Mod(folder: string) {
-    folder = PathUtil.resolveFrameworkPath(PathUtil.resolveUnix('node_modules', folder));
-
-    const { description, displayName } = readPackage(folder);
-    return $n('mod', { title: $c(displayName!), link: $c(folder), description: $c(description!) });
+   * @param name
+   */
+  Mod(name: string, cfg?: { folder: string, displayName: string, description: string }) {
+    if (!cfg) {
+      const folder = RootIndex.getModule(name)!.sourcePath;
+      const pkg = PackageUtil.readPackage(folder);
+      cfg = {
+        folder,
+        displayName: pkg.travetto!.displayName!,
+        description: pkg.description!
+      };
+    }
+    return $n('mod', { title: $c(cfg.displayName), link: $c(cfg.folder), description: $c(cfg.description), name: $c(name) });
   },
 
   /**
@@ -184,7 +194,10 @@ export const node = {
    * @param title
    * @param file
    */
-  Ref: (title: Content, file: string) => {
+  Ref: (title: Content, file: string | Function) => {
+    if (typeof file === 'function') {
+      file = RootIndex.getFunctionMetadata(file)!.source;
+    }
     const res = ResolveUtil.resolveRef(title, file);
     return $n('ref', { title: $c(res.title), link: $c(res.file), line: res.line });
   },
@@ -196,7 +209,10 @@ export const node = {
    * @param outline
    * @param language
    */
-  Code: (title: Content, content: Content, outline = false, language = 'typescript') => {
+  Code: (title: Content, content: Content | Function, outline = false, language = 'typescript') => {
+    if (typeof content === 'function') {
+      content = RootIndex.getFunctionMetadata(content)!.source;
+    }
     const res = ResolveUtil.resolveCode(content, language, outline);
     return $n('code', { title: $c(title), content: $c(res.content), language: res.language, file: $c(res.file) });
   },
@@ -217,8 +233,13 @@ export const node = {
    * @param install
    * @param pkg
    */
-  Header: (install = true, pkg = Package) =>
-    $n('header', { title: $c(pkg.displayName ?? pkg.name), description: $c(pkg.description), package: pkg.name, install }),
+  Header: (mod?: string, install = true) => {
+    if (!mod) {
+      mod = RootIndex.mainPackage.name;
+    }
+    const pkg = PackageUtil.readPackage(RootIndex.getModule(mod)!.sourcePath);
+    return $n('header', { title: $c(pkg.travetto?.displayName ?? pkg.name), description: $c(pkg.description), package: pkg.name, install });
+  },
 
   /**
    * Comment
@@ -235,7 +256,10 @@ export const node = {
    * @param endPattern
    * @param outline
    */
-  Snippet: (title: Content, file: string, startPattern: RegExp, endPattern?: RegExp, outline?: boolean) => {
+  Snippet: (title: Content, file: string | Function, startPattern: RegExp, endPattern?: RegExp, outline?: boolean) => {
+    if (typeof file !== 'string') {
+      file = RootIndex.getFunctionMetadata(file)!.source;
+    }
     const res = ResolveUtil.resolveSnippet(file, startPattern, endPattern, outline);
     return $n('code', {
       title: $c(title), content: $c(res.text), line: res.line, file: $c(res.file), language: res.language,
@@ -284,7 +308,7 @@ export const node = {
    * @param file
    */
   Image: (title: Content, file: string) => {
-    if (!/^https?:/.test(file) && !FsUtil.existsSync(file)) {
+    if (!/^https?:/.test(file) && !existsSync(file)) {
       throw new Error(`${file} is not a valid location`);
     }
     return $n('image', { title: $c(title), link: $c(file) });