@travetto/doc 3.0.2 → 3.1.0-rc.0

package/src/util/run.ts

@@ -1,5 +1,3 @@
-import { spawnSync } from 'child_process';
-
 import { path, RootIndex } from '@travetto/manifest';
 import { ExecUtil, ExecutionOptions, ExecutionState } from '@travetto/base';
 import { stripAnsiCodes } from '@travetto/terminal';
@@ -51,18 +49,19 @@ export class DocRunUtil {
   static #docState = new DocState();
 
   static runState(cmd: string, args: string[], config: RunConfig = {}): RunState {
+    const cwd = config.cwd ?? (config.module ? RootIndex.getModule(config.module)! : RootIndex.mainModule).sourcePath;
     args = [...args];
     return {
       cmd,
       args,
       opts: {
-        cwd: path.toPosix(config.cwd ?? path.cwd()),
+        cwd: path.toPosix(cwd),
         shell: '/bin/bash',
         env: {
           ...process.env,
           DEBUG: '0',
           TRV_MANIFEST: '',
-          TRV_BUILD: 'warn',
+          TRV_BUILD: 'none',
           TRV_MODULE: config.module ?? '',
           ...(config.profiles ? { TRV_PROFILES: config.profiles.join(' ') } : {}),
           ...(config.env ?? {})
@@ -75,9 +74,11 @@ export class DocRunUtil {
    * Clean run output
    */
   static cleanRunOutput(text: string, cfg: RunConfig): string {
+    const cwd = path.toPosix((cfg.module ? RootIndex.getModule(cfg.module)! : RootIndex.mainModule).sourcePath);
     text = stripAnsiCodes(text.trim())
-      .replace(new RegExp(path.cwd(), 'g'), '.')
+      .replaceAll(cwd, '.')
       .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}`)
       .replace(/^(\s*nodeVersion:\s*'v)(\d+)[^']*('[,]?\s*)$/gm, (_, pre, ver, post) => `${pre}${ver}.x.x${post}`)
       .replace(/^(.{1,4})?Compiling[.]*/, '') // Compiling message, remove
@@ -99,35 +100,23 @@ export class DocRunUtil {
    */
   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'
-    });
+    return ExecUtil.spawn(state.cmd, state.args, { ...state.opts, stdio: 'pipe' });
   }
 
   /**
    * Run command synchronously and return output
    */
-  static run(cmd: string, args: string[], config: RunConfig = {}): string {
+  static async run(cmd: string, args: string[], config: RunConfig = {}): Promise<string> {
     let final: string;
     try {
       const state = this.runState(cmd, args, config);
-      const spawnCfg = {
-        ...state.opts,
-        stdio: 'pipe' as const,
-        encoding: 'utf8',
-        maxBuffer: 1024 * 1024 * 20,
-      } as const;
-
-      const res = spawnSync(state.cmd, state.args, spawnCfg);
-
-      if (res.error) {
-        throw res.error;
+      const res = await ExecUtil.spawn(state.cmd, state.args, { stdio: 'pipe', ...state.opts, catchAsResult: true }).result;
+      if (!res.valid) {
+        throw new Error(res.stderr);
       }
       final = stripAnsiCodes(res.stdout.toString()).trim() || stripAnsiCodes(res.stderr.toString()).trim();
     } catch (err) {
       if (err instanceof Error) {
-        console.log('Found!', cmd, args, '\n', err);
         final = err.message;
       } else {
         throw err;

package/support/cli.doc.ts

@@ -1,30 +1,25 @@
 import fs from 'fs/promises';
 
-import { PackageUtil, path, RootIndex, watchFolderImmediate } from '@travetto/manifest';
+import { PackageUtil, path, RootIndex, watchFolders } from '@travetto/manifest';
 import { ExecUtil, GlobalEnvConfig } from '@travetto/base';
-import { CliCommand, OptionConfig, ListOptionConfig } from '@travetto/cli';
-
-import { RenderUtil } from '../src/render/util';
-
-type Options = {
-  input: OptionConfig<string>;
-  outputs: ListOptionConfig<string>;
-  watch: OptionConfig<boolean>;
-};
+import { CliCommandShape, CliCommand, CliValidationError } from '@travetto/cli';
+import { MinLength } from '@travetto/schema';
 
 /**
  * Command line support for generating module docs.
  */
-export class DocCommand extends CliCommand<Options> {
-  name = 'doc';
+@CliCommand()
+export class DocCommand implements CliCommandShape {
 
-  getOptions(): Options {
-    return {
-      input: this.option({ desc: 'Input File', def: 'DOC.ts' }),
-      outputs: this.listOption({ desc: 'Outputs', def: [] }),
-      watch: this.boolOption({ desc: 'Watch' })
-    };
-  }
+  /** Input File */
+  input = 'DOC.tsx';
+
+  /** Outputs */
+  @MinLength(1)
+  outputs: string[] = [];
+
+  /** Watch? */
+  watch = false;
 
   envInit(): GlobalEnvConfig {
     return {
@@ -38,47 +33,60 @@ export class DocCommand extends CliCommand<Options> {
     };
   }
 
-  async action(): Promise<void> {
-    const docFile = path.resolve(this.cmd.input);
-    if (!(await fs.stat(docFile).catch(() => false))) {
-      console.error(`The input ${this.cmd.input} does not exist`);
-      return this.exit(1);
-    }
-
-    if (this.cmd.outputs.length === 0) {
+  finalize(): void {
+    if (this.outputs.length === 0) {
       const workspacePkg = PackageUtil.readPackage(RootIndex.manifest.workspacePath);
-      this.cmd.outputs = workspacePkg.travetto?.docOutputs ?? ['README.md'];
+      this.outputs = workspacePkg.travetto?.docOutputs ?? ['README.md'];
     }
+    this.input = path.resolve(this.input);
+  }
 
-    const outputs = this.cmd.outputs.map(output => output.includes('.') ? [path.extname(output).substring(1), path.resolve(output)] : [output, null] as const);
+  async validate(...args: unknown[]): Promise<CliValidationError | undefined> {
+    const docFile = path.resolve(this.input);
+    if (!(await fs.stat(docFile).catch(() => false))) {
+      return {
+        kind: 'required',
+        path: 'input',
+        message: `The input ${this.input} does not exist`
+      };
+    }
+  }
 
-    if (this.cmd.watch) {
-      const args = process.argv.slice(2).filter(x => !x.startsWith('-w') && !x.startsWith('--w'));
-      await watchFolderImmediate(path.dirname(docFile),
-        () => ExecUtil.spawn('npx', ['trv', ...args], {
+  async runWatch(): Promise<void> {
+    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) {
+      if (action === 'update' && file === this.input) {
+        await ExecUtil.spawn('npx', ['trv', ...args], {
           cwd: RootIndex.mainModule.sourcePath,
           env: { TRV_QUIET: '1' },
           stdio: 'inherit', catchAsResult: true
-        }), {
-        filter: ev => ev.action === 'update' && ev.file === docFile,
-        persistent: true
-      });
+        });
+      }
     }
+  }
+
+  async render(): Promise<void> {
+    const { DocRenderer } = await import('../src/render/renderer.js');
+    const ctx = await DocRenderer.get(this.input, RootIndex.manifest);
+    const outputs = this.outputs.map(output =>
+      output.includes('.') ? [path.extname(output).substring(1), path.resolve(output)] :
+        [output, null] as const
+    );
 
-    try {
-      for (const [fmt, out] of outputs) {
-        const result = await RenderUtil.render(docFile, fmt);
-        if (out) {
-          const finalName = path.resolve(out);
-          await fs.writeFile(finalName, result, 'utf8');
-          console.log(`Wrote docs ${this.cmd.input}: ${finalName}`);
-        } else {
-          process.stdout.write(result);
-        }
+    for (const [fmt, out] of outputs) {
+      const result = await ctx.render(fmt);
+      if (out) {
+        const finalName = path.resolve(out);
+        await fs.writeFile(finalName, result, 'utf8');
+        console.log(`Wrote docs ${this.input}: ${finalName}`);
+      } else {
+        process.stdout.write(result);
       }
-    } catch (err) {
-      console.error(err);
-      this.exit(1);
     }
   }
+
+  main(): Promise<void> {
+    return this.watch ? this.runWatch() : this.render();
+  }
 }

package/src/doc.ts

@@ -1,24 +0,0 @@
-import { AllType, node } from './nodes';
-
-export function doc(values: TemplateStringsArray, ...keys: (AllType | Function | string)[]): AllType {
-  const out: AllType[] = [];
-
-  keys.forEach((el, i) =>
-    out.push(
-      node.Text(values[i] ?? ''),
-      typeof el === 'string' ?
-        node.Text(el) :
-        typeof el === 'function' ? node.Ref(el.name, el) : el
-    )
-  );
-
-  if (values.length > keys.length) {
-    out.push(node.Text(values[values.length - 1]));
-  }
-  return out.length === 1 ? out[0] : node.Group(out);
-}
-
-Object.assign(doc, node);
-
-// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-export const d = doc as (typeof doc) & (typeof node);

package/src/lib.ts

@@ -1,109 +0,0 @@
-import { node } from './nodes';
-
-const { Library } = node;
-
-// Common
-export const lib = {
-  Travetto: Library('Travetto', 'https://travetto.dev'),
-  Typescript: Library('Typescript', 'https://typescriptlang.org'),
-  Javascript: Library('Javascript', 'https://developer.mozilla.org/en-US/docs/Web/JavaScript'),
-  Node: Library('Node', 'https://nodejs.org'),
-  TravettoPlugin: Library('VSCode plugin', 'https://marketplace.visualstudio.com/items?itemName=arcsine.travetto-plugin'),
-  Npm: Library('Npm', 'https://docs.npmjs.com/downloading-and-installing-node-js-and-npm'),
-  Yarn: Library('Yarn', 'https://yarnpg.com'),
-  Eslint: Library('ESLint', 'https://eslint.org/'),
-  Rollup: Library('Rollup', 'https://rollupjs.org/'),
-
-  // Module
-  CommonJS: Library('CommonJS', 'https://nodejs.org/api/modules.html'),
-  EcmascriptModule: Library('Ecmascript Module', 'https://nodejs.org/api/esm.html'),
-  PackageJson: Library('Package JSON', 'https://docs.npmjs.com/cli/v9/configuring-npm/package-json'),
-
-  // Download
-  NodeDownload: Library('Node', 'https://nodejs.org/en/download/current/'),
-  MongoDownload: Library('Mongodb', 'https://docs.mongodb.com/manual/administration/install-community/'),
-  VSCodeDownload: Library('VSCode', 'https://code.visualstudio.com/download'),
-
-  // Data formats
-  YAML: Library('YAML', 'https://en.wikipedia.org/wiki/YAML'),
-  JSON: Library('JSON', 'https://www.json.org'),
-  Base64: Library('Base64', 'https://en.wikipedia.org/wiki/Base64'),
-  TAP: Library('TAP 13', 'https://testanything.org/tap-version-13-specification.html'),
-  XUnit: Library('xUnit', 'https://en.wikipedia.org/wiki/XUnit'),
-  Markdown: Library('Markdown', 'https://en.wikipedia.org/wiki/Markdown'),
-  HTML: Library('HTML', 'https://en.wikipedia.org/wiki/HTML'),
-
-  // Info
-  DependencyInjection: Library('Dependency injection', 'https://en.wikipedia.org/wiki/Dependency_injection'),
-  OpenAPI: Library('OpenAPI', 'https://github.com/OAI/OpenAPI-Specification'),
-  JSDoc: Library('JSDoc', 'http://usejsdoc.org/about-getting-started.html'),
-  CodeLens: Library('CodeLens',
-    'https://code.visualstudio.com/api/language-extensions/programmatic-language-features#codelens-show-actionable-context-information-within-source-code'),
-  ORM: Library('Object Relationship Mapping', 'https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping'),
-  UUID: Library('UUID', 'https://en.wikipedia.org/wiki/Universally_unique_identifier'),
-
-  // Node
-  ChildProcess: Library('child_process', 'https://nodejs.org/api/child_process.html'),
-  AsyncHooks: Library('async_hooks', 'https://nodejs.org/api/async_hooks.html'),
-  Http: Library('http', 'https://nodejs.org/api/http.html'),
-  Path: Library('http', 'https://nodejs.org/api/path.html'),
-  Https: Library('https', 'https://nodejs.org/api/https.html'),
-  Console: Library('console', 'https://nodejs.org/api/console.html'),
-  Assert: Library('assert', 'https://nodejs.org/api/assert.html'),
-
-  // Cloud
-  AwsCloudwatch: Library('AWS Cloudwatch', 'https://aws.amazon.com/cloudwatch/'),
-
-  // Utils
-  Lodash: Library('lodash', 'https://lodash.com'),
-  NodeForge: Library('node-forge', 'https://www.npmjs.com/package/node-forge'),
-  Docker: Library('docker', 'https://www.docker.com/community-edition'),
-  Debug: Library('debug', 'https://www.npmjs.com/package/debug'),
-  OpenAPIGenerator: Library('OpenAPI client generation tools', 'https://github.com/OpenAPITools/openapi-generator'),
-  Gaze: Library('gaze', 'https://github.com/shama/gaze'),
-  Chokidar: Library('chokidar', 'https://github.com/paulmillr/chokidar'),
-  Faker: Library('faker', 'https://github.com/faker-js/faker'),
-  Yeoman: Library('yeoman', 'http://yeoman.io'),
-  Commander: Library('commander', 'https://www.npmjs.com/package/commander'),
-  Curl: Library('curl', 'https://curl.haxx.se/'),
-  Fetch: Library('fetch', 'https://www.npmjs.com/package/node-fetch'),
-  ParcelWatcher: Library('fetch', 'https://www.npmjs.com/package/@parcel/watcher'),
-
-  // JWT
-  JWT: Library('JWT', 'https://jwt.io/'),
-  NodeJWT: Library('node-jsonwebtoken', 'https://github.com/auth0/node-jsonwebtoken'),
-
-  // Email
-  NodeMailer: Library('nodemailer', 'https://nodemailer.com/about/'),
-  Inky: Library('inky', 'https://github.com/zurb/inky'),
-  Sass: Library('sass', 'https://github.com/sass/dart-sass'),
-  Mustache: Library('mustache', 'https://github.com/janl/mustache.js/'),
-
-  // Image
-  ImageMagick: Library('ImageMagick', 'https://imagemagick.org/index.php'),
-  PngQuant: Library('pngquant', 'https://pngquant.org/'),
-  JpegOptim: Library('Jpegoptim', 'https://github.com/tjko/jpegoptim'),
-
-  // Dbs
-  MongoDB: Library('mongodb', 'https://mongodb.com'),
-  S3: Library('s3', 'https://aws.amazon.com/documentation/s3/'),
-  Redis: Library('redis', 'https://redis.io'),
-  Memcached: Library('memcached', 'https://memcached.org'),
-  Elasticsearch: Library('elasticsearch', 'https://elastic.co'),
-  SQL: Library('SQL', 'https://en.wikipedia.org/wiki/SQL'),
-  MySQL: Library('MySQL', 'https://www.mysql.com/'),
-  Postgres: Library('Postgres', 'https://postgresql.org'),
-  DynamoDB: Library('DynamoDB', 'https://aws.amazon.com/dynamodb/'),
-  Firestore: Library('Firestore', 'https://firebase.google.com/docs/firestore'),
-  SQLite: Library('SQLite', 'https://www.sqlite.org/'),
-
-  // Rest
-  Express: Library('express', 'https://expressjs.com'),
-  Passport: Library('passport', 'http://passportjs.org'),
-  Busboy: Library('busboy', 'https://github.com/mscdex/busboy'),
-  Cookies: Library('cookies', 'https://www.npmjs.com/package/cookies'),
-  ServerlessExpress: Library('aws-serverless-express', 'https://github.com/awslabs/aws-serverless-express/blob/master/README.md'),
-  AwsLambdaFastify: Library('@fastify/aws-lambda', 'https://github.com/fastify/aws-lambda-fastify/blob/master/README.md'),
-  Fastify: Library('fastify', 'https://www.fastify.io/'),
-  Koa: Library('koa', 'https://koajs.com/'),
-};

package/src/mod-mapping.ts

@@ -1,258 +0,0 @@
-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: 'The compiler infrastructure for the Travetto framework'
-  },
-  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: 'Support for project indexing, manifesting, along with file watching'
-  },
-  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,8 +0,0 @@
-import { TypedObject } from '@travetto/base';
-
-import { node } from './nodes';
-import { MOD_MAPPING } from './mod-mapping';
-
-export const mod = TypedObject.fromEntries(
-  TypedObject.entries(MOD_MAPPING).map(([k, v]) => [k, node.Mod(v.name, v)])
-);