@arkenv/vite-plugin 0.0.9 → 0.0.11

package/README.md

@@ -1,6 +1,6 @@
 # `@arkenv/vite-plugin`
 
-A Vite plugin for using ArkEnv to validate environment variables at build time.
+[Vite](https://vite.dev/) plugin to validate environment variables at build-time with ArkEnv.
 
 ## Installation
 
@@ -27,29 +27,29 @@ export default defineConfig({
 
 ## 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
+- Build-time validation - app won't start if environment variables are invalid
+- Typesafe environment variables backed by TypeScript
+- Access to ArkType's powerful type system
 
 ## 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:
+Simply add the plugin to your Vite config and define your environment variables:
 
 ```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[] = []'
-})
+// 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[] = []'
+    }),
+  ],
+});
 ```
 
 ## Environment Variables
@@ -63,26 +63,11 @@ 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).
+* [with-vite-react-ts](https://github.com/yamcodes/arkenv/tree/main/examples/with-vite-react-ts)
 
 ## Related
 
-- [ArkEnv](https://github.com/yamcodes/arkenv) - The core library
-- [ArkType](https://arktype.io/) - The underlying validator / type system
+- [ArkEnv](https://arkenv.js.org) - Core library and docs
+- [ArkType](https://arktype.io/) - Underlying validator / type system

package/dist/index.cjs

@@ -20,14 +20,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  default: () => index_default
+  default: () => arkenv
 });
 module.exports = __toCommonJS(index_exports);
 var import_arkenv = require("arkenv");
 var import_vite = require("vite");
-var index_default = (options) => ({
-  name: "@arkenv/vite-plugin",
-  config(_config, { mode }) {
-    (0, import_arkenv.createEnv)(options, (0, import_vite.loadEnv)(mode, process.cwd(), ""));
-  }
-});
+function arkenv(options) {
+  return {
+    name: "@arkenv/vite-plugin",
+    config(_config, { mode }) {
+      (0, import_arkenv.createEnv)(options, (0, import_vite.loadEnv)(mode, process.cwd(), ""));
+    }
+  };
+}

package/dist/index.d.cts

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

package/dist/index.d.ts

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

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkenv/vite-plugin",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "author": "Yam Borodetsky <yam@yam.codes>",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "dependencies": {
-    "arkenv": "0.6.0"
+    "arkenv": "0.7.1"
   },
   "devDependencies": {
     "@types/react": "^19.1.12",