@quintal/environment 0.2.0 → 1.0.1

package/README.md

@@ -9,18 +9,25 @@ TO EDIT THE CONTENT, PLEASE MODIFY `/workspace.ts` OR `/scripts/generate.ts`
 [![NPM downloads](https://img.shields.io/npm/dt/@quintal/environment?style=flat-square)](https://npmjs.com/@quintal/environment)
 [![License](https://img.shields.io/npm/l/@quintal/environment?style=flat-square)](https://github.com/quintalwebsolutions/quintal-oss/blob/main/LICENSE)
 [![Bundle size](https://img.shields.io/bundlephobia/minzip/@quintal/environment?style=flat-square)](https://bundlephobia.com/package/@quintal/environment)
-[![Dependencies](https://img.shields.io/librariesio/release/npm/@quintal/environment?style=flat-square)](https://libraries.io/npm/%40quintal%2Fenvironment/)
-[![Code coverage](https://img.shields.io/codecov/c/github/quintalwebsolutions/quintal-oss?style=flat-square&token=3ORY9UP6H7&flag=environment&logo=codecov)](https://codecov.io/gh/quintalwebsolutions/quintal-oss)
+[![Code coverage](https://img.shields.io/codecov/c/github/quintalwebsolutions/quintal-oss?style=flat-square&token=3ORY9UP6H7&flag=environment&logo=codecov)](https://app.codecov.io/gh/quintalwebsolutions/quintal-oss/flags?historicalTrend=LAST_7_DAYS&flags%5B0%5D=environment)
 [![Pull requests welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/quintalwebsolutions/quintal-oss/blob/main/CONTRIBUTING.md)
 
-Framework-agnostic environment variable validation for TypeScript
+Framework-agnostic environment variable validation for TypeScript powered by Zod
 
-You can explore [the exposed functions and types on ts-docs](https://tsdocs.dev/docs/@quintal/environment)
+## Features
+
+- 🔍 Use Zod to validate and transform environment variables,
+- 🔒 Secure environment variables by marking them as server-only,
+- 📦 Nest environment variables into groups,
+- ✅ CommonJS and ES Modules support,
+- ⚖️ Super lightweight (only ~10kb gzipped),
+- 🧪 100% test coverage,
+- 🛡️ Enjoy full type-safety in every step of the process.
 
 ## Table of Contents
 
 - [Getting Started](#getting-started)
-- [Kitchen Sink Example](#kitchen-sink-example)
+- [Examples](#examples)
 
 ## Getting Started
 
@@ -34,74 +41,10 @@ yarn add @quintal/environment
 npm install @quintal/environment
 ```
 
-<!-- END AUTO-GENERATED: Add custom documentation after this comment -->
-
-## Kitchen Sink Example
+## Examples
 
-```ts
-export const environment = createEnvironment({
-  values: {
-    environment: {
-      value: process.env.NEXT_PUBLIC_ENVIRONMENT,
-      schema: z
-        .enum(['DEVELOPMENT', 'PREVIEW', 'PRODUCTION'])
-        .default('DEVELOPMENT'),
-    },
-    port: {
-      value: process.env.PORT,
-      schema: z.coerce.number().int().default(4000),
-      isServerOnly: true,
-    },
-    simpleStringValue: process.env.SIMPLE_STRING_VALUE,
-    isFeatureEnabled: {
-      value: process.env.IS_FEATURE_ENABLED,
-      schema: z.enum(['true', 'false']).transform((s) => s === 'true'),
-    },
-    baseUrl: {
-      self: {
-        value: process.env.NEXT_PUBLIC_BASE_URL_SELF,
-        schema: z.string().url().default('http://localhost:3000'),
-      },
-      api: {
-        value: process.env.NEXT_PUBLIC_BASE_URL_API,
-        schema: z.string().url().default('http://localhost:4000'),
-      },
-    },
-    database: {
-      url: {
-        value: process.env.DATABASE_URL,
-        schema: z.string().url(),
-        isServerOnly: true,
-      },
-      token: {
-        value: process.env.DATABASE_TOKEN,
-        isServerOnly: true,
-      },
-    },
-  },
-});
-```
+Check out these examples to get started quickly:
 
-Every environment variable is defined as an object with the following properties
+- [Kitchen sink](https://codesandbox.io/p/sandbox/x2slnv?file=%2Findex.ts)
 
-```ts
-type EnvValue = {
-  /**
-   * The value
-   * @example process.env.NODE_ENV
-   * @example process.env.DATABASE_URL
-   * @example process.env.NEXT_PUBLIC_ENVIRONMENT
-   */
-  value: string | undefined;
-  /**
-   * Zod schema that validates the value of the environment variable.
-   * @defaultValue z.string()
-   */
-  schema?: ZodType;
-  /**
-   * Only make environment variable available for server-side usage.
-   * @defaultValue false
-   */
-  isServerOnly?: boolean;
-};
-```
+<!-- END AUTO-GENERATED: Add custom documentation after this comment -->

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@quintal/environment",
-  "version": "0.2.0",
+  "version": "1.0.1",
   "license": "MIT",
-  "description": "Framework-agnostic environment variable validation for TypeScript",
+  "description": "Framework-agnostic environment variable validation for TypeScript powered by Zod",
   "keywords": [
     "environment",
     "validation",
@@ -28,18 +28,18 @@
     ".dist"
   ],
   "peerDependencies": {
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
   },
   "devDependencies": {
-    "@types/node": "20.11.24",
-    "@vitest/coverage-v8": "1.3.1",
-    "happy-dom": "13.6.2",
-    "typescript": "5.3.3",
-    "typescript-coverage-report": "1.0.0",
-    "vite": "5.1.4",
-    "vitest": "1.3.1",
-    "zod": "3.22.4",
-    "@quintal/config": "0.2.0"
+    "@biomejs/biome": "1.8.3",
+    "@vitest/coverage-v8": "2.0.5",
+    "happy-dom": "15.7.3",
+    "npm-run-all": "4.1.5",
+    "shx": "0.3.4",
+    "vite": "5.4.2",
+    "vitest": "2.0.5",
+    "zod": "3.23.8",
+    "@quintal/config": "0.2.2"
   },
   "scripts": {
     "build": "run-s build:*",
@@ -48,11 +48,9 @@
     "clean": "shx rm -rf .coverage .coverage-ts .dist .turbo node_modules",
     "dev": "vitest --watch",
     "lint": "pnpm lint:fix && pnpm lint:types",
-    "lint:check": "biome ci .",
-    "lint:fix": "biome check --apply .",
+    "lint:check": "biome ci",
+    "lint:fix": "biome check --write",
     "lint:types": "tsc --noEmit",
-    "test": "run-s test:*",
-    "test:source": "vitest",
-    "test:types": "typescript-coverage-report --outputDir .coverage-ts --strict"
+    "test": "vitest"
   }
 }