@arkenv/vite-plugin 0.0.4 → 0.0.7

package/README.md

@@ -1,3 +1,88 @@
-# `@arkenv/vite-plugin`
-
-A Vite plugin for using ArkEnv to validate environment variables at build time.
+# `@arkenv/vite-plugin`
+
+A Vite plugin for using ArkEnv to validate environment variables at build time.
+
+## Installation
+
+```sh
+npm install @arkenv/vite-plugin arkenv arktype
+```
+
+## 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'
+    }),
+  ],
+});
+```
+
+## Features
+
+- 🔒 **Build-time validation**: Catch missing or invalid environment variables during build
+- 🚀 **TypeScript support**: Full type inference for your environment variables
+- 💪 **Powered by ArkType**: Leverage ArkType's powerful type system
+- ⚡ **Zero runtime overhead**: Validation happens at build time only
+
+## Usage
+
+The plugin validates environment variables that start with `VITE_` (Vite's convention for client-side environment variables). Define your schema in the plugin configuration:
+
+```typescript
+arkenv({
+  // Required string
+  VITE_API_URL: "string",
+  
+  // String literal union
+  VITE_NODE_ENV: "'development' | 'production' | 'test'",
+  
+  // Optional with default
+  "VITE_DEBUG?": 'boolean = false',
+  
+  // Array of strings
+  "VITE_ALLOWED_ORIGINS?": 'string[] = []'
+})
+```
+
+## Environment Variables
+
+Create a `.env` file in your project root:
+
+```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
+```
+
+## TypeScript Integration
+
+The plugin automatically provides type information for `import.meta.env`:
+
+```typescript
+// TypeScript knows the exact types!
+console.log(import.meta.env.VITE_API_URL);     // string
+console.log(import.meta.env.VITE_NODE_ENV);    // "development" | "production" | "test"
+console.log(import.meta.env.VITE_DEBUG);       // boolean
+```
+
+## Examples
+
+See the [with-vite-react-ts example](https://github.com/yamcodes/arkenv/tree/main/examples/with-vite-react-ts) for a complete working setup.
+
+## Documentation
+
+For detailed documentation and more examples, visit the [ArkEnv documentation site](https://arkenv.js.org/docs).
+
+## Related
+
+- [ArkEnv](https://github.com/yamcodes/arkenv) - The core library
+- [ArkType](https://arktype.io/) - The underlying validator / type system

package/dist/index.cjs

@@ -28,6 +28,6 @@ var import_vite = require("vite");
 var index_default = (options) => ({
   name: "@arkenv/vite-plugin",
   config(_config, { mode }) {
-    (0, import_arkenv.defineEnv)(options, (0, import_vite.loadEnv)(mode, process.cwd(), ""));
+    (0, import_arkenv.createEnv)(options, (0, import_vite.loadEnv)(mode, process.cwd(), ""));
   }
 });

package/dist/index.d.cts

@@ -1,7 +1,6 @@
-import { type } from 'arktype';
+import { EnvSchema } from 'arkenv';
 import { Plugin } from 'vite';
 
-type EnvSchema<T extends Record<string, string | undefined> = Record<string, string | undefined>> = type.validate<T>;
-declare const _default: <T extends EnvSchema>(options: EnvSchema<T>) => Plugin;
+declare const _default: <T extends Record<string, string | undefined>>(options: EnvSchema<T>) => Plugin;
 
 export { _default as default };

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-import { type } from 'arktype';
+import { EnvSchema } from 'arkenv';
 import { Plugin } from 'vite';
 
-type EnvSchema<T extends Record<string, string | undefined> = Record<string, string | undefined>> = type.validate<T>;
-declare const _default: <T extends EnvSchema>(options: EnvSchema<T>) => Plugin;
+declare const _default: <T extends Record<string, string | undefined>>(options: EnvSchema<T>) => Plugin;
 
 export { _default as default };

package/dist/index.js

@@ -1,10 +1,10 @@
 // src/index.ts
-import { defineEnv } from "arkenv";
+import { createEnv } from "arkenv";
 import { loadEnv } from "vite";
 var index_default = (options) => ({
   name: "@arkenv/vite-plugin",
   config(_config, { mode }) {
-    defineEnv(options, loadEnv(mode, process.cwd(), ""));
+    createEnv(options, loadEnv(mode, process.cwd(), ""));
   }
 });
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkenv/vite-plugin",
-  "version": "0.0.4",
+  "version": "0.0.7",
   "author": "Yam Borodetsky <yam@yam.codes>",
   "repository": {
     "type": "git",
@@ -9,15 +9,18 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "dependencies": {
-    "arkenv": "0.2.0"
+    "arkenv": "0.4.0"
   },
   "devDependencies": {
+    "@vitejs/plugin-react": "^5.0.2",
     "tsup": "^8.5.0",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "vite": "^7.0.0",
+    "vitest": "^3.2.4"
   },
   "peerDependencies": {
-    "arktype": "^2.0.0",
-    "vite": "^6.0.0"
+    "arktype": "^2.1.22",
+    "vite": "^6.0.0 || ^7.0.0"
   },
   "exports": {
     "types": "./dist/index.d.ts",
@@ -29,7 +32,7 @@
   "files": [
     "dist"
   ],
-  "homepage": "https://yam.codes/arkenv",
+  "homepage": "https://arkenv.js.org",
   "keywords": [
     "arktype",
     "arkenv",