@poveste/plugin-react 0.19.1 → 0.21.0

package/README.md

@@ -42,4 +42,4 @@ export default defineStory({
 
 ## What it does
 
-This first version renders stories and variants. The source panel shows the story file. The controls panel is not wired to React: a variant with `initState` gets the generic state editor, and one without says why there is nothing there.
+It renders stories and variants. The source panel shows the story file. A story that names its component in its `component` field gets a props, slots and events table on its Docs tab, read from the component's types; it needs `typescript` 6 or earlier and `@types/react` in the book. See [Component docs](https://poveste.dev/guide/react/getting-started#component-docs). The controls panel is not wired to React: a variant with `initState` gets the generic state editor, and one without says why there is nothing there.

package/dist/collect/index.js

@@ -11,6 +11,7 @@ export async function run({ file, storyData }) {
         icon: options.icon,
         iconColor: options.iconColor,
         docsOnly: options.docsOnly ?? false,
+        ...options.autoDocs !== undefined ? { autoDocs: options.autoDocs } : {},
         variants: [],
     };
     story.variants = variantOptions(options).map((variant, index) => ({

package/dist/docgen/extractor.d.ts

@@ -0,0 +1,5 @@
+import type { DocgenExtractor, DocgenExtractorContext } from '@poveste/shared';
+import type { JsxDialect } from 'poveste/docgen';
+export declare const REACT_DIALECT: JsxDialect;
+/** Runs in the docgen worker, never in the book. */
+export declare function createExtractor(context: DocgenExtractorContext): DocgenExtractor;

package/dist/docgen/extractor.js

@@ -0,0 +1,12 @@
+import { createJsxExtractor } from 'poveste/docgen';
+export const REACT_DIALECT = {
+    jsxImportSource: 'react',
+    // React merges no defaults by call: they are destructuring defaults, which the walker reads anyway.
+    defaultCalls: [],
+    slotType: /\b(?:ReactNode|ReactElement|JSX\.Element)\b/,
+    childrenTypes: ['PropsWithChildren'],
+};
+/** Runs in the docgen worker, never in the book. */
+export function createExtractor(context) {
+    return createJsxExtractor(context, REACT_DIALECT);
+}

package/dist/index.js

@@ -1,9 +1,21 @@
 // No Node-only import here, on purpose: a story file imports `defineStory` from
 // this entry, so it is bundled for the browser as well as loaded by the config.
 export const REACT_SETUP_HOOK_NAMES = ['setupReact'];
+// A variable, not a literal: Vite turns `new URL('<literal>', import.meta.url)` into
+// an asset, and this entry is bundled for the browser too.
+const DOCGEN_EXTRACTOR = './docgen/extractor.js';
 export function HstReact() {
     return {
         name: '@poveste/plugin-react',
+        // A React story names its component in `component`, so the extractor reads the story (#1161).
+        docgen: {
+            scope: 'story',
+            match: file => /\.story\.[jt]sx$/.test(file),
+            module: new URL(DOCGEN_EXTRACTOR, import.meta.url).href,
+            // The JSX walker loads the book's TypeScript (#1401). React ships no types of its own.
+            typescript: 'book',
+            types: ['@types/react'],
+        },
         defaultConfig() {
             return {
                 // Added to core's defaults rather than replacing them (#1124), so a book

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { Awaitable, Story, StoryProps, Variant, VariantProps } from '@poveste/shared';
+import type { Awaitable, Story, StoryComponentOptions, StoryProps, Variant, VariantProps } from '@poveste/shared';
 import type { ComponentType, ReactNode } from 'react';
 export interface ReactRenderApi<S extends object> {
     /** This render's snapshot. Never mutate it; call `setState`. */
@@ -31,7 +31,7 @@ export interface VariantOptions<S extends object = Record<string, any>> extends
     initState?: () => Awaitable<S>;
     setupApp?: ReactStorySetupHandler;
 }
-export interface StoryOptions<S extends object = Record<string, any>> extends Omit<StoryProps, 'setupApp'> {
+export interface StoryOptions<S extends object = Record<string, any>> extends Omit<StoryProps, 'setupApp'>, StoryComponentOptions<ComponentType<any>> {
     /** A story with no `variants` and a `render` of its own has one implicit variant. */
     variants?: VariantOptions<S>[];
     render?: (api: ReactRenderApi<S>) => ReactNode;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@poveste/plugin-react",
   "type": "module",
-  "version": "0.19.1",
-  "description": "Poveste plugin for React support, renderer only",
+  "version": "0.21.0",
+  "description": "Poveste plugin for React support, with props tables read from your components' types and no controls yet",
   "author": {
     "name": "Sorin Gitlan",
     "url": "https://x.com/50rayn"
@@ -58,7 +58,7 @@
   },
   "peerDependencies": {
     "@vitejs/plugin-react": "^6.0.0",
-    "poveste": "^0.19.1",
+    "poveste": "^0.21.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
   },
@@ -68,21 +68,21 @@
     }
   },
   "dependencies": {
-    "@poveste/shared": "^0.19.1",
-    "@poveste/vendors": "^0.19.1"
+    "@poveste/shared": "^0.21.0",
+    "@poveste/vendors": "^0.21.0"
   },
   "devDependencies": {
-    "@types/node": "^26.6.3",
+    "@types/node": "^26.6.5",
     "@types/react": "^19.3.0",
     "@types/react-dom": "^19.3.0",
-    "@vitejs/plugin-react": "^6.1.1",
-    "jsdom": "^30.1.1",
-    "poveste": "0.19.1",
-    "react": "^19.3.0",
-    "react-dom": "^19.3.0",
+    "@vitejs/plugin-react": "^6.1.2",
+    "jsdom": "^30.1.3",
+    "poveste": "0.21.0",
+    "react": "^19.3.1",
+    "react-dom": "^19.3.1",
     "typescript": "6.0.3",
-    "vite": "^8.3.1",
-    "vitest": "^5.0.2"
+    "vite": "^8.3.4",
+    "vitest": "^5.0.5"
   },
   "scripts": {
     "build": "rimraf dist && tsc -d",