Enhance testing utility, add CI gh action and format files (#13)

AmineAfia · web-flow · commit c25566efa7d8 · 2025-10-23T17:10:46.000+02:00
* Enhance testing utilities and options for PromptWithTests

- Introduced internal testing utilities in `testHelpers.ts` for mock executor configurations and running tests with mock executors.
- Updated `PromptWithTests` to allow default empty executor configurations and added convenience handling for single executor parameters.
- Modified test cases to utilize the new testing utilities, improving flexibility in test execution.
- Updated related types to support new executor options in test configurations.

* Add CI workflow configuration for testing and linting

* Update package manager to pnpm@9.0.0 in package.json and CI workflow configuration

* Remove pnpm version specification from CI workflow configuration

* Refactor code for improved type safety and clarity

- Updated `basic-usage.ts` to access `systemPrompt` directly instead of using bracket notation.
- Enhanced type definitions in `VercelAIExecutor.ts` for better clarity on tool descriptions.
- Improved type handling in `zodToJsonSchema.ts` by specifying more precise types for schema definitions and results.
- Adjusted `analytics.test.ts` to use more explicit types for instance management and circular reference handling.

* Reformated multiple files

- Reformatted `package.json` files for improved readability and consistency in indentation.
- Updated example files to ensure consistent formatting and removed unnecessary newlines.
- Enhanced code clarity in `basic-usage.ts`, `tool-integration.ts`, and other example files by standardizing console log statements.
- Cleaned up trailing whitespace in various files to maintain code quality.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,55 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - '**'
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Test & Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run linting
+        run: pnpm run lint
+
+      - name: Check formatting
+        run: pnpm run format:check
+
+      - name: Build packages
+        run: pnpm run build
+
+      - name: Run tests
+        run: pnpm run test
+
diff --git a/examples/basic-usage.ts b/examples/basic-usage.ts
@@ -7,7 +7,7 @@ const p = prompt("You are a helpful customer service agent")
 
 // Compile for different providers
 console.log("=== Generic Format ===");
-console.log(p["systemPrompt"]);
+console.log(p.systemPrompt);
 
 console.log("\n=== OpenAI Format ===");
 const openaiResult = p.toOpenAI();
@@ -26,4 +26,4 @@ const conversationMessages = [
 
 const messagesWithSystem = p.toVercelAI(conversationMessages);
 console.log("\n=== Prepared Messages ===");
-console.log(JSON.stringify(messagesWithSystem, null, 2));
+console.log(JSON.stringify(messagesWithSystem, null, 2));
diff --git a/examples/eval-example.prompt.ts b/examples/eval-example.prompt.ts
@@ -103,4 +103,3 @@ export const emailWriter = prompt(
       },
     ],
   });
-
diff --git a/examples/tool-integration.ts b/examples/tool-integration.ts
@@ -70,4 +70,4 @@ console.log('  model: "gpt-4",');
 console.log("  messages: openaiResult.messages,");
 console.log("  tools: openaiResult.tools,");
 console.log('  tool_choice: "auto"');
-console.log("});");
+console.log("});");
diff --git a/examples/vercel-integration.ts b/examples/vercel-integration.ts
@@ -90,4 +90,4 @@ export async function POSTAnthropic(req: Request) {
     console.error("Chat API error:", error);
     return new Response("Internal Server Error", { status: 500 });
   }
-}
+}
diff --git a/package.json b/package.json
@@ -1,28 +1,28 @@
 {
-    "name": "marrakesh",
-    "private": true,
-    "version": "0.1.0-alpha.2",
-    "description": "A structured, testable, and data-driven context engineering SDK",
-    "license": "Apache-2.0",
-    "scripts": {
-        "build": "turbo build",
-        "dev": "turbo dev",
-        "test": "turbo test",
-        "lint": "biome lint .",
-        "format": "biome format --write .",
-        "format:check": "biome format .",
-        "clean": "turbo clean"
-    },
-    "devDependencies": {
-        "turbo": "^2.0.0",
-        "typescript": "^5.0.0",
-        "tsup": "^8.0.0",
-        "vitest": "^1.0.0",
-        "@types/node": "^20.0.0",
-        "@biomejs/biome": "^1.8.0"
-    },
-    "packageManager": "pnpm@8.0.0",
-    "engines": {
-        "node": ">=18.0.0"
-    }
-}
+  "name": "marrakesh",
+  "private": true,
+  "version": "0.1.0-alpha.2",
+  "description": "A structured, testable, and data-driven context engineering SDK",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "turbo build",
+    "dev": "turbo dev",
+    "test": "turbo test",
+    "lint": "biome lint .",
+    "format": "biome format --write .",
+    "format:check": "biome format .",
+    "clean": "turbo clean"
+  },
+  "devDependencies": {
+    "turbo": "^2.0.0",
+    "typescript": "^5.0.0",
+    "tsup": "^8.0.0",
+    "vitest": "^1.0.0",
+    "@types/node": "^20.0.0",
+    "@biomejs/biome": "^1.8.0"
+  },
+  "packageManager": "pnpm@9.0.0",
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,8 +1,8 @@
 {
-"name": "@marrakesh/cli",
-"version": "0.1.0-alpha.2",
-"description": "CLI for testing Marrakesh prompts",
-"license": "Apache-2.0",
+  "name": "@marrakesh/cli",
+  "version": "0.1.0-alpha.2",
+  "description": "CLI for testing Marrakesh prompts",
+  "license": "Apache-2.0",
   "type": "module",
   "bin": {
     "marrakesh": "./dist/index.js"
@@ -15,10 +15,7 @@
       "import": "./dist/index.js"
     }
   },
