@travetto/doc 7.0.2 → 7.0.4

package/README.md

@@ -23,7 +23,7 @@ import { c } from '@travetto/doc';
 export const text = <>
   <c.StdHeader />
 
-  Sample documentation for fictional module.  This module fictitiously relies upon <c.Mod name='Cache' /> functionality.
+  Sample documentation for fictional module.  This module fictitiously relies upon <c.Module name='Cache' /> functionality.
 
   <ol>
     <li>First</li>
@@ -70,7 +70,7 @@ As you can see, you need to export a field named `text` as the body of the help
    *  `Install` - Installing a package or a program
    *  `Library` - Library reference
    *  `Method` - Method declaration
-   *  `Mod` - Node Module Reference
+   *  `Module` - Node Module Reference
    *  `Note` - A note
    *  `Path` - Path reference
    *  `Ref` - File reference
@@ -84,7 +84,7 @@ As you can see, you need to export a field named `text` as the body of the help
 Some of the more common libraries are provided as the `d.library` method.  The purpose of this is to have consistent references to common utilities to help keep external linking simple.
 
 ## Modules
-You can also link to other [Travetto](https://travetto.dev) based modules as needed.  The `d.mod` object relies on what is already imported into your project, and reference the package.json of the related module. If the module is not installed, doc generation will fail.
+You can also link to other [Travetto](https://travetto.dev) based modules as needed.  The `d.module` object relies on what is already imported into your project, and reference the package.json of the related module. If the module is not installed, doc generation will fail.
 
 ## CLI - doc
 The run command allows for generating documentation output.

package/__index__.ts

@@ -1,5 +1,5 @@
 export { type JSXElement as DocJSXElement, isJSXElement as isDocJSXElement } from './support/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 { MODULES as module } from './src/mapping/module.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": "7.0.2",
+  "version": "7.0.4",
   "description": "Documentation support for the Travetto framework",
   "keywords": [
     "docs",
@@ -24,12 +24,12 @@
     "directory": "module/doc"
   },
   "dependencies": {
-    "@travetto/runtime": "^7.0.2",
+    "@travetto/runtime": "^7.0.4",
     "@types/prismjs": "^1.26.5",
     "prismjs": "^1.30.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.0.2"
+    "@travetto/cli": "^7.0.6"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/jsx.ts

@@ -1,17 +1,17 @@
 import { castTo, TypedObject } from '@travetto/runtime';
 
-import { LIB_MAPPING } from './mapping/lib-mapping.ts';
-import { MOD_MAPPING } from './mapping/mod-mapping.ts';
-import { CodeProps, RunConfig } from './util/types.ts';
+import type { LIBRARIES } from './mapping/library.ts';
+import type { MODULES } from './mapping/module.ts';
+import type { CodeProps, RunConfig } from './util/types.ts';
 
-import { createElement, JSXElement, JSXComponentFunction as CompFn } from '../support/jsx-runtime.ts';
+import { createElement, type JSXElement, type JSXComponentFunction as CompFn } from '../support/jsx-runtime.ts';
 
 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 };
+type StdHeaderProps = { module?: string, install?: boolean };
 type HeaderProps = { title: string, description?: string };
-type ModProps = { name: keyof typeof MOD_MAPPING };
-type LibraryProps = { name: keyof typeof LIB_MAPPING };
+type ModuleProps = { name: keyof typeof MODULES };
+type LibraryProps = { name: keyof typeof LIBRARIES };
 type LinkProps = { title: string, href: string, line?: number };
 type CodeLinkProps = { title: string, src: string | Function, startRe: RegExp };
 type Named = { name: string };
@@ -46,13 +46,13 @@ const StdHeader: CompFn<StdHeaderProps> = () => EMPTY; // Standard module header
 const Header: CompFn<HeaderProps> = () => EMPTY; // Basic module header
 const Execution: CompFn<ExecProps> = () => EMPTY; // Run a command, and include the output as part of the document
 
-const Mod: CompFn<ModProps> = () => EMPTY; // Node Module Reference
+const Module: CompFn<ModuleProps> = () => EMPTY; // Node Module Reference
 const Library: CompFn<LibraryProps> = () => EMPTY; // Library reference
 
 export const c = {
   Input, Field, Method, Command, Path, Class,
   Anchor, Library, Ref, File, Image, CodeLink,
-  Mod, Note, Header, StdHeader,
+  Module, Note, Header, StdHeader,
   Section, SubSection, SubSubSection,
   Code, Execution, Terminal, Install, Config
 } as const;
@@ -103,6 +103,6 @@ export const d = {
   path: (name: string) => createElement(c.Path, { name }),
   command: (name: string) => createElement(c.Command, { name }),
   field: (name: string) => createElement(c.Field, { name }),
-  library: (name: keyof typeof LIB_MAPPING) => createElement(c.Library, { name }),
-  mod: (name: keyof typeof MOD_MAPPING) => createElement(c.Mod, { name }),
+  library: (name: keyof typeof LIBRARIES) => createElement(c.Library, { name }),
+  module: (name: keyof typeof MODULES) => createElement(c.Module, { name }),
 };

package/src/mapping/{lib-mapping.ts → library.ts}

@@ -1,4 +1,4 @@
-export const LIB_MAPPING = {
+export const LIBRARIES = {
   Travetto: { title: 'Travetto', href: 'https://travetto.dev' },
   Typescript: { title: 'Typescript', href: 'https://typescriptlang.org' },
   Javascript: { title: 'Javascript', href: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript' },

package/src/mapping/{mod-mapping.ts → module.ts}

@@ -1,4 +1,4 @@
-export const MOD_MAPPING = {
+export const MODULES = {
   Auth: {
     name: '@travetto/auth', folder: '@travetto/auth', displayName: 'Authentication',
     description: 'Authentication scaffolding for the Travetto framework'
@@ -67,6 +67,10 @@ 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'

package/src/render/context.ts

@@ -3,8 +3,8 @@ import path from 'node:path';
 import { PackageUtil } from '@travetto/manifest';
 import { castTo, RuntimeIndex } from '@travetto/runtime';
 
-import { JSXElementByFn, c } from '../jsx.ts';
-import { DocResolveUtil, ResolvedCode, ResolvedRef, ResolvedSnippetLink } from '../util/resolve.ts';
+import { type JSXElementByFn, c } from '../jsx.ts';
+import { DocResolveUtil, type ResolvedCode, type ResolvedRef, type ResolvedSnippetLink } from '../util/resolve.ts';
 import { DocRunUtil } from '../util/run.ts';
 import { createElement, JSXRuntimeTag } from '../../support/jsx-runtime.ts';
 

package/src/render/html.ts

@@ -4,11 +4,11 @@ import { Runtime, RuntimeIndex } from '@travetto/runtime';
 import { PackageUtil } from '@travetto/manifest';
 
 import { highlight } from './code-highlight.ts';
-import { RenderProvider, RenderState } from '../types.ts';
+import type { 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 { MODULES } from '../mapping/module.ts';
+import { LIBRARIES } from '../mapping/library.ts';
+import type { RenderContext } from './context.ts';
 import { DocResolveUtil } from '../util/resolve.ts';
 import type { JSXElement } from '../../support/jsx-runtime.ts';
 
@@ -133,12 +133,12 @@ yarn add ${node.props.pkg}
     return `<img src="${context.link(props.href, props)}" alt="${props.title}">`;
   },
 
-  Mod: async ({ context, props }) => {
-    const config = MOD_MAPPING[props.name];
+  Module: async ({ context, props }) => {
+    const config = MODULES[props.name];
     return `<a class="module-link" href="${context.link(config.folder, config)}" title="${config.description}">${config.displayName}</a>`;
   },
   Library: async ({ context, props }) => {
-    const config = LIB_MAPPING[props.name];
+    const config = LIBRARIES[props.name];
     return `<a target="_blank" class="external-link" href="${context.link(config.href, config)}">${config.title}</a>`;
   },
 
@@ -146,8 +146,8 @@ yarn add ${node.props.pkg}
   Header: async ({ props }) => `<h1>${props.title} ${props.description ? `\n<small>${props.description}</small>\n` : ''}</h1>\n`,
 
   StdHeader: async state => {
-    const mod = state.node.props.mod ?? Runtime.main.name;
-    const pkg = PackageUtil.readPackage(RuntimeIndex.getModule(mod)!.sourcePath);
+    const module = state.node.props.module ?? Runtime.main.name;
+    const pkg = PackageUtil.readPackage(RuntimeIndex.getModule(module)!.sourcePath);
     const title = pkg.travetto?.displayName ?? pkg.name;
     const desc = pkg.description;
     let install = '';

package/src/render/markdown.ts

@@ -3,11 +3,11 @@ import fs from 'node:fs/promises';
 import { Runtime, RuntimeIndex } from '@travetto/runtime';
 import { PackageUtil } from '@travetto/manifest';
 
-import { RenderProvider } from '../types.ts';
+import type { 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 { MODULES } from '../mapping/module.ts';
+import { LIBRARIES } from '../mapping/library.ts';
+import type { RenderContext } from './context.ts';
 import { DocResolveUtil } from '../util/resolve.ts';
 
 export const Markdown: RenderProvider<RenderContext> = {
@@ -113,8 +113,8 @@ ${context.cleanText(content.text)}
   Header: async ({ props }) => `# ${props.title}\n${props.description ? `## ${props.description}\n` : ''}\n`,
 
   StdHeader: async state => {
-    const mod = state.node.props.mod ?? Runtime.main.name;
-    const pkg = PackageUtil.readPackage(RuntimeIndex.getModule(mod)!.sourcePath);
+    const module = state.node.props.module ?? Runtime.main.name;
+    const pkg = PackageUtil.readPackage(RuntimeIndex.getModule(module)!.sourcePath);
     const title = pkg.travetto?.displayName ?? pkg.name;
     const desc = pkg.description;
     let install = '';
@@ -124,12 +124,12 @@ ${context.cleanText(content.text)}
     }
     return `# ${title}\n${desc ? `## ${desc}\n` : ''}${install}\n`;
   },
-  Mod: async ({ props, context }) => {
-    const config = MOD_MAPPING[props.name];
+  Module: async ({ props, context }) => {
+    const config = MODULES[props.name];
     return `[${config.displayName}](${context.link(config.folder, config)}#readme "${config.description}")`;
   },
   Library: async ({ props }) => {
-    const config = LIB_MAPPING[props.name];
+    const config = LIBRARIES[props.name];
     return `[${config.title}](${config.href})`;
   }
 };

package/src/render/renderer.ts

@@ -1,17 +1,17 @@
 import path from 'node:path';
 
 import { type ManifestContext, PackageUtil } from '@travetto/manifest';
-import { castTo, Class, Runtime } from '@travetto/runtime';
+import { castTo, type Class, Runtime } from '@travetto/runtime';
 
-import { EMPTY_ELEMENT, getComponentName, JSXElementByFn, c } from '../jsx.ts';
-import { DocumentShape, RenderProvider, RenderState } from '../types.ts';
+import { EMPTY_ELEMENT, getComponentName, type JSXElementByFn, type c } from '../jsx.ts';
+import type { DocumentShape, RenderProvider, RenderState } from '../types.ts';
 import { DocFileUtil } from '../util/file.ts';
 
 import { RenderContext } from './context.ts';
 import { Html } from './html.ts';
 import { Markdown } from './markdown.ts';
 
-import { isJSXElement, JSXElement, JSXFragmentType } from '../../support/jsx-runtime.ts';
+import { isJSXElement, type JSXElement, JSXFragmentType } from '../../support/jsx-runtime.ts';
 
 const providers = { [Html.ext]: Html, [Markdown.ext]: Markdown };
 

package/src/types.ts

@@ -1,4 +1,4 @@
-import { JSXElementByFn, c } from './jsx.ts';
+import type { JSXElementByFn, c } from './jsx.ts';
 import type { JSXElement, ValidHtmlTags } from '../support/jsx-runtime.ts';
 
 export type Wrapper = Record<string, (cnt: string) => string>;

package/src/util/file.ts

@@ -2,7 +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';
+import { type ManifestModuleFileType, ManifestModuleUtil } from '@travetto/manifest';
 
 const ESLINT_PATTERN = /\s{0,10}\/\/ eslint.{0,300}$/g;
 const ENV_KEY = /Env.([^.]{1,100})[.]key/g;

package/src/util/resolve.ts

@@ -1,5 +1,5 @@
 import { DocFileUtil } from './file.ts';
-import { CodeProps } from './types.ts';
+import type { CodeProps } from './types.ts';
 
 export type ResolvedRef = { title: string, file: string, line: number };
 export type ResolvedCode = { text: string, language: string, file?: string };

package/src/util/run.ts

@@ -1,10 +1,10 @@
 import os from 'node:os';
 import util from 'node:util';
-import { spawn, ChildProcess } from 'node:child_process';
+import { spawn, type ChildProcess } from 'node:child_process';
 import path from 'node:path';
 
 import { Env, ExecUtil, Runtime, RuntimeIndex } from '@travetto/runtime';
-import { RunConfig } from './types.ts';
+import type { RunConfig } from './types.ts';
 
 export const COMMON_DATE = new Date('2029-03-14T00:00:00.000').getTime();
 

package/support/cli.doc.ts

@@ -4,7 +4,7 @@ import { spawn } from 'node:child_process';
 
 import { PackageUtil } from '@travetto/manifest';
 import { ExecUtil, Env, Runtime, WatchUtil } from '@travetto/runtime';
-import { CliCommandShape, CliCommand, CliValidationError } from '@travetto/cli';
+import { type CliCommandShape, CliCommand, type CliValidationError } from '@travetto/cli';
 import { MinLength } from '@travetto/schema';
 
 /**

package/support/jsx-runtime.ts

@@ -1,4 +1,4 @@
-import { castTo, Class } from '@travetto/runtime';
+import { castTo, type Class } from '@travetto/runtime';
 
 type JSXChild = JSXElement | number | bigint | boolean | object | string;
 type JSXProps = { children?: JSXChild | JSXChild[] | null };