@arkenv/vite-plugin 0.0.16 → 0.0.17

package/README.md

@@ -2,28 +2,14 @@
 
 [Vite](https://vite.dev/) plugin to validate environment variables at build-time with ArkEnv.
 
-## Installation
+<br/>
+<br/>
+<br/>
 
-```sh
-npm install @arkenv/vite-plugin arkenv arktype
-```
+## [Read the docs →](https://arkenv.js.org/docs/vite-plugin)
 
-## Quickstart
-
-```typescript title="vite.config.ts"
-import arkenv from "@arkenv/vite-plugin";
-import { defineConfig } from "vite";
-
-export default defineConfig({
-  plugins: [
-    arkenv({
-      VITE_API_URL: "string",
-      VITE_APP_NAME: "'MyApp' | 'TestApp'",
-      "VITE_DEBUG?": 'boolean = false'
-    }),
-  ],
-});
-```
+<br/>
+<br/>
 
 ## Features
 
@@ -31,37 +17,39 @@ export default defineConfig({
 - Typesafe environment variables backed by TypeScript
 - Access to ArkType's powerful type system
 
-## Usage
-
-Simply add the plugin to your Vite config and define your environment variables:
-
-```typescript
-// vite.config.ts
-import arkenv from "@arkenv/vite-plugin";
-import { defineConfig } from "vite";
-
-export default defineConfig({
-  plugins: [
-    arkenv({
-      VITE_API_URL: "string",
-      VITE_NODE_ENV: "'development' | 'production' | 'test'",
-      "VITE_DEBUG?": 'boolean = false',
-      "VITE_ALLOWED_ORIGINS?": 'string[] = []'
-    }),
-  ],
-});
+## Installation
+
+<details open>
+<summary>npm</summary>
+
+```sh
+npm install @arkenv/vite-plugin arktype
+```
+</details>
+
+<details>
+<summary>pnpm</summary>
+
+```sh
+pnpm add @arkenv/vite-plugin arktype
 ```
+</details>
 
-## Environment Variables
+<details>
+<summary>Yarn</summary>
 
-Create a `.env` file in your project root:
+```sh
+yarn add @arkenv/vite-plugin arktype
+```
+</details>
 
-```dotenv title=".env"
-VITE_API_URL=https://api.example.com
-VITE_NODE_ENV=development
-VITE_DEBUG=true
-VITE_ALLOWED_ORIGINS=http://localhost:3000,https://example.com
+<details>
+<summary>Bun</summary>
+
+```sh
+bun add @arkenv/vite-plugin arktype
 ```
+</details>
 
 ## FAQ
 
@@ -69,9 +57,9 @@ VITE_ALLOWED_ORIGINS=http://localhost:3000,https://example.com
 
 This plugin uses [the Vite specific `config` hook](https://vite.dev/guide/api-plugin.html#config), which is not available in Rollup.
 
-## Examples
+## Playground
 
-* [with-vite-react-ts](https://github.com/yamcodes/arkenv/tree/main/examples/with-vite-react-ts)
+* [vite-playground](https://github.com/yamcodes/arkenv/tree/main/apps/playgrounds/vite)
 
 ## Related
 

package/dist/index.cjs

@@ -1 +1 @@
-var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require(`arkenv`);c=s(c);let l=require(`vite`);l=s(l);function u(e){return{name:`@arkenv/vite-plugin`,config(t,{mode:n}){let r=(0,c.createEnv)(e,(0,l.loadEnv)(n,process.cwd(),``));return{define:Object.fromEntries(Object.entries(r).map(([e,t])=>[`import.meta.env.${e}`,JSON.stringify(t)]))}}}}module.exports=u;
+let e=require(`arkenv`),t=require(`vite`);function n(n){return{name:`@arkenv/vite-plugin`,config(r,{mode:i}){let a=r.envPrefix??`VITE_`,o=Array.isArray(a)?a:[a],s=(0,e.createEnv)(n,(0,t.loadEnv)(i,process.cwd(),``)),c=Object.fromEntries(Object.entries(s).filter(([e])=>o.some(t=>e.startsWith(t))));return{define:Object.fromEntries(Object.entries(c).map(([e,t])=>[`import.meta.env.${e}`,JSON.stringify(t)]))}}}}module.exports=n;

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { EnvSchema } from "arkenv";
+import { type } from "arktype";
 import { Plugin } from "vite";
 
 //#region src/index.d.ts
@@ -8,5 +9,6 @@ import { Plugin } from "vite";
  * and be as close as possible to the type accepted by ArkType's `type`.
  */
 declare function arkenv<const T extends Record<string, unknown>>(options: EnvSchema<T>): Plugin;
+declare function arkenv(options: type.Any): Plugin;
 export = arkenv;
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;AAE4C;;AAQxB,iBADI,MACJ,CAAA,gBAD2B,MAC3B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA,OAAA,EAAV,SAAU,CAAA,CAAA,CAAA,CAAA,EACjB,MADiB;AAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAG4C;;AAQxB,iBADI,MACJ,CAAA,gBAD2B,MAC3B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA,OAAA,EAAV,SAAU,CAAA,CAAA,CAAA,CAAA,EACjB,MADiB;AAAV,iBAEc,MAAA,CAFd,OAAA,EAE8B,IAAA,CAAK,GAFnC,CAAA,EAEyC,MAFzC;AAAA"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { EnvSchema } from "arkenv";
 import { Plugin } from "vite";
+import { type } from "arktype";
 
 //#region src/index.d.ts
 
@@ -8,6 +9,7 @@ import { Plugin } from "vite";
  * and be as close as possible to the type accepted by ArkType's `type`.
  */
 declare function arkenv<const T extends Record<string, unknown>>(options: EnvSchema<T>): Plugin;
+declare function arkenv(options: type.Any): Plugin;
 //#endregion
 export { arkenv as default };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;AAE4C;;AAQxB,iBADI,MACJ,CAAA,gBAD2B,MAC3B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA,OAAA,EAAV,SAAU,CAAA,CAAA,CAAA,CAAA,EACjB,MADiB"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAG4C;;AAQxB,iBADI,MACJ,CAAA,gBAD2B,MAC3B,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,CAAA,OAAA,EAAV,SAAU,CAAA,CAAA,CAAA,CAAA,EACjB,MADiB;AAAV,iBAEc,MAAA,CAFd,OAAA,EAE8B,IAAA,CAAK,GAFnC,CAAA,EAEyC,MAFzC"}

package/dist/index.js

@@ -1,2 +1,2 @@
-import{createEnv as e}from"arkenv";import{loadEnv as t}from"vite";function n(n){return{name:`@arkenv/vite-plugin`,config(r,{mode:i}){let a=e(n,t(i,process.cwd(),``));return{define:Object.fromEntries(Object.entries(a).map(([e,t])=>[`import.meta.env.${e}`,JSON.stringify(t)]))}}}}export{n as default};
+import{createEnv as e}from"arkenv";import{loadEnv as t}from"vite";function n(n){return{name:`@arkenv/vite-plugin`,config(r,{mode:i}){let a=r.envPrefix??`VITE_`,o=Array.isArray(a)?a:[a],s=e(n,t(i,process.cwd(),``)),c=Object.fromEntries(Object.entries(s).filter(([e])=>o.some(t=>e.startsWith(t))));return{define:Object.fromEntries(Object.entries(c).map(([e,t])=>[`import.meta.env.${e}`,JSON.stringify(t)]))}}}}export{n as default};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { EnvSchema } from \"arkenv\";\nimport { createEnv } from \"arkenv\";\nimport { loadEnv, type Plugin } from \"vite\";\n\n/**\n * TODO: If possible, find a better type than \"const T extends Record<string, unknown>\",\n * and be as close as possible to the type accepted by ArkType's `type`.\n */\n\nexport default function arkenv<const T extends Record<string, unknown>>(\n\toptions: EnvSchema<T>,\n): Plugin {\n\treturn {\n\t\tname: \"@arkenv/vite-plugin\",\n\t\tconfig(_config, { mode }) {\n\t\t\tconst env = createEnv(options, loadEnv(mode, process.cwd(), \"\"));\n\n\t\t\t// Expose transformed environment variables through Vite's define option\n\t\t\tconst define = Object.fromEntries(\n\t\t\t\tObject.entries(<Record<string, unknown>>env).map(([key, value]) => [\n\t\t\t\t\t`import.meta.env.${key}`,\n\t\t\t\t\tJSON.stringify(value),\n\t\t\t\t]),\n\t\t\t);\n\n\t\t\treturn { define };\n\t\t},\n\t};\n}\n"],"mappings":"kEASA,SAAwB,EACvB,EACS,CACT,MAAO,CACN,KAAM,sBACN,OAAO,EAAS,CAAE,QAAQ,CACzB,IAAM,EAAM,EAAU,EAAS,EAAQ,EAAM,QAAQ,KAAK,CAAE,GAAG,CAAC,CAUhE,MAAO,CAAE,OAPM,OAAO,YACrB,OAAO,QAAiC,EAAI,CAAC,KAAK,CAAC,EAAK,KAAW,CAClE,mBAAmB,IACnB,KAAK,UAAU,EAAM,CACrB,CAAC,CACF,CAEgB,EAElB"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { EnvSchema } from \"arkenv\";\nimport { createEnv } from \"arkenv\";\nimport type { type } from \"arktype\";\nimport { loadEnv, type Plugin } from \"vite\";\n\n/**\n * TODO: If possible, find a better type than \"const T extends Record<string, unknown>\",\n * and be as close as possible to the type accepted by ArkType's `type`.\n */\n\nexport default function arkenv<const T extends Record<string, unknown>>(\n\toptions: EnvSchema<T>,\n): Plugin;\nexport default function arkenv(options: type.Any): Plugin;\nexport default function arkenv<const T extends Record<string, unknown>>(\n\toptions: EnvSchema<T> | type.Any,\n): Plugin {\n\treturn {\n\t\tname: \"@arkenv/vite-plugin\",\n\t\tconfig(config, { mode }) {\n\t\t\t// Get the Vite prefix for client-exposed environment variables\n\t\t\t// Defaults to \"VITE_\" if not specified\n\t\t\t// Vite allows envPrefix to be a string or array of strings\n\t\t\tconst envPrefix = config.envPrefix ?? \"VITE_\";\n\t\t\tconst prefixes = Array.isArray(envPrefix) ? envPrefix : [envPrefix];\n\n\t\t\t// createEnv accepts both EnvSchema and type.Any at runtime\n\t\t\t// We use overloads above to provide external type precision\n\t\t\tconst env = createEnv(options, loadEnv(mode, process.cwd(), \"\"));\n\n\t\t\t// Filter to only include environment variables matching the prefix\n\t\t\t// This prevents server-only variables from being exposed to client code\n\t\t\tconst filteredEnv = Object.fromEntries(\n\t\t\t\tObject.entries(<Record<string, unknown>>env).filter(([key]) =>\n\t\t\t\t\tprefixes.some((prefix) => key.startsWith(prefix)),\n\t\t\t\t),\n\t\t\t);\n\n\t\t\t// Expose transformed environment variables through Vite's define option\n\t\t\t// Only prefixed variables are exposed to client code\n\t\t\tconst define = Object.fromEntries(\n\t\t\t\tObject.entries(filteredEnv).map(([key, value]) => [\n\t\t\t\t\t`import.meta.env.${key}`,\n\t\t\t\t\tJSON.stringify(value),\n\t\t\t\t]),\n\t\t\t);\n\n\t\t\treturn { define };\n\t\t},\n\t};\n}\n"],"mappings":"kEAcA,SAAwB,EACvB,EACS,CACT,MAAO,CACN,KAAM,sBACN,OAAO,EAAQ,CAAE,QAAQ,CAIxB,IAAM,EAAY,EAAO,WAAa,QAChC,EAAW,MAAM,QAAQ,EAAU,CAAG,EAAY,CAAC,EAAU,CAI7D,EAAM,EAAU,EAAS,EAAQ,EAAM,QAAQ,KAAK,CAAE,GAAG,CAAC,CAI1D,EAAc,OAAO,YAC1B,OAAO,QAAiC,EAAI,CAAC,QAAQ,CAAC,KACrD,EAAS,KAAM,GAAW,EAAI,WAAW,EAAO,CAAC,CACjD,CACD,CAWD,MAAO,CAAE,OAPM,OAAO,YACrB,OAAO,QAAQ,EAAY,CAAC,KAAK,CAAC,EAAK,KAAW,CACjD,mBAAmB,IACnB,KAAK,UAAU,EAAM,CACrB,CAAC,CACF,CAEgB,EAElB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkenv/vite-plugin",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "author": "Yam Borodetsky <yam@yam.codes>",
   "repository": {
     "type": "git",
@@ -9,17 +9,17 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "dependencies": {
-    "arkenv": "0.7.5"
+    "arkenv": "0.7.6"
   },
   "devDependencies": {
     "@size-limit/preset-small-lib": "11.2.0",
-    "arktype": "2.1.25",
+    "arktype": "2.1.26",
     "size-limit": "11.2.0",
-    "tsdown": "0.15.12",
+    "tsdown": "0.16.1",
     "typescript": "5.9.3",
-    "vite": "7.1.12",
+    "vite": "^7.2.4",
     "vite-tsconfig-paths": "5.1.4",
-    "vitest": "4.0.8"
+    "vitest": "4.0.9"
   },
   "peerDependencies": {
     "arktype": "^2.1.22",