@picked/vite-plugin-picked 0.0.107-next.3 → 0.0.107-next.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -9
- package/dist/.tsbuildinfo +1 -1
- package/dist/cjs/index.js +26 -7
- package/dist/esm/index.js +278 -212
- package/dist/types/index.d.ts +15 -15
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/virtual-module/snapshot.d.ts +31 -0
- package/dist/types/virtual-module/snapshot.d.ts.map +1 -0
- package/package.json +9 -8
package/README.md
CHANGED
|
@@ -24,15 +24,25 @@ export default defineConfig({
|
|
|
24
24
|
})
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
The plugin reads the project from `picked.config.ts`.
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
35
|
-
|
|
27
|
+
The plugin reads the project from `picked.config.ts`. The `data` field there sets where the
|
|
28
|
+
build gets its data:
|
|
29
|
+
|
|
30
|
+
| `data` | Build and dev server |
|
|
31
|
+
| ------------ | ---------------------------------------------------------------------------------------- |
|
|
32
|
+
| `'bundle'` | Default. Fetch the configuration and content from the API and embed them. |
|
|
33
|
+
| `'api'` | Embed nothing. The SDK reads everything from the API at runtime. |
|
|
34
|
+
| `'snapshot'` | Embed the committed `picked.snapshot.json`. No request. Write it with `npx picked pull`. |
|
|
35
|
+
|
|
36
|
+
The `mode` plugin option is deprecated; set `data` in `picked.config.ts` instead.
|
|
37
|
+
|
|
38
|
+
To type `virtual:picked/data`, add `"@picked/vite-plugin-picked/client"` to
|
|
39
|
+
`compilerOptions.types` in `tsconfig.json`.
|
|
40
|
+
|
|
41
|
+
| Option | Default | Description |
|
|
42
|
+
| ----------------- | -------------------- | ---------------------------------------------------------- |
|
|
43
|
+
| `generateTypes` | `true` | Generate types from the workspace schema on dev and build. |
|
|
44
|
+
| `disableLauncher` | `false` | Leave out the launcher page. |
|
|
45
|
+
| `telemetry` | from `picked.config` | Send anonymous build-time telemetry. |
|
|
36
46
|
|
|
37
47
|
## Docs
|
|
38
48
|
|