@verdnatura/vn-front-lib 0.0.12 → 0.1.0

package/README.md

@@ -14,6 +14,15 @@ it's built in library mode (Vite `build.lib`) and consumed as a dependency.
 `pinia`, `vue-i18n`, `axios`, `validator` and `quasar` are expected to be
 provided by the consuming project (declared as `peerDependencies`).
 
+### Importing from `quasar`
+
+Always import `quasar` with a namespace import (`import * as quasar from 'quasar'`),
+never a named import (`import { Notify } from 'quasar'`). `@quasar/vite-plugin`'s
+auto-import rewrites named imports into deep `quasar/src/**` paths, which aren't
+resolvable by consumers (quasar's `package.json` only exports `.`) and, if bundled
+anyway, create a separate module instance from the one the consuming app installs —
+breaking singletons like `Notify.create`/`useQuasar`'s injection.
+
 ## Recommended VS Code extension
 
 This project uses [oxlint](https://oxc.rs/docs/guide/usage/linter.html) and
@@ -45,28 +54,28 @@ deduped into a single instance across both projects:
 1. In the consuming project's `pnpm-workspace.yaml`, add this repo as a
    package:
 
-    ```yaml
-    packages:
-        - .
-        - ../vn-front-lib
-    ```
+   ```yaml
+   packages:
+     - .
+     - ../vn-front-lib
+   ```
 
 2. In the consuming project's `package.json`, depend on it via the workspace
    protocol, using the real package name:
 
-    ```json
-    "@verdnatura/vn-front-lib": "workspace:@verdnatura/vn-front-lib@*",
-    ```
+   ```json
+   "@verdnatura/vn-front-lib": "workspace:@verdnatura/vn-front-lib@*",
+   ```
 
 3. Enable the `vnSource` resolution condition in the consumer's Vite/Vitest
    config so imports resolve to this repo's `lib/` source instead of the
    `dist/` build:
 
-    ```js
-    resolve: {
-        conditions: ['vnSource'],
-    },
-    ```
+   ```js
+   resolve: {
+       conditions: ['vnSource'],
+   },
+   ```
 
 4. Reinstall dependencies in the consuming project (`pnpm install`), then run
    `pnpm why vue -r` / `pnpm why pinia -r` to confirm only one version of