@picked/vite-plugin-picked 0.0.1-dev.1788925875333 → 0.0.1-dev.1793753513002

package/LICENSE

@@ -0,0 +1 @@
+Copyright (c) Picked. All rights reserved. Contact Picked for a usage licence.

package/README.md

@@ -0,0 +1,52 @@
+# @picked/vite-plugin-picked
+
+Embeds your Picked project's configuration and content in the bundle at build time, so the
+SDK makes no configuration request at runtime. It also generates types and serves a preview
+launcher during development.
+
+## Install
+
+```bash
+npm install -D @picked/vite-plugin-picked
+```
+
+Supports Vite 7 and 8.
+
+## Usage
+
+```typescript
+// vite.config.ts
+import { defineConfig } from 'vite'
+import { picked } from '@picked/vite-plugin-picked'
+
+export default defineConfig({
+  plugins: [picked()],
+})
+```
+
+The plugin reads the project from `picked.config.ts`. The `data` field there sets where the
+build gets its data:
+
+| `data`       | Build and dev server                                                                     |
+| ------------ | ---------------------------------------------------------------------------------------- |
+| `'bundle'`   | Default. Fetch the configuration and content from the API and embed them.                |
+| `'api'`      | Embed nothing. The SDK reads everything from the API at runtime.                         |
+| `'snapshot'` | Embed the committed `picked.snapshot.json`. No request. Write it with `npx picked pull`. |
+
+The `mode` plugin option is deprecated; set `data` in `picked.config.ts` instead.
+
+To type `virtual:picked/data`, add `"@picked/vite-plugin-picked/client"` to
+`compilerOptions.types` in `tsconfig.json`.
+
+| Option            | Default              | Description                                                |
+| ----------------- | -------------------- | ---------------------------------------------------------- |
+| `generateTypes`   | `true`               | Generate types from the workspace schema on dev and build. |
+| `disableLauncher` | `false`              | Leave out the launcher page.                               |
+| `telemetry`       | from `picked.config` | Send anonymous build-time telemetry.                       |
+
+## Docs
+
+- **Web:** [Vite Plugin](https://docs.picked.app/reference/tools/vite-plugin)
+- **Local:** `node_modules/picked/docs/reference/tools/vite-plugin.md`. The `picked` package carries every page under `node_modules/picked/docs/`.
+- **CLI:** `npx picked docs read /reference/tools/vite-plugin`. `npx picked docs list [words]` lists the pages.
+- **MCP:** call `read_picked_doc` with `{ "path": "/reference/tools/vite-plugin" }`; `list_picked_docs` lists the pages. Add the server with `claude mcp add --transport http picked https://api.picked.app/mcp`, or see [How to connect the MCP server](https://docs.picked.app/how-to/connect-the-mcp-server) for other tools.