@travetto/doc 8.0.0-alpha.1 → 8.0.0-alpha.11

package/README.md

@@ -99,7 +99,7 @@ Options:
   -i, --input <string>    Input File (default: "DOC.tsx")
   -o, --outputs <string>  Outputs (default: ["README.md"])
   -w, --watch             Watch? (default: false)
-  -h, --help              display help for command
+  --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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/doc",
-  "version": "8.0.0-alpha.1",
+  "version": "8.0.0-alpha.11",
   "description": "Documentation support for the Travetto framework",
   "keywords": [
     "docs",
@@ -24,12 +24,12 @@
     "directory": "module/doc"
   },
   "dependencies": {
-    "@travetto/runtime": "^8.0.0-alpha.1",
+    "@travetto/runtime": "^8.0.0-alpha.11",
     "@types/prismjs": "^1.26.6",
     "prismjs": "^1.30.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.1"
+    "@travetto/cli": "^8.0.0-alpha.16"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/mapping/module.ts

@@ -103,6 +103,10 @@ export const MODULES = {
     name: '@travetto/model-firestore', folder: '@travetto/model-firestore', displayName: 'Firestore Model Support',
     description: 'Firestore backing for the travetto model module.'
   },
+  ModelIndexed: {
+    name: '@travetto/model-indexed', folder: '@travetto/model-indexed', displayName: 'Data Model Indexing Support',
+    description: 'Basic indexing support for model sources that support it.'
+  },
   ModelMemory: {
     name: '@travetto/model-memory', folder: '@travetto/model-memory', displayName: 'Memory Model Support',
     description: 'Memory backing for the travetto model module.'

package/src/render/html.ts

@@ -124,7 +124,7 @@ ${PackageDocUtil.getInstallInstructions(node.props.pkg, true)}
   Ref: async ({ context, props }) =>
     `<a target="_blank" class="source-link" href="${context.link(props.href, props)}">${props.title}</a>`,
   Image: async ({ context, props }) => {
-    if (!/^https?:/.test(props.href) && !(await fs.stat(props.href).catch(() => false))) {
+    if (!/^https?:/.test(props.href) && !(await fs.stat(props.href, { throwIfNoEntry: false }))) {
       throw new Error(`${props.href} is not a valid location`);
     }
     return `<img src="${context.link(props.href, props)}" alt="${props.title}">`;

package/src/render/markdown.ts

@@ -101,7 +101,7 @@ ${context.cleanText(content.text)}
   },
 
   Image: async ({ props, context }) => {
-    if (!/^https?:/.test(props.href) && !(await fs.stat(props.href).catch(() => false))) {
+    if (!/^https?:/.test(props.href) && !(await fs.stat(props.href, { throwIfNoEntry: false }))) {
       throw new Error(`${props.href} is not a valid location`);
     }
     return `![${props.title}](${context.link(props.href)})`;

package/support/cli.doc.ts

@@ -12,7 +12,7 @@ import { PackageUtil } from '@travetto/manifest';
 @CliCommand()
 @Validator(async (cmd) => {
   const docFile = path.resolve(cmd.input);
-  if (!(await fs.stat(docFile).catch(() => false))) {
+  if (!(await fs.stat(docFile, { throwIfNoEntry: false }))) {
     return { message: `input: ${cmd.input} does not exist`, path: 'input', source: 'flag', kind: 'invalid' };
   }
 })