-  "files": [
-    "dist",
-    "README.md"
-  ],
+  "files": ["dist", "README.md"],
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
@@ -41,4 +38,3 @@
     "@types/node": "^20.0.0"
   }
 }
-
diff --git a/packages/cli/src/commands/test.ts b/packages/cli/src/commands/test.ts
@@ -90,4 +90,3 @@ export const testCommand = new Command("test")
       process.exit(1);
     }
   });
-
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -33,4 +33,3 @@ program
 program.addCommand(testCommand);
 
 program.parse();
-
diff --git a/packages/cli/src/output/Reporter.ts b/packages/cli/src/output/Reporter.ts
@@ -308,4 +308,3 @@ export class Reporter {
     console.log(); // blank line
   }
 }
-
diff --git a/packages/cli/src/output/formatters.ts b/packages/cli/src/output/formatters.ts
@@ -58,4 +58,3 @@ export function formatError(error: Error): string {
 
   return output;
 }
-
diff --git a/packages/cli/src/runner/TestRunner.ts b/packages/cli/src/runner/TestRunner.ts
@@ -194,4 +194,3 @@ export class TestRunner {
     return finalResults;
   }
 }
-
diff --git a/packages/cli/src/watch/Watcher.ts b/packages/cli/src/watch/Watcher.ts
@@ -23,9 +23,7 @@ export class Watcher {
   /**
    * Start watching files and running tests
    */
-  async start(
-    onResults: (results: RunnerResults) => void,
-  ): Promise<void> {
+  async start(onResults: (results: RunnerResults) => void): Promise<void> {
     // Initial run
     await this.runTests(onResults);
 
@@ -52,7 +50,9 @@ export class Watcher {
     // Handle keyboard input
     this.setupKeyboardHandlers(onResults);
 
-    console.log("\n👁️  Watching for changes... (Press Ctrl+C to exit, 'a' to run all tests)\n");
+    console.log(
+      "\n👁️  Watching for changes... (Press Ctrl+C to exit, 'a' to run all tests)\n",
+    );
 
     // Keep process alive
     return new Promise(() => {
@@ -133,4 +133,3 @@ export class Watcher {
     }
   }
 }
-
diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json
@@ -7,4 +7,3 @@
   "include": ["src/**/*"],
   "exclude": ["node_modules", "dist"]
 }
-
diff --git a/packages/cli/tsup.config.ts b/packages/cli/tsup.config.ts
@@ -11,4 +11,3 @@ export default defineConfig({
     js: "#!/usr/bin/env node",
   },
 });
-
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,8 +1,8 @@
 {
-"name": "@marrakesh/core",
-"version": "0.1.0-alpha.2",
-"description": "Minimal, type-safe tool integration for LLMs",
-"license": "Apache-2.0",
+  "name": "@marrakesh/core",
+  "version": "0.1.0-alpha.2",
+  "description": "Minimal, type-safe tool integration for LLMs",
+  "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -11,17 +11,17 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-    "require": "./dist/index.cjs"
+      "require": "./dist/index.cjs"
     }
   },
   "files": ["dist", "README.md"],
   "peerDependencies": {
     "zod": "^3.0.0",
     "ai": "^3.0.0 || ^4.0.0 || ^5.0.0"
-},
-"peerDependenciesMeta": {
+  },
+  "peerDependenciesMeta": {
     "ai": {
-        "optional": true
+      "optional": true
     }
   },
   "sideEffects": false,
diff --git a/packages/core/src/PromptBuilder.ts b/packages/core/src/PromptBuilder.ts
@@ -502,4 +502,4 @@ ${JSON.stringify(jsonSchema, null, 2)}
  */
 export function prompt(systemPrompt?: string): PromptBuilder {
   return new PromptBuilder(systemPrompt);
-}
+}
diff --git a/packages/core/src/analytics/index.ts b/packages/core/src/analytics/index.ts
@@ -2,13 +2,13 @@
  * Analytics module exports
  */
 
-export { AnalyticsClient } from './AnalyticsClient.js';
-export type { 
-  ToolCall, 
-  PromptMetadata, 
-  PromptExecution, 
-  IngestionRequest 
-} from './types.js';
+export { AnalyticsClient } from "./AnalyticsClient.js";
+export type {
+  ToolCall,
+  PromptMetadata,
+  PromptExecution,
+  IngestionRequest,
+} from "./types.js";
 export {
   generatePromptId,
   generateExecutionId,
diff --git a/packages/core/src/compilers/AnthropicCompiler.ts b/packages/core/src/compilers/AnthropicCompiler.ts
@@ -35,4 +35,4 @@ ${JSON.stringify(jsonSchema, null, 2)}
     system: systemPrompt,
     tools: tools.length > 0 ? tools : undefined,
   };
-}
+}
diff --git a/packages/core/src/compilers/GenericCompiler.ts b/packages/core/src/compilers/GenericCompiler.ts
@@ -40,4 +40,4 @@ export function toGeneric(promptBuilder: PromptBuilder): string {
   }
 
   return parts.join("\n");
-}
+}
diff --git a/packages/core/src/compilers/OpenAICompiler.ts b/packages/core/src/compilers/OpenAICompiler.ts
@@ -54,4 +54,4 @@ export function toOpenAI(
     tools: tools.length > 0 ? tools : undefined,
     response_format,
   };
-}
+}
diff --git a/packages/core/src/executors/VercelAIExecutor.ts b/packages/core/src/executors/VercelAIExecutor.ts
@@ -50,7 +50,9 @@ export function createVercelAIExecutor(config: ExecutorConfig): Executor {
 
       // Get the tool descriptions from the tools object
       const toolDescriptions = tools
-        ? Object.values(tools).map((t: any) => t.description)
+        ? Object.values(tools).map(
+            (t: { description: string }) => t.description,
+          )
         : [];
 
       // Execute with tool calling loop using Promise.race for timeout
@@ -187,4 +189,3 @@ export function createVercelAIExecutor(config: ExecutorConfig): Executor {
     }
   };
 }
-
diff --git a/packages/core/src/executors/index.ts b/packages/core/src/executors/index.ts
@@ -12,4 +12,3 @@ export type {
 
 // Convenience export for the most common case
 export { createVercelAIExecutor as createExecutor } from "./VercelAIExecutor.js";
-
diff --git a/packages/core/src/executors/types.ts b/packages/core/src/executors/types.ts
@@ -66,4 +66,3 @@ export type Executor = (
   prompt: PromptBuilder,
   input: string,
 ) => Promise<ExecutionResult>;
-
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -39,6 +39,13 @@ export type {
   ExecutorMetadata,
 } from "./testing/types.js";
 
+// Internal testing utilities - NOT part of public API
+// Only use these in internal unit tests, not in production code
+export {
+  runWithMockExecutor,
+  createMockExecutorConfig,
+} from "./testing/testHelpers.js";
+
 // Executor utilities
 export {
   createVercelAIExecutor,
@@ -73,4 +80,4 @@ export type {
   ReasoningPart,
   JSONValue,
   LanguageModelV3ToolResultOutput,
-} from "./types.js";
+} from "./types.js";
diff --git a/packages/core/src/schema/zodToJsonSchema.ts b/packages/core/src/schema/zodToJsonSchema.ts
diff --git a/packages/core/src/testing/PromptWithTests.ts b/packages/core/src/testing/PromptWithTests.ts
diff --git a/packages/core/src/testing/matchers.ts b/packages/core/src/testing/matchers.ts
diff --git a/packages/core/src/testing/testHelpers.ts b/packages/core/src/testing/testHelpers.ts
diff --git a/packages/core/src/testing/types.ts b/packages/core/src/testing/types.ts
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
diff --git a/packages/core/src/utils/messageUtils.ts b/packages/core/src/utils/messageUtils.ts
diff --git a/packages/core/tests/PromptBuilder.test.ts b/packages/core/tests/PromptBuilder.test.ts
diff --git a/packages/core/tests/analytics.test.ts b/packages/core/tests/analytics.test.ts
diff --git a/packages/core/tests/messageUtils.test.ts b/packages/core/tests/messageUtils.test.ts
diff --git a/packages/core/tests/testing.test.ts b/packages/core/tests/testing.test.ts

-Original file line number
+Diff line change
       },
     ],
   });
+-
Original file line number	Diff line number	Diff line change
`@@ -90,4 +90,4 @@ export async function POSTAnthropic(req: Request) {`
`90`	`90`	`console.error("Chat API error:", error);`
`91`	`91`	`return new Response("Internal Server Error", { status: 500 });`
`92`	`92`	`}`
`93`		`-}`
	`93`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -90,4 +90,3 @@ export const testCommand = new Command("test")`
`90`	`90`	`process.exit(1);`
`91`	`91`	`}`
`92`	`92`	`});`
`93`		`-`
Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,3 @@ program`
`33`	`33`	`program.addCommand(testCommand);`
`34`	`34`
`35`	`35`	`program.parse();`
`36`		`-`
Original file line number	Diff line number	Diff line change
`@@ -308,4 +308,3 @@ export class Reporter {`
`308`	`308`	`console.log(); // blank line`
`309`	`309`	`}`
`310`	`310`	`}`
`311`		`-`