poveste 0.16.2 → 0.17.1

package/README.md

@@ -47,7 +47,7 @@ Run `npx poveste --help` for the full list of options.
 
 ## Requirements
 
-Node `>=22.22.2` and Vite `^8.0.0`. See
+Node `>=24.15.0` and Vite `^8.0.0`. See
 [supported versions](https://poveste.dev/guide/getting-started#supported-versions) for
 what proves each range.
 

package/bin.mjs

@@ -2,6 +2,7 @@
 'use strict'
 
 import process from 'node:process'
+import { supportedFrameworks } from './framework-floor.mjs'
 import { supportedNode } from './node-floor.mjs'
 
 // Before the CLI is imported, not inside it: on a Node below the floor the import
@@ -12,7 +13,11 @@ import { supportedNode } from './node-floor.mjs'
 // Imported dynamically for the same reason. A static import is parsed with this
 // module, before a line of it runs, so syntax `dist/` may carry would win the race
 // against the message explaining it.
-if (supportedNode()) {
+// The framework floor goes here for the same reason: on a framework below a
+// plugin's peer, importing the CLI fails first and names neither (#1062). Not for
+// `--help` or `--version`, which load no command and so cannot reach that failure.
+const informational = process.argv.slice(2).some(arg => ['--help', '-h', '--version', '-v'].includes(arg))
+if (supportedNode() && (informational || supportedFrameworks())) {
   import('./dist/node/bin.js').catch((error) => {
     // `exitCode`, not `exit`: the error is the last thing written, and forcing the
     // process out on the same tick truncates it on a pipe.

package/dist/node/builtin-plugins/vanilla-support/client.d.ts

@@ -1,3 +1,3 @@
 export { default as MountStory } from './MountStory';
 export { default as RenderStory } from './RenderStory';
-export declare function generateSourceCode(): void;
+export declare function generateSourceCode(): undefined;

package/dist/node/builtin-plugins/vanilla-support/contract.d.ts

@@ -0,0 +1,6 @@
+import type { ClientSupportPlugin } from '@poveste/shared';
+import type { Component } from '@poveste/vendors/vue';
+import type * as client from './client';
+type Satisfies<T extends ClientSupportPlugin<Component>> = T;
+export type ClientContract = Satisfies<typeof client>;
+export {};

package/dist/node/builtin-plugins/vanilla-support/contract.js

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

package/dist/node/collect/error.d.ts

@@ -1,2 +1,9 @@
-export declare function serializeError(error: unknown, seen?: WeakSet<Error>): unknown;
+/** What this module needs of a thrown value to be able to describe it. */
+interface ErrorLike {
+    name: string;
+    message: string;
+    stack?: string | undefined;
+}
+export declare function serializeError(error: unknown, seen?: WeakSet<ErrorLike>): unknown;
 export declare function deserializeError(value: unknown): unknown;
+export {};

package/dist/node/collect/error.js

@@ -7,6 +7,27 @@ const MARK = 'pvt:error';
 function isSerialized(value) {
     return typeof value === 'object' && value !== null && value.kind === MARK;
 }
+/*
+ * Not `instanceof Error`, and not `Error.isError` either. A `DOMException` from
+ * jsdom fails both — the first because `runScripts: 'dangerously'` makes jsdom a
+ * separate realm, the second because jsdom's is a webidl2js object rather than a
+ * genuine error — while carrying a name, a message and a stack. It is what a
+ * story's own DOM call throws, and a clone of one retains nothing, so the host
+ * received `{}` (#1097).
+ *
+ * A `stack` is required and not merely read: `{ name, message }` is a shape a
+ * story may legitimately throw, and it should arrive as the data it is.
+ */
+function errorLike(value) {
+    if (Error.isError(value)) {
+        return true;
+    }
+    if (typeof value !== 'object' || value === null) {
+        return false;
+    }
+    const { name, message, stack } = value;
+    return typeof name === 'string' && typeof message === 'string' && typeof stack === 'string';
+}
 // A property the clone rejects takes the whole message down with it, which is worse
 // than dropping the property.
 function cloneable(value) {
@@ -25,7 +46,7 @@ function cloneable(value) {
  * the error it was called to describe and replace it with its own.
  */
 export function serializeError(error, seen = new WeakSet()) {
-    if (!(error instanceof Error)) {
+    if (!errorLike(error)) {
         return cloneable(error) ? error : String(error);
     }
     if (seen.has(error)) {

package/dist/node/collect/index.js

@@ -1,5 +1,4 @@
 import { cpus } from 'node:os';
-import { escapeRegExp } from '@poveste/shared';
 import path, { relative } from 'pathe';
 import pc from 'picocolors';
 import { TEMP_PATH } from '../alias.js';
@@ -25,7 +24,7 @@ export function useCollectStories(options, ctx) {
             // @TODO temporary fix for https://github.com/histoire-dev/histoire/issues/409
             /vite\w*\/dist\/client\/(client|env).mjs/,
             ...ctx.config.viteNodeInlineDeps ?? [],
-            new RegExp(escapeRegExp(path.resolve(TEMP_PATH, 'plugins'))),
+            new RegExp(RegExp.escape(path.resolve(TEMP_PATH, 'plugins'))),
         ],
         transformMode: ctx.config.viteNodeTransformMode,
     });

package/dist/node/dom/env.js

@@ -23,7 +23,10 @@ function createVirtualConsole() {
         if (type === JSDOM_ERROR_CSS_PARSING)
             return;
         if (type === JSDOM_ERROR_UNHANDLED_EXCEPTION) {
-            globalThis.console.error((err.cause instanceof Error ? err.cause.stack : undefined) ?? err.message);
+            // `Error.isError` and not `instanceof`: the cause was constructed inside
+            // jsdom's realm, where `instanceof Error` is false and the stack — the
+            // only part that says which line threw — is discarded (#1093).
+            globalThis.console.error((Error.isError(err.cause) ? err.cause.stack : undefined) ?? err.message);
         }
         else {
             globalThis.console.error(err.message);

package/dist/node/vite.js

@@ -1,6 +1,5 @@
 import { existsSync } from 'node:fs';
 import { createRequire } from 'node:module';
-import { escapeRegExp } from '@poveste/shared';
 import { lookup as lookupMime } from 'mrmime';
 import { dirname, join, relative } from 'pathe';
 import { loadConfigFromFile as loadViteConfigFromFile, mergeConfig as mergeViteConfig, searchForWorkspaceRoot, } from 'vite';
@@ -347,7 +346,7 @@ export async function getViteConfigWithPlugins(isServer, ctx) {
             if (/\.(?:vue|js)(?:$|\?)/.test(id)) {
                 const original = code;
                 for (const [flag, value] of Object.entries(flags)) {
-                    code = code.replace(new RegExp(escapeRegExp(flag), 'g'), value);
+                    code = code.replace(new RegExp(RegExp.escape(flag), 'g'), value);
                 }
                 if (original !== code)
                     return code;
@@ -407,11 +406,11 @@ export async function getViteConfigWithPlugins(isServer, ctx) {
                                 ['vue', 'vue'],
                             ].reduce((acc, [name, entry]) => {
                                 acc.push({
-                                    find: new RegExp(`^${escapeRegExp(name)}$`),
+                                    find: new RegExp(`^${RegExp.escape(name)}$`),
                                     replacement: `@poveste/vendors/${entry}`,
                                 });
                                 acc.push({
-                                    find: new RegExp(`^${escapeRegExp(name)}/`),
+                                    find: new RegExp(`^${RegExp.escape(name)}/`),
                                     replacement: `@poveste/vendors/${entry}/`,
                                 });
                                 return acc;

package/framework-floor.mjs

@@ -0,0 +1,88 @@
+// The framework check the CLI makes before it loads anything, beside the Node one.
+//
+// A framework plugin declares its framework as a peer, and the package manager
+// enforces that well — until a reader takes `--legacy-peer-deps`, which npm's own
+// ERESOLVE output suggests. On Nuxt 3 what they meet next is `Cannot find package
+// 'vite'`: Nuxt 4 hoists the `vite@^8` Poveste imports and Nuxt 3 does not. That
+// failure comes from importing the CLI's commands, before the config — and so the
+// plugin — is loaded at all, which is why the plugin cannot check its own peer in
+// time and this file does (#1062).
+//
+// Nuxt only, until a second instance is reported. One measured case does not
+// justify holding six plugins' peers here; another is one line in `PEERS`.
+//
+// Plain ES2015 beside `node-floor.mjs`, for the reason that file gives.
+
+import { readFileSync, writeSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+import process from 'node:process'
+import { floorOf, isBelow } from './node-floor.mjs'
+
+/** Each plugin whose framework is checked, and the peer that names it. */
+export const PEERS = {
+  '@poveste/plugin-nuxt': 'nuxt',
+}
+
+/**
+ * The floor of a `^x.y.z` or `>=x.y.z` range, or `null` for any other shape.
+ *
+ * Only the floor: a version above a caret's major is the package manager's to
+ * refuse, and saying nothing about a shape this cannot read keeps our own
+ * manifest drift from becoming a reader's failed command.
+ */
+export function rangeFloor(range) {
+  return floorOf(String(range ?? '').trim().replace(/^\^/, '>='))
+}
+
+/**
+ * The manifest of `name` as Node would find it from `dir`, or `null`.
+ *
+ * Only a missing file sends the walk upward, as it does Node's. A manifest that
+ * is there and unreadable ends it: going on would read an ancestor's copy, which
+ * in a monorepo can be another package's framework at another version.
+ */
+export function installedManifest(name, dir) {
+  for (let current = dir; ; current = dirname(current)) {
+    try {
+      return JSON.parse(readFileSync(join(current, 'node_modules', name, 'package.json'), 'utf8'))
+    }
+    catch (error) {
+      if (error?.code !== 'ENOENT' || dirname(current) === current) {
+        return null
+      }
+    }
+  }
+}
+
+/** The Node message's shape, so the two read as one family. */
+export function unsupportedFrameworkMessage(framework, version, plugin, range) {
+  return `You are using ${framework} ${version}. ${plugin} requires ${framework} ${range}. Please upgrade ${framework}.`
+}
+
+/** A sentence per checked plugin whose installed framework is below its peer floor. */
+export function frameworkProblems(dir) {
+  const problems = []
+
+  for (const [plugin, framework] of Object.entries(PEERS)) {
+    const range = installedManifest(plugin, dir)?.peerDependencies?.[framework]
+    const floor = rangeFloor(range)
+    const version = installedManifest(framework, dir)?.version
+    if (floor && version && isBelow(version, floor)) {
+      problems.push(unsupportedFrameworkMessage(framework, version, plugin, range))
+    }
+  }
+
+  return problems
+}
+
+/** Whether the project's frameworks may run the CLI, saying so on stderr when not. */
+export function supportedFrameworks(dir = process.cwd()) {
+  const problems = frameworkProblems(dir)
+  if (problems.length === 0) {
+    return true
+  }
+
+  writeSync(2, `${problems.join('\n')}\n`)
+  process.exitCode = 1
+  return false
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "poveste",
   "type": "module",
-  "version": "0.16.2",
+  "version": "0.17.1",
   "description": "Interactive component playgrounds for Vue, Nuxt, Svelte, SvelteKit and Quasar — a drop-in fork of histoire, with Quasar support histoire does not ship.",
   "author": {
     "name": "Sorin Gitlan",
@@ -61,23 +61,24 @@
     "client.d.ts",
     "client.js",
     "dist",
+    "framework-floor.mjs",
     "index.d.ts",
     "node-floor.mjs",
     "plugin.d.ts",
     "plugin.js"
   ],
   "engines": {
-    "node": ">=22.22.2"
+    "node": ">=24.15.0"
   },
   "peerDependencies": {
     "vite": "^8.0.0"
   },
   "dependencies": {
     "@11ty/gray-matter": "^3.0.0",
-    "@poveste/app": "^0.16.2",
-    "@poveste/controls": "^0.16.2",
-    "@poveste/shared": "^0.16.2",
-    "@poveste/vendors": "^0.16.2",
+    "@poveste/app": "^0.17.1",
+    "@poveste/controls": "^0.17.1",
+    "@poveste/shared": "^0.17.1",
+    "@poveste/vendors": "^0.17.1",
     "change-case": "^5.4.4",
     "chokidar": "^5.0.0",
     "defu": "^6.1.4",