@playfast/reform-proof-vitest 1.0.1 → 1.0.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@playfast/reform-proof-vitest",
   "playbook": "./playbook",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "type": "module",
   "description": "Vitest adapter for reform-proof — a vite plugin that auto-registers every *.proof.ts suite as native vitest tests, run through the proof engine.",
   "keywords": [

package/src/index.ts

@@ -1,30 +1,12 @@
 import { isProofSuite, type ProofSuite, withProofRunner } from '@playfast/reform-proof'
 import { describe, expect, test } from 'vitest'
 
-// reform-proof vitest adapter — turns a reform proof `ProofSuite` into native
-// vitest tests (a `describe` per product, a `test` per requirement), each run
-// through the proof engine via the `ProofRunner` layer. Pair it with
-// `reformProofPlugin` (./plugin), which appends a `registerSuites(...)` call to
-// every `*.proof.ts` so suites become tests with no per-feature wrapper file.
-
-// A suite registers exactly once even if several modules import it (its own test
-// entry plus any flow test that pulls it in). Identity-keyed, so a suite value is
-// never double-registered within a worker.
+// Identity-keyed: a suite registers once even if several modules import it.
 const registered = new WeakSet<ProofSuite>()
 
-// Per-proof-test setup hooks. An app registers one (via a module the plugin's
-// `setup` option imports into each `*.proof.ts`) to run app-specific preparation
-// right before each proof renders — e.g. installing a render-free React-hooks
-// dispatcher for view bodies that reach for hooks. The adapter stays view-agnostic:
-// it just runs whatever the app registered, only inside proof-test bodies, so a
-// `*.test.ts` that controls global state is never disturbed.
+// App setup hooks (via plugin `setup`) run only inside proof-test bodies.
 const setupHooks = new Set<() => void>()
 
-/**
- * Register a function to run immediately before every proof test. Idempotent by
- * reference; intended to be called from a side-effect module the plugin imports
- * into `*.proof.ts` files only.
- */
 export const setProofTestHook = (hook: () => void): void => {
   setupHooks.add(hook)
 }
@@ -46,11 +28,6 @@ const registerSuite = (suite: ProofSuite): void => {
   })
 }
 
-/**
- * Register every `ProofSuite` among the given values as vitest tests. Non-suite
- * values are ignored, so a whole module's exports can be passed verbatim — which
- * is exactly what `reformProofPlugin` does.
- */
 export const registerSuites = (candidates: ReadonlyArray<unknown>): void => {
   candidates.forEach((candidate) => {
     if (!isProofSuite(candidate) || registered.has(candidate)) {

package/src/plugin.ts

@@ -1,28 +1,11 @@
 import { init, parse } from 'es-module-lexer'
 
-// reform-proof vitest plugin — a vite/vitest plugin that auto-registers proof
-// suites. For every `*.proof.ts` file vitest collects, it lexes the module's
-// export names and appends a `registerSuites([...exports])` call, so each exported
-// `ProofSuite` becomes native vitest tests. This is what lets a feature ship a
-// `*.proof.ts` with NO hand-written `*.proof.test.ts` wrapper: add this plugin and
-// the glob `**/*.proof.ts` to the vitest config, and the suites run themselves.
-
 const PROOF_RE = /\.proof\.ts$/
 
-/** Options for `reformProofPlugin`. ExternalApi: vite-plugin config boundary. */
 export interface ReformProofPluginOptionsExternalApi {
-  /**
-   * Module specifier(s) the plugin side-effect-imports into every `*.proof.ts`,
-   * before registering its suites. Use to register per-proof-test setup
-   * (`setProofTestHook`) that must run ONLY in proof-test workers — e.g. an app's
-   * headless React-hooks dispatcher. Imported only into `*.proof.ts`, so regular
-   * `*.test.ts` files are never affected.
-   */
   readonly setup?: string | ReadonlyArray<string>
 }
 
-/** The minimal vite plugin shape this adapter needs — structurally a `Plugin`,
- *  declared locally so the package need not depend on vite's types. */
 export interface ReformProofPluginExternalApi {
   readonly name: string
   readonly enforce: 'post'
@@ -39,10 +22,6 @@ const setupList = (
 ): ReadonlyArray<string> =>
   setup === undefined ? [] : typeof setup === 'string' ? [setup] : setup
 
-/**
- * The plugin. Runs `post` (after TS→JS), so it lexes plain JS exports reliably.
- * Only `*.proof.ts` modules are touched; everything else passes through.
- */
 export const reformProofPlugin = (
   options?: ReformProofPluginOptionsExternalApi,
 ): ReformProofPluginExternalApi => {
@@ -58,8 +37,7 @@ export const reformProofPlugin = (
       }
       await init
       const [, exports] = parse(code)
-      // Reference each export's LOCAL binding (in scope after the module body); a
-      // re-export-from has no local name (`ln` undefined) and is skipped.
+      // Use local binding names; re-export-from has no `ln` and is skipped.
       const names = exports
         .map((exportSpec) => exportSpec.ln)
         .filter((local): local is string => typeof local === 'string' && local.length > 0)