@poveste/plugin-quasar 0.19.1 → 0.21.0

package/README.md

@@ -6,7 +6,7 @@ Builds a Poveste book inside a Quasar project.
 pnpm add -D poveste @poveste/plugin-vue @poveste/plugin-quasar
 ```
 
-Add both plugins in poveste config, with a setup file:
+Add both plugins in poveste config:
 
 ```ts
 // poveste.config.ts
@@ -19,11 +19,22 @@ export default defineConfig({
     HstVue(),
     HstQuasar(),
   ],
-  setupFile: '/src/poveste.setup.ts',
 })
 ```
 
-The setup file installs Quasar into the app Poveste renders your stories in, and every Quasar component needs it, not only boot files. Without it the book still builds, and each story that uses a Quasar component shows "This component threw while rendering", with `Cannot read properties of undefined (reading 'platform')` in the browser console.
+Every Quasar component needs Quasar installed into the app Poveste renders your stories in. With no `setupFile`, `HstQuasar()` installs it with Quasar's defaults. Name a setup file when you need Quasar's options or your boot files (below). Installing Quasar is then that file's job, and `setupQuasar()` does it. A setup file that skips it shows "This component threw while rendering" on each story that uses a Quasar component, with `Cannot read properties of undefined (reading 'platform')` in the browser console.
+
+```ts
+// poveste.config.ts
+import { HstQuasar } from '@poveste/plugin-quasar'
+import { HstVue } from '@poveste/plugin-vue'
+import { defineConfig } from 'poveste'
+
+export default defineConfig({
+  plugins: [HstVue(), HstQuasar()],
+  setupFile: '/src/poveste.setup.ts',
+})
+```
 
 ```ts
 // src/poveste.setup.ts
@@ -33,6 +44,8 @@ import { defineSetupVue } from '@poveste/plugin-vue'
 export const setupVue = defineSetupVue(setupQuasar())
 ```
 
+Your Vue components get a props, slots and events table on each story's **Docs** tab, through `@poveste/plugin-vue`. It needs `typescript` 6 or earlier in the project (`npm i -D typescript@6`), which a Quasar project installed with npm doesn't have; without it, or with 7, it turns itself off and says so once.
+
 Quasar builds its Vite config asynchronously and exposes it through an
 entrypoint whose own header says it is for tooling. This plugin fetches it and
 makes the two adjustments a book needs — both of which are easy to get wrong and

package/dist/default-setup.d.ts

@@ -0,0 +1,3 @@
+export declare const setupVue: ({ app }: {
+    app: import("vue").App;
+}) => void;

package/dist/default-setup.js

@@ -0,0 +1,4 @@
+import { setupQuasar } from './setup.js';
+// The setup file `HstQuasar()` supplies to a book that names none, so a `<q-btn>`
+// renders rather than throwing on Quasar's missing injection (#1337).
+export const setupVue = setupQuasar();

package/dist/index.js

@@ -1,5 +1,6 @@
 import { existsSync } from 'node:fs';
 import process from 'node:process';
+import { fileURLToPath } from 'node:url';
 import { dirname, join, parse } from 'pathe';
 /**
  * Quasar builds its Vite config asynchronously and hands it over through one
@@ -107,6 +108,8 @@ export function quasarViteConfig(viteConfig) {
         plugins: viteConfig.plugins,
     };
 }
+/** Installs Quasar with its defaults: what `setupQuasar()` does with no options. */
+const DEFAULT_SETUP_FILE = fileURLToPath(new URL('./default-setup.js', import.meta.url));
 export function HstQuasar(options = {}) {
     return {
         name: '@poveste/plugin-quasar',
@@ -118,5 +121,15 @@ export function HstQuasar(options = {}) {
             const viteConfig = await withoutProcessExit(() => getTestingConfig(options.ctx ?? {}));
             return { vite: quasarViteConfig(viteConfig) };
         },
+        // Every Quasar component needs Quasar installed into the app a story renders
+        // in, and a book with no setup file built green and threw on every one of
+        // them (#1337). A book that names its own is left to install it, with its
+        // own options and boot files.
+        config(config) {
+            if (!config.setupFile) {
+                return { setupFile: DEFAULT_SETUP_FILE };
+            }
+            return undefined;
+        },
     };
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@poveste/plugin-quasar",
   "type": "module",
-  "version": "0.19.1",
-  "description": "Poveste plugin that builds a book inside a Quasar project",
+  "version": "0.21.0",
+  "description": "Poveste plugin that builds a book inside a Quasar project, including the props tables @poveste/plugin-vue reads from your components' types",
   "author": {
     "name": "Sorin Gitlan",
     "url": "https://x.com/50rayn"
@@ -52,23 +52,23 @@
   },
   "peerDependencies": {
     "@quasar/app-vite": "^3.8.0",
-    "poveste": "^0.19.1",
+    "poveste": "^0.21.0",
     "quasar": "^2.24.0",
     "vue": "^3.5.43"
   },
   "dependencies": {
-    "@poveste/shared": "0.19.1",
+    "@poveste/shared": "0.21.0",
     "pathe": "^2.0.3"
   },
   "devDependencies": {
-    "@quasar/app-vite": "^3.10.0",
-    "@types/node": "^26.6.3",
-    "poveste": "0.19.1",
-    "quasar": "^2.33.2",
+    "@quasar/app-vite": "^3.10.3",
+    "@types/node": "^26.6.5",
+    "poveste": "0.21.0",
+    "quasar": "^2.35.2",
     "typescript": "6.0.3",
-    "vite": "^8.3.1",
-    "vitest": "^5.0.2",
-    "vue": "^3.5.43"
+    "vite": "^8.3.4",
+    "vitest": "^5.0.5",
+    "vue": "^3.5.44"
   },
   "scripts": {
     "build": "rimraf dist && tsc -d",