@travetto/doc 6.0.0 → 7.0.0-rc.0

package/package.json

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

package/src/mapping/lib-mapping.ts

@@ -45,6 +45,7 @@ export const LIB_MAPPING = {
   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' },
+  NodeHttp2: { title: 'http2', href: 'https://nodejs.org/api/http2.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' },

package/src/mapping/mod-mapping.ts

@@ -67,10 +67,6 @@ export const MOD_MAPPING = {
     name: '@travetto/email-nodemailer', folder: '@travetto/email-nodemailer', displayName: 'Email Nodemailer Support',
     description: 'Email transmission 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'
@@ -193,7 +189,7 @@ export const MOD_MAPPING = {
   },
   Web: {
     name: '@travetto/web', folder: '@travetto/web', displayName: 'Web API',
-    description: 'Declarative api for Web Applications with support for the dependency injection.'
+    description: 'Declarative support for creating Web Applications'
   },
   WebAwsLambda: {
     name: '@travetto/web-aws-lambda', folder: '@travetto/web-aws-lambda', displayName: 'Web AWS Lambda',
@@ -203,14 +199,10 @@ export const MOD_MAPPING = {
     name: '@travetto/web-connect', folder: '@travetto/web-connect', displayName: 'Web Connect Support',
     description: 'Web integration for Connect-Like Resources'
   },
-  WebHttpServer: {
-    name: '@travetto/web-http-server', folder: '@travetto/web-http-server', displayName: 'Web HTTP Server Support',
+  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'

package/src/util/file.ts

@@ -7,27 +7,29 @@ import { ManifestModuleFileType, ManifestModuleUtil } from '@travetto/manifest';
 const ESLINT_PATTERN = /\s{0,10}\/\/ eslint.{0,300}$/g;
 const ENV_KEY = /Env.([^.]{1,100})[.]key/g;
 
+const MOD_FILE_TO_LANG: Record<ManifestModuleFileType, string | undefined> = {
+  ts: 'typescript',
+  js: 'javascript',
+  md: 'markdown',
+  json: 'json',
+  typings: 'typescript',
+  'package-json': 'json',
+  fixture: undefined,
+  unknown: undefined
+};
+
+const EXT_TO_LANG: Record<string, string> = {
+  '.yaml': 'yaml',
+  '.yml': 'yaml',
+  '.sh': 'bash',
+};
+
 /**
  * Standard file utilities
  */
 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> = {
-    '.yaml': 'yaml',
-    '.yml': 'yaml',
-    '.sh': 'bash',
-  };
 
   static isFile(src: string): boolean {
     return /^[@:A-Za-z0-9\/\\\-_.]+[.]([a-z]{2,10})$/.test(src);
@@ -74,7 +76,7 @@ export class DocFileUtil {
     if (file !== undefined) {
       const ext = path.extname(file);
       const type = ManifestModuleUtil.getFileType(file);
-      const language = this.#modFileTypeToLang[type] ?? this.#extToLang[ext] ?? ext.replace('.', '');
+      const language = MOD_FILE_TO_LANG[type] ?? EXT_TO_LANG[ext] ?? ext.replace('.', '');
       return { content, file, language };
     } else {
       return { content, file: '', language: '' };
@@ -108,7 +110,7 @@ export class DocFileUtil {
     let found = false;
     if (start > 0) {
       for (let i = start - 1; i > start - 3; i--) {
-        if (lines[i].includes('@augments')) {
+        if (lines[i].includes('@kind decorator')) {
           found = true;
           break;
         }

package/src/util/run.ts

@@ -74,7 +74,6 @@ export class DocRunUtil {
   static spawn(cmd: string, args: string[], config: RunConfig = {}): ChildProcess {
     return spawn(cmd, args, {
       cwd: config.cwd ?? this.cwd(config),
-      shell: '/bin/bash',
       env: {
         ...process.env,
         ...Env.DEBUG.export(false),

package/support/cli.doc.ts

@@ -57,7 +57,6 @@ export class DocCommand implements CliCommandShape {
       if (action === 'update' && file === this.input) {
         const proc = spawn('npx', ['trv', ...args], {
           cwd: Runtime.mainSourcePath,
-          shell: false,
           env: { ...process.env, ...Env.TRV_QUIET.export(true) },
           stdio: 'inherit'
         });