describe-me 0.1.0

package/src/tree.ts

@@ -0,0 +1,27 @@
+import type { ManifestModule, ManifestTest } from '@describe-me/core/types'
+
+export interface SuiteNode {
+  name: string
+  suites: Map<string, SuiteNode>
+  tests: ManifestTest[]
+}
+
+/** Nest a module's flat test list back into its `describe` hierarchy. */
+export function buildTree(mod: ManifestModule): SuiteNode {
+  const root: SuiteNode = { name: '', suites: new Map(), tests: [] }
+  for (const test of mod.tests) {
+    let node = root
+    for (const part of test.path) {
+      let next = node.suites.get(part)
+      if (!next) {
+        node.suites.set(part, (next = { name: part, suites: new Map(), tests: [] }))
+      }
+
+      node = next
+    }
+
+    node.tests.push(test)
+  }
+
+  return root
+}

package/src/value-cell.ts

@@ -0,0 +1,22 @@
+import { el } from './el.js'
+
+/** Render one serialized prop value, coloured by its type. */
+export function valueCell(value: unknown): HTMLElement {
+  if (typeof value === 'string') {
+    if (value.startsWith('ƒ ')) {
+      return el('span', { class: 'val-fn' }, value)
+    }
+
+    return el('span', { class: 'val-string' }, JSON.stringify(value))
+  }
+
+  if (typeof value === 'number' || typeof value === 'boolean') {
+    return el('span', { class: `val-${typeof value}` }, String(value))
+  }
+
+  if (value === null || value === undefined) {
+    return el('span', { class: 'val-fn' }, String(value))
+  }
+
+  return el('span', {}, JSON.stringify(value))
+}

package/vite.config.ts

@@ -0,0 +1,85 @@
+import { cpSync, existsSync, readFileSync, statSync, watch } from 'node:fs'
+import { dirname, join, resolve, sep } from 'node:path'
+import { defineConfig, type Plugin } from 'vite'
+
+/** Where the manifest and snapshots live. The CLI sets this; the default is the example project. */
+function dataDir(): string {
+  return resolve(process.env.DESCRIBE_ME_DIR ?? '../../examples/react-basic/.describe-me')
+}
+
+/**
+ * Dev: serves the data directory under `/__data` and pushes an HMR event when
+ * the manifest changes. Build: copies the data directory into the output, so
+ * the result is a self-contained static site.
+ */
+function describeMeData(): Plugin {
+  const dir = dataDir()
+  let outDir = 'dist'
+
+  return {
+    name: 'describe-me:data',
+
+    configResolved(config) {
+      outDir = resolve(config.root, config.build.outDir)
+    },
+
+    configureServer(server) {
+      server.config.logger.info(`describe-me: serving data from ${dir}`)
+
+      let timer: NodeJS.Timeout | undefined
+
+      const notify = () => {
+        clearTimeout(timer)
+        timer = setTimeout(
+          () => server.ws.send({ type: 'custom', event: 'describe-me:update' }),
+          150,
+        )
+      }
+
+      const watchTarget = existsSync(dir) ? dir : dirname(dir)
+
+      try {
+        watch(watchTarget, { recursive: true }, (_event, file) => {
+          if (!file || String(file).endsWith('manifest.json')) {
+            notify()
+          }
+        })
+      } catch (error) {
+        server.config.logger.warn(`describe-me: cannot watch ${watchTarget}: ${String(error)}`)
+      }
+
+      server.middlewares.use('/__data', (request, response, next) => {
+        const relative = decodeURIComponent((request.url ?? '/').split('?')[0])
+        const absolute = join(dir, relative)
+
+        if (
+          !absolute.startsWith(dir + sep) ||
+          !existsSync(absolute) ||
+          !statSync(absolute).isFile()
+        ) {
+          return next()
+        }
+
+        response.setHeader('Content-Type', 'application/json')
+        response.setHeader('Cache-Control', 'no-store')
+        response.end(readFileSync(absolute))
+      })
+    },
+
+    closeBundle() {
+      if (!existsSync(dir)) {
+        this.warn(`describe-me: no data at ${dir}; run vitest first`)
+        return
+      }
+
+      cpSync(dir, join(outDir, '__data'), { recursive: true })
+    },
+  }
+}
+
+export default defineConfig({
+  // Relative asset URLs, so the site works from any sub-path (GitHub Pages, S3 prefixes).
+  base: './',
+  plugins: [describeMeData()],
+  server: { port: 6006, strictPort: false, open: false },
+})