@functional-examples/test 0.0.0-alpha.1

package/dist/schema.js

@@ -0,0 +1,115 @@
+import { z } from 'zod';
+/**
+ * Assertions for stdout/stderr output
+ */
+const stdioAssertionsSchema = z
+    .strictObject({
+    contains: z.string().optional(),
+    matches: z.string().optional(),
+})
+    .optional();
+/**
+ * Single file assertion — existence and optional content checks
+ */
+const fileAssertionSchema = z.strictObject({
+    path: z.string(),
+    contains: z.string().optional(),
+    matches: z.string().optional(),
+});
+const fileAssertionsSchema = fileAssertionSchema.optional();
+/**
+ * Single directory assertion — existence check
+ */
+const dirAssertionSchema = z.strictObject({
+    path: z.string(),
+});
+const dirAssertionsSchema = dirAssertionSchema.optional();
+/**
+ * Test assertions
+ *
+ * Uses z.lazy() for the `not` field to allow recursive self-reference
+ * (e.g. `not: { file: { path: 'foo' } }` negates inner assertions).
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const assertionsSchema = z
+    .strictObject({
+    exitCode: z.number().int().optional(),
+    stdout: stdioAssertionsSchema,
+    stderr: stdioAssertionsSchema,
+    file: fileAssertionsSchema,
+    files: z.array(fileAssertionSchema).optional(),
+    dir: dirAssertionsSchema,
+    directories: z.array(dirAssertionSchema).optional(),
+    not: z.lazy(() => assertionsSchema).optional(),
+})
+    .optional();
+/**
+ * Shared execution defaults (cwd, env, timeout) — no command
+ */
+const testDefaultsSchema = z.strictObject({
+    /** Working directory relative to example */
+    cwd: z.string().optional(),
+    /** Environment variables */
+    env: z.record(z.string(), z.string()).optional(),
+    /** Timeout in milliseconds */
+    timeout: z.number().int().positive().optional(),
+});
+/**
+ * Test execution options (single-command format)
+ */
+const testOptionsSchema = testDefaultsSchema.extend({
+    /** Command to execute */
+    command: z.string(),
+});
+/**
+ * A command step in a multi-step sequence
+ */
+export const commandStepSchema = z.strictObject({
+    /** Command to execute */
+    command: z.string(),
+    /** Working directory relative to example */
+    cwd: z.string().optional(),
+    /** Environment variables */
+    env: z.record(z.string(), z.string()).optional(),
+    /** Timeout in milliseconds */
+    timeout: z.number().int().positive().optional(),
+    /** Assertions for this step (defaults to exitCode === 0 if omitted) */
+    assertions: assertionsSchema,
+});
+/**
+ * Step union — currently only command steps, extensible later
+ */
+const testStepSchema = commandStepSchema;
+/**
+ * Single test case — supports either options+assertions or steps format
+ */
+const optionsTestCaseSchema = z.strictObject({
+    /** Test name */
+    name: z.string(),
+    options: testOptionsSchema,
+    assertions: assertionsSchema,
+});
+const stepsTestCaseSchema = z.strictObject({
+    /** Test name */
+    name: z.string(),
+    /** Default cwd, env, timeout inherited by all steps */
+    options: testDefaultsSchema.optional(),
+    steps: z.array(testStepSchema).min(1),
+});
+export const testCaseSchema = z.union([
+    optionsTestCaseSchema,
+    stepsTestCaseSchema,
+]);
+/**
+ * Test field can be single test or array
+ */
+const testFieldSchema = z.union([testCaseSchema, z.array(testCaseSchema)]);
+/**
+ * Metadata extension for test plugin
+ */
+export const testMetadataSchema = z.object({
+    test: testFieldSchema.optional(),
+});
+// JSON Schema for plugin registration
+export const TEST_METADATA_JSON_SCHEMA = z.toJSONSchema(testMetadataSchema);
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAAC;KAC5B,YAAY,CAAC;IACZ,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd;;GAEG;AACH,MAAM,mBAAmB,GAAG,CAAC,CAAC,YAAY,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,QAAQ,EAAE,CAAC;AAE5D;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC;AAE1D;;;;;GAKG;AACH,8DAA8D;AAC9D,MAAM,gBAAgB,GAAuB,CAAC;KAC3C,YAAY,CAAC;IACZ,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,qBAAqB;IAC7B,MAAM,EAAE,qBAAqB;IAC7B,IAAI,EAAE,oBAAoB;IAC1B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;IAC9C,GAAG,EAAE,mBAAmB;IACxB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IACnD,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;CAC/C,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IACxC,4CAA4C;IAC5C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,4BAA4B;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,8BAA8B;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,MAAM,CAAC;IAClD,yBAAyB;IACzB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC9C,yBAAyB;IACzB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,4CAA4C;IAC5C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,4BAA4B;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,8BAA8B;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC/C,uEAAuE;IACvE,UAAU,EAAE,gBAAgB;CAC7B,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,cAAc,GAAG,iBAAiB,CAAC;AAEzC;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,gBAAgB;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,iBAAiB;IAC1B,UAAU,EAAE,gBAAgB;CAC7B,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,CAAC,CAAC,YAAY,CAAC;IACzC,gBAAgB;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,uDAAuD;IACvD,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACtC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC;IACpC,qBAAqB;IACrB,mBAAmB;CACpB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAeH,sCAAsC;AACtC,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC"}

package/dist/schema.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -0,0 +1,37 @@
+import type { ReporterConfig, ReporterFactory } from './reporters/types.js';
+/**
+ * Options for the test plugin
+ */
+export interface TestPluginOptions {
+    /**
+     * Default timeout for tests in ms
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Custom reporters keyed by name.
+     * Can be a factory function or module path string.
+     * Built-in: 'pretty', 'tap'
+     */
+    reporters?: Record<string, ReporterConfig>;
+    /**
+     * Default reporter when not in CI
+     * @default 'pretty'
+     */
+    defaultReporter?: string;
+    /**
+     * Default reporter when in CI
+     * @default 'tap'
+     */
+    ciReporter?: string;
+}
+/**
+ * Resolved options with reporter factories
+ */
+export interface ResolvedTestPluginOptions {
+    timeout: number;
+    reporters: Record<string, ReporterFactory>;
+    defaultReporter: string;
+    ciReporter: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5E;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAE3C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC3C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@functional-examples/test",
+  "version": "0.0.0-alpha.1",
+  "type": "module",
+  "description": "Test runner plugin for functional-examples",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "functional-examples": "0.0.0-alpha.1"
+  },
+  "dependencies": {
+    "zod": "4.3.6",
+    "cli-forge": "1.2.0",
+    "@functional-examples/devkit": "0.0.0-alpha.1"
+  },
+  "devDependencies": {
+    "@types/node": "22.19.8",
+    "typescript": "^5.7.2",
+    "vitest": "^1.3.1",
+    "@functional-examples/devkit": "0.0.0-alpha.1",
+    "functional-examples": "0.0.0-alpha.1"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Craigory Coppola",
+    "url": "https://craigory.dev"
+  },
+  "homepage": "https://craigory.dev/functional-examples",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AgentEnder/functional-examples.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AgentEnder/functional-examples/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.lib.json",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}