@devtime-ltd/vite-plugin-slate 0.1.0 → 0.2.0

package/README.md

@@ -48,11 +48,27 @@ server: {
   cors: true,                            // allow the cross-origin app host to load assets
   allowedHosts: ["vite.app--feat.test"], // accept the proxied Host header
   hmr: { host: "vite.app--feat.test", protocol: "wss", clientPort: 443 },
+  watch: { usePolling: false },          // native fs events; see below
 }
 ```
 
-These are merged into your existing `server` config, so options like
-`server.watch.usePolling` are preserved.
+These are merged into your existing `server` config.
+
+### Filesystem watching
+
+slate's runtime (OrbStack) forwards native filesystem events into the container,
+so Vite doesn't need to poll the worktree — and polling burns a full CPU core per
+workspace, which adds up fast when you run several projects at once. The plugin
+therefore disables polling under slate, **overriding** a `server.watch.usePolling: true`
+in your own config (which is typically a Docker Desktop workaround and unnecessary
+here).
+
+If your Docker runtime doesn't forward fs events and HMR stops noticing changes,
+opt back in:
+
+```js
+slate({ poll: true })
+```
 
 ## License
 

package/index.d.ts

@@ -1,7 +1,17 @@
 import type { Plugin } from "vite";
 
+export interface SlateOptions {
+  /**
+   * Force filesystem polling (`server.watch.usePolling`). Defaults to `false`:
+   * slate's runtime forwards native fs events into the container, so polling
+   * wastes a CPU core per workspace. Set `true` only if your Docker runtime
+   * doesn't forward events and HMR misses changes.
+   */
+  poll?: boolean;
+}
+
 /**
  * Wires the Vite dev server to slate's HTTPS proxy using the VITE_DEV_SERVER_URL
  * env var that slate sets inside a workspace. No-op when that var is unset.
  */
-export default function slate(): Plugin;
+export default function slate(options?: SlateOptions): Plugin;

package/index.js

@@ -4,7 +4,14 @@
 // and rejects the proxied Host header with a 403. This points Vite at the proxy
 // URL and allows the host. No-op when the var is unset, so a plain `npm run dev`
 // outside slate is unaffected.
-export default function slate() {
+//
+// Options:
+//   poll  Force filesystem polling (server.watch.usePolling). Default false:
+//         slate's runtime (OrbStack) forwards native fs events into the
+//         container, so polling just burns a CPU core per workspace. Set true
+//         only if your Docker runtime doesn't forward events and HMR misses
+//         changes.
+export default function slate(options = {}) {
   return {
     name: "vite-plugin-slate",
     apply: "serve",
@@ -26,6 +33,9 @@ export default function slate() {
             protocol: secure ? "wss" : "ws",
             clientPort,
           },
+          watch: {
+            usePolling: options.poll === true,
+          },
         },
       };
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devtime-ltd/vite-plugin-slate",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Vite plugin that wires the dev server to slate's HTTPS proxy.",
   "type": "module",
   "main": "index.js",