feat: add env:*

Author: lxsmnsyc

packages/start/src/config/env.ts

@@ -0,0 +1,66 @@
+import { loadEnv, type Plugin } from "vite";
+
+export interface EnvPluginOptions {
+  server?: {
+    load?: () => Record<string, string>;
+    prefix?: string;
+  };
+  client?: {
+    load?: () => Record<string, string>;
+    prefix?: string;
+  };
+}
+
+const SERVER_ENV = "env:server";
+const CLIENT_ENV = "env:client";
+
+const DEFAULT_SERVER_PREFIX = "SERVER_";
+const DEFAULT_CLIENT_PREFIX = "CLIENT_";
+
+const SERVER_ONLY_MODULE = `throw new Error('Attempt to load server-only environment variables in client runtime.');`;
+
+function convertObjectToModule(object: Record<string, string>): string {
+  let result = "";
+  for (const key in object) {
+    result += `export const ${key} = ${JSON.stringify(object[key])};`;
+  }
+  return result;
+}
+
+export function envPlugin(options?: EnvPluginOptions): Plugin {
+  const currentOptions = options ?? {};
+  let env: string;
+  const serverPrefix = currentOptions.server?.prefix ?? DEFAULT_SERVER_PREFIX;
+  const clientPrefix = currentOptions.client?.prefix ?? DEFAULT_CLIENT_PREFIX;
+  return {
+    name: "solid-start:env",
+    enforce: "pre",
+    configResolved(config) {
+      env = config.mode !== "production" ? "development" : "production";
+    },
+    resolveId(id) {
+      if (id === SERVER_ENV || id === CLIENT_ENV) {
+        return id;
+      }
+      return null;
+    },
+    load(id, opts) {
+      if (id === SERVER_ENV) {
+        if (!opts?.ssr) {
+          return SERVER_ONLY_MODULE;
+        }
+        const vars = currentOptions.server?.load
+          ? currentOptions.server.load()
+          : loadEnv(env, false, clientPrefix);
+        return convertObjectToModule(vars);
+      }
+      if (id === CLIENT_ENV) {
+        const vars = currentOptions.client?.load
+          ? currentOptions.client.load()
+          : loadEnv(env, false, serverPrefix);
+        return convertObjectToModule(vars);
+      }
+      return null;
+    },
+  };
+}

packages/start/src/config/index.ts

@@ -8,6 +8,7 @@ import solid, { type Options as SolidOptions } from "vite-plugin-solid";
 
 import { DEFAULT_EXTENSIONS, VIRTUAL_MODULES, VITE_ENVIRONMENTS } from "./constants.ts";
 import { devServer } from "./dev-server.ts";
+import { EnvPluginOptions, envPlugin } from "./env.ts";
 import { SolidStartClientFileRouter, SolidStartServerFileRouter } from "./fs-router.ts";
 import { fsRoutes } from "./fs-routes/index.ts";
 import type { BaseFileSystemRouter } from "./fs-routes/router.ts";
@@ -32,6 +33,7 @@ export interface SolidStartOptions {
      */
     mode?: "js" | "json";
   };
+  env?: EnvPluginOptions;
 }
 
 const absolute = (path: string, root: string) =>
@@ -175,6 +177,7 @@ export function solidStart(options?: SolidStartOptions): Array<PluginOption> {
       },
     }),
     lazy(),
+    envPlugin(options?.env),
     // Must be placed after fsRoutes, as treeShake will remove the
     // server fn exports added in by this plugin
     TanStackServerFnPlugin({