LaunchedExecutionEngine -> ExecutionEngineInstance

make @quarto/types pure type package

Author: gordonwoodhull

packages/quarto-types/package.json

@@ -2,16 +2,13 @@
   "name": "@quarto/types",
   "version": "0.1.0",
   "description": "TypeScript type definitions for Quarto engine development",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "src/index.ts",
   "files": [
-    "dist",
+    "src",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "build": "tsc",
-    "prepare": "npm run build"
   },
   "keywords": [
     "quarto",

packages/quarto-types/src/constants.d.ts

@@ -167,7 +167,7 @@ export interface DependenciesResult {
  */
 export interface PostProcessOptions {
   /** The execution engine */
-  engine: LaunchedExecutionEngine;
+  engine: ExecutionEngineInstance;
 
   /** The execution target */
   target: ExecutionTarget;
@@ -311,17 +311,17 @@ export interface ExecutionEngineDiscovery {
    * This is called when the engine is needed for execution
    *
    * @param context The restricted project context
-   * @returns LaunchedExecutionEngine that can execute documents
+   * @returns ExecutionEngineInstance that can execute documents
    */
-  launch: (context: EngineProjectContext) => LaunchedExecutionEngine;
+  launch: (context: EngineProjectContext) => ExecutionEngineInstance;
 }
 
 /**
  * Interface for a launched execution engine
  * This represents an engine that has been instantiated with a project context
  * and is ready to execute documents
  */
-export interface LaunchedExecutionEngine {
+export interface ExecutionEngineInstance {
   /**
    * Name of the engine
    */

packages/quarto-types/src/constants.ts

@@ -0,0 +1,13 @@
+/**
+ * External engine interfaces for Quarto
+ */
+
+/**
+ * Represents an external engine specified in a project
+ */
+export interface ExternalEngine {
+  /**
+   * Path to the engine implementation
+   */
+  path: string;
+}

packages/quarto-types/src/execution-engine.d.ts

@@ -4,65 +4,19 @@
  */
 
 // Export text types
-export * from './text-types';
-
-// Export constants
-export * from './constants';
+export type * from "./text-types.d.ts";
 
 // Export metadata types
-export * from './metadata-types';
+export type * from "./metadata-types.d.ts";
+
+// Export external engine types
+export type * from "./external-engine.d.ts";
 
 // Export project context types
-export * from './project-context';
+export type * from "./project-context.d.ts";
 
 // Export execution engine types
-export * from './execution-engine';
-
-// Export external engine types
-export * from './external-engine';
+export type * from "./execution-engine.d.ts";
 
 // Export Quarto API types
-export * from './quarto-api';
-
-/**
- * Utility to check if a project context satisfies EngineProjectContext interface
- */
-import { EngineProjectContext } from './project-context';
-
-export function isEngineProjectContext(
-  ctx: unknown
-): ctx is EngineProjectContext {
-  if (!ctx) return false;
-
-  const context = ctx as Partial<EngineProjectContext>;
-
-  return (
-    typeof context.dir === 'string' &&
-    typeof context.isSingleFile === 'boolean' &&
-    context.fileInformationCache instanceof Map &&
-    typeof context.resolveFullMarkdownForFile === 'function' &&
-    typeof context.getOutputDirectory === 'function' &&
-    !!context.quarto
-  );
-}
-
-/**
- * Utility to get the output directory from a project context
- */
-import { kProjectOutputDir } from './constants';
-import { resolve, join, isAbsolute } from 'path';
-
-export function projectOutputDir(context: EngineProjectContext): string {
-  let outputDir = context.config?.project?.[kProjectOutputDir];
-
-  if (outputDir) {
-    if (!isAbsolute(outputDir)) {
-      outputDir = join(context.dir, outputDir);
-    }
-  } else {
-    outputDir = context.dir;
-  }
-
-  // Normalize the path
-  return resolve(outputDir);
-}
+export type * from "./quarto-api.d.ts";

packages/quarto-types/src/external-engine.d.ts

@@ -2,10 +2,10 @@
  * Project context interfaces for Quarto engines
  */
 
-import { MappedString } from './text-types';
-import { kProjectOutputDir } from './constants';
-import { ExecutionEngine } from './execution-engine';
-import { ExternalEngine } from './external-engine';
+import type { MappedString } from "./text-types";
+import type { ExecutionEngineInstance, ExecutionTarget } from "./execution-engine";
+import type { ExternalEngine } from "./external-engine";
+import type { Metadata } from "./metadata-types";
 
 /**
  * Information about a file being processed
@@ -27,17 +27,17 @@ export interface FileInformation {
   /**
    * The launched execution engine for this file
    */
-  engine?: import('./execution-engine').LaunchedExecutionEngine;
+  engine?: ExecutionEngineInstance;
 
   /**
    * The execution target for this file
    */
-  target?: import('./execution-engine').ExecutionTarget;
+  target?: ExecutionTarget;
 
   /**
    * Document metadata
    */
-  metadata?: import('./metadata-types').Metadata;
+  metadata?: Metadata;
 }
 
 /**
@@ -62,7 +62,7 @@ export interface EngineProjectContext {
   config?: {
     engines?: (string | ExternalEngine)[];
     project?: {
-      [kProjectOutputDir]?: string;
+      outputDir?: string;
     };
   };
 
@@ -89,7 +89,7 @@ export interface EngineProjectContext {
    * @returns Promise resolving to mapped markdown string
    */
   resolveFullMarkdownForFile: (
-    engine: ExecutionEngine | undefined,
+    engine: ExecutionEngineInstance | undefined,
     file: string,
     markdown?: MappedString,
     force?: boolean,
@@ -98,5 +98,5 @@ export interface EngineProjectContext {
   /**
    * Reference to the global Quarto API
    */
-  quarto: import('./quarto-api').QuartoAPI;
-}
+  quarto: import("./quarto-api").QuartoAPI;
+}

packages/quarto-types/src/index.ts

@@ -20,7 +20,11 @@ import {
   kCodeToolsViewSource,
   kKeepSource,
 } from "../../config/constants.ts";
-import { ExecutionEngine, ExecutionTarget, LaunchedExecutionEngine } from "../../execute/types.ts";
+import {
+  ExecutionEngine,
+  ExecutionEngineInstance,
+  ExecutionTarget,
+} from "../../execute/types.ts";
 
 import { isHtmlOutput } from "../../config/format.ts";
 import { executionEngineCanKeepSource } from "../../execute/engine-info.ts";
@@ -47,7 +51,7 @@ export function formatHasCodeTools(format: Format) {
 
 export function resolveKeepSource(
   format: Format,
-  engine: LaunchedExecutionEngine,
+  engine: ExecutionEngineInstance,
   target: ExecutionTarget,
 ) {
   // keep source if requested (via keep-source or code-tools), we are targeting html,

packages/quarto-types/src/project-context.d.ts

@@ -59,7 +59,10 @@ import {
 } from "../../core/language.ts";
 import { defaultWriterFormat } from "../../format/formats.ts";
 import { mergeConfigs } from "../../core/config.ts";
-import { ExecutionTarget, LaunchedExecutionEngine } from "../../execute/types.ts";
+import {
+  ExecutionEngineInstance,
+  ExecutionTarget,
+} from "../../execute/types.ts";
 import {
   deleteProjectMetadata,
   directoryMetadataForInputFile,
@@ -394,7 +397,7 @@ function mergeQuartoConfigs(
 async function resolveFormats(
   file: RenderFile,
   target: ExecutionTarget,
-  engine: LaunchedExecutionEngine,
+  engine: ExecutionEngineInstance,
   options: RenderOptions,
   _notebookContext: NotebookContext,
   project: ProjectContext,

src/command/render/codetools.ts

@@ -14,8 +14,8 @@ import {
 } from "../../config/types.ts";
 import {
   ExecuteResult,
+  ExecutionEngineInstance,
   ExecutionTarget,
-  LaunchedExecutionEngine,
 } from "../../execute/types.ts";
 import { Metadata } from "../../config/types.ts";
 import { ProjectContext } from "../../project/types.ts";
@@ -56,7 +56,7 @@ export interface RenderServiceWithLifetime extends RenderServices {
 export interface RenderContext {
   target: ExecutionTarget;
   options: RenderOptions;
-  engine: LaunchedExecutionEngine;
+  engine: ExecutionEngineInstance;
   format: Format;
   libDir: string;
   project: ProjectContext;