Merge pull request #14 from SimeonC/main

feat: add output for debugging CI

README.md

@@ -56,6 +56,23 @@ export default defineConfig({
 })
 ```
 
+If you want to see what values are being evaluated for the build, for example when running in CI. You can pass the `debug` option as follows:
+```ts
+import { defineConfig } from "vite";
+import { Schema, ValidateEnv } from "@julr/vite-plugin-validate-env";
+
+export default defineConfig({
+  plugins: [
+    ValidateEnv({
+      debug: true,
+      schema: {
+        VITE_MY_VAR: Schema.string()
+      }
+    }),
+  ],
+})
+```
+
 ### Built-in validator
 
 ```ts

bin/test.ts

@@ -2,6 +2,8 @@ import { assert } from '@japa/assert'
 import { fileSystem } from '@japa/file-system'
 import { configure, processCLIArgs, run } from '@japa/runner'
 
+process.env.NODE_ENV = 'testing'
+
 /*
 |--------------------------------------------------------------------------
 | Configure tests

package.json

@@ -72,7 +72,7 @@
     }
   },
   "dependencies": {
-    "@poppinss/colors": "^4.1.1",
+    "@poppinss/cliui": "^6.2.1",
     "@poppinss/validator-lite": "^1.0.3",
     "unconfig": "^0.3.11"
   },

playground/vite.config.ts

@@ -8,29 +8,31 @@ import { Schema, ValidateEnv } from '../src/index.js'
 export default defineConfig({
   root: __dirname,
   plugins: [
-    // ValidateEnv({
-    //   VITE_STRING: Schema.string(),
-    //   VITE_NUMBER: Schema.number(),
-    //   VITE_BOOLEAN: Schema.boolean(),
-    // }),
     ValidateEnv({
-      validator: 'zod',
+      validator: 'builtin',
+      debug: true,
       schema: {
-        VITE_STRING: z.string(),
-        VITE_NUMBER: z.preprocess((value) => Number(value), z.number()),
-        VITE_BOOLEAN: z.preprocess((value) => value === 'true' || value === '1', z.boolean()),
-
-        VITE_OBJECT: z.preprocess(
-          (value) => {
-            console.log(value)
-            return JSON.parse(value as string)
-          },
-          z.object({
-            a: z.string(),
-            b: z.number(),
-          }),
-        ),
+        VITE_STRING: Schema.string(),
+        VITE_NUMBER: Schema.number(),
+        VITE_BOOLEAN: Schema.boolean(),
       },
     }),
+    // ValidateEnv({
+    //   validator: 'zod',
+    //   debug: true,
+    //   schema: {
+    //     VITE_STRING: z.string(),
+    //     VITE_NUMBER: z.preprocess((value) => Number(value), z.number()),
+    //     VITE_BOOLEAN: z.preprocess((value) => value === 'true' || value === '1', z.boolean()),
+
+    //     VITE_OBJECT: z.preprocess(
+    //       (value) => JSON.parse(value as string),
+    //       z.object({
+    //         a: z.string(),
+    //         b: z.number(),
+    //       }),
+    //     ),
+    //   },
+    // }),
   ],
 })

src/contracts/index.ts

@@ -13,8 +13,8 @@ export type RecordViteKeys<T> = Record<`${string}_${string}`, T>
 export type PluginOptions = Schema | FullPluginOptions
 
 export type FullPluginOptions =
-  | { validator: 'builtin'; schema: PoppinsSchema }
-  | { validator: 'zod'; schema: ZodSchema }
+  | { validator: 'builtin'; schema: PoppinsSchema; debug?: boolean }
+  | { validator: 'zod'; schema: ZodSchema; debug?: boolean }
 
 /**
  * Contract for schema definition for poppins validator