@travetto/doc 7.1.3 → 7.1.4

package/__index__.ts

@@ -2,4 +2,5 @@ export { type JSXElement as DocJSXElement, isJSXElement as isDocJSXElement } fro
 export { c, d, JSXElementByFn as DocJSXElementByFn } from './src/jsx.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';
+export { DocRunUtil, COMMON_DATE } from './src/util/run.ts';
+export { PackageDocUtil } from './src/util/package.ts';

package/package.json

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

package/src/jsx.ts

@@ -1,11 +1,11 @@
-import { castTo, Runtime, TypedObject } from '@travetto/runtime';
-import { PackageUtil } from '@travetto/manifest';
+import { castTo, TypedObject } from '@travetto/runtime';
 
 import type { LIBRARIES } from './mapping/library.ts';
 import type { MODULES } from './mapping/module.ts';
 import type { CodeProps, RunConfig } from './util/types.ts';
 
 import { createElement, type JSXElement, type JSXComponentFunction as CompFn } from '../support/jsx-runtime.ts';
+import { PackageDocUtil } from './util/package.ts';
 
 type InstallProps = { title: string, pkg: string };
 type ExecProps = { title: string, cmd: string, args?: string[], config?: RunConfig & { formatCommand?(cmd: string, args: string[]): string } };
@@ -106,7 +106,5 @@ export const d = {
   field: (name: string) => createElement(c.Field, { name }),
   library: (name: keyof typeof LIBRARIES) => createElement(c.Library, { name }),
   module: (name: keyof typeof MODULES) => createElement(c.Module, { name }),
-  installCommand: (pkg: string, production?: boolean) => PackageUtil.getInstallCommand(Runtime, pkg, production),
-  workspaceInitCommand: () => PackageUtil.getWorkspaceInitCommand(Runtime),
-  get trv() { return PackageUtil.getPackageCommand(Runtime, 'trv'); },
+  get trv() { return PackageDocUtil.getPackageCommand('trv'); },
 };

package/src/mapping/library.ts

@@ -5,7 +5,8 @@ export const LIBRARIES = {
   Node: { title: 'Node', href: 'https://nodejs.org' },
   TravettoPlugin: { title: 'VSCode plugin', href: 'https://marketplace.visualstudio.com/items?itemName=arcsine.travetto-plugin' },
   Npm: { title: 'Npm', href: 'https://docs.npmjs.com/downloading-and-installing-node-js-and-npm' },
-  Yarn: { title: 'Yarn', href: 'https://yarnpg.com' },
+  Yarn: { title: 'Yarn', href: 'https://yarnpkg.com' },
+  Pnpm: { title: 'Pnpm', href: 'https://pnpm.io/' },
   Eslint: { title: 'ESLint', href: 'https://eslint.org/' },
   Rollup: { title: 'Rollup', href: 'https://rollupjs.org/' },
   TSConfig: { title: 'TS Config', href: 'https://www.typescriptlang.org/docs/handbook/tsconfig-json.html' },

package/src/render/html.ts

@@ -11,6 +11,7 @@ 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';
+import { PackageDocUtil } from '../util/package.ts';
 
 const ESCAPE_ENTITIES: Record<string, string> = { '<': '&lt;', '>': '&gt;', '&': '&amp;', '{': "{{'{'}}", '}': "{{'}'}}" };
 const ENTITY_REGEX = new RegExp(`[${Object.keys(ESCAPE_ENTITIES).join('')}]`, 'gm');
@@ -52,7 +53,7 @@ export const Html: RenderProvider<RenderContext> = {
   },
   Install: async ({ context, node }) => {
     const highlighted = highlight(`
-${PackageUtil.getInstallInstructions(node.props.pkg, true)}
+${PackageDocUtil.getInstallInstructions(node.props.pkg, true)}
 `, 'bash');
 
     return `\n

package/src/render/markdown.ts

@@ -9,6 +9,7 @@ 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 { PackageDocUtil } from '../util/package.ts';
 
 export const Markdown: RenderProvider<RenderContext> = {
   ext: 'md',
@@ -55,7 +56,7 @@ export const Markdown: RenderProvider<RenderContext> = {
   Install: async ({ context, node }) =>
     `\n\n**Install: ${node.props.title}**
 \`\`\`bash
-${PackageUtil.getInstallInstructions(node.props.pkg, true)}
+${PackageDocUtil.getInstallInstructions(node.props.pkg, true)}
 \`\`\`
 `,
   Code: async ({ context, node, props }) => {

package/src/util/package.ts

@@ -0,0 +1,46 @@
+import { PACKAGE_MANAGERS, type NodePackageManager } from '@travetto/manifest';
+import { Runtime } from '@travetto/runtime';
+
+export class PackageDocUtil {
+  /**
+   * Get an the command for executing a package level binary
+   */
+  static getPackageCommand(pkg: string, args: string[] = [], manager?: NodePackageManager): string {
+    switch (manager ?? Runtime.workspace.manager) {
+      case 'npm':
+      case 'yarn': return `npx ${pkg} ${args.join(' ')}`.trim();
+      case 'pnpm': return `pnpm ${pkg} ${args.join(' ')}`.trim();
+    }
+  }
+
+  /**
+   * Get an the command for executing a package level binary
+   */
+  static getWorkspaceInitCommand(manager?: NodePackageManager): string {
+    switch (manager ?? Runtime.workspace.manager) {
+      case 'npm': return 'npm init -f';
+      case 'yarn': return 'yarn init -y';
+      case 'pnpm': return 'pnpm init -y';
+    }
+  }
+
+  /**
+   * Get an install command for a given npm module
+   */
+  static getInstallCommand(pkg: string, production = false, manager?: NodePackageManager): string {
+    switch (manager ?? Runtime.workspace.manager) {
+      case 'npm': return `npm install ${production ? '' : '--save-dev '}${pkg}`;
+      case 'yarn': return `yarn add ${production ? '' : '--dev '}${pkg}`;
+      case 'pnpm': return `pnpm add ${production ? '' : '--dev '}${pkg}`;
+    }
+  }
+
+  /**
+   * Get install example for a given package
+   */
+  static getInstallInstructions(pkg: string, production = false): string {
+    return PACKAGE_MANAGERS
+      .map(manager => this.getInstallCommand(pkg, production, manager.type))
+      .join('\n\n# or\n\n');
+  }
+}