poveste 0.17.0 → 0.17.2

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/vite.js

@@ -146,6 +146,7 @@ export async function getViteConfigWithPlugins(isServer, ctx) {
     plugins.push({
         name: 'poveste-vite-plugin',
         config(_, { command }) {
+            const collapsedVue = isServer || process.env['POVESTE_DEV'] ? {} : collapseVendoredVue({ root: ctx.root });
             return {
                 resolve: {
                     dedupe: [
@@ -160,7 +161,7 @@ export async function getViteConfigWithPlugins(isServer, ctx) {
                         // `@poveste/vendors/vue`, so sending `poveste-vue` back to `vue` would
                         // point the vendored entry at itself — the empty re-export its own
                         // comment warns about.
-                        ...(isServer || process.env['POVESTE_DEV'] ? {} : collapseVendoredVue({ root: ctx.root })),
+                        ...collapsedVue,
                     },
                     ...(isServer
                         ? {
@@ -177,9 +178,17 @@ export async function getViteConfigWithPlugins(isServer, ctx) {
                         // their deps cost a full reload when they turn up later (#282).
                         ...optimizeEntries(ctx.config, ctx.root, isServer),
                     ],
-                    include: optimizeDeps([
-                        'shiki',
-                    ]),
+                    include: [
+                        ...optimizeDeps([
+                            'shiki',
+                        ]),
+                        // With the alias above, `poveste-vue` is pre-bundled from the project's
+                        // Vue, but bare `vue` is pre-bundled only if a project file imports it.
+                        // A Svelte, Solid or React book has none, so `poveste-vue-router`'s
+                        // bare `vue` was served raw beside the pre-bundled copy of the same
+                        // file: two module instances, and `RouterView` rendered nothing (#1134).
+                        ...(Object.keys(collapsedVue).length > 0 ? ['vue'] : []),
+                    ],
                     exclude: [
                         'poveste',
                         '@poveste/vendors',

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.17.0",
+  "version": "0.17.2",
   "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,6 +61,7 @@
     "client.d.ts",
     "client.js",
     "dist",
+    "framework-floor.mjs",
     "index.d.ts",
     "node-floor.mjs",
     "plugin.d.ts",
@@ -74,10 +75,10 @@
   },
   "dependencies": {
     "@11ty/gray-matter": "^3.0.0",
-    "@poveste/app": "^0.17.0",
-    "@poveste/controls": "^0.17.0",
-    "@poveste/shared": "^0.17.0",
-    "@poveste/vendors": "^0.17.0",
+    "@poveste/app": "^0.17.2",
+    "@poveste/controls": "^0.17.2",
+    "@poveste/shared": "^0.17.2",
+    "@poveste/vendors": "^0.17.2",
     "change-case": "^5.4.4",
     "chokidar": "^5.0.0",
     "defu": "^6.1.4",