@pitininja/envious 6.0.0-beta8 → 6.0.1

package/README.md

@@ -0,0 +1,159 @@
+# Envious
+
+[![npm version](https://badge.fury.io/js/@pitininja%2Fenvious.svg)](https://badge.fury.io/js/@pitininja%2Fenvious)
+
+> Parse and validate environment variables
+
+- [Install](#install)
+- [Resolvers](#resolvers)
+- [Usage](#usage)
+- [Options](#options)
+- [Errors](#errors)
+- [Migration](#migration)
+- [Legacy versions](#legacy-versions)
+
+## Install
+
+Envious works by installing and using two packages : the core package and a resolver.
+
+### Core package
+
+```shell
+npm i @pitininja/envious
+```
+
+### Resolvers
+
+#### Typebox
+
+```shell
+npm i @pitininja/envious-typebox
+```
+
+- [Typebox resolver documentation](https://codeberg.org/pitininja/envious/src/branch/master/packages/resolvers/typebox/README.md)
+- [Official Typebox documentation](https://sinclairzx81.github.io/typebox/)
+
+#### Zod
+
+```shell
+npm i @pitininja/envious-zod
+```
+
+- [Zod resolver documentation](https://codeberg.org/pitininja/envious/src/branch/master/packages/resolvers/zod/README.md)
+- [Official Zod documentation](https://zod.dev/)
+
+## Usage
+
+Here is an example using the Typebox resolver :
+
+```typescript
+import { envious } from '@pitininja/envious';
+import { typeboxResolver } from '@pitininja/envious-typebox';
+import { Type } from '@sinclair/typebox';
+
+const env = envious({
+    resolver: typeboxResolver({
+        schema: Type.Object({
+            STRING_VAR: Type.String(),
+            NUMBER_VAR: Type.Integer(),
+            BOOLEAN_VAR_WITH_DEFAULT: Type.Boolean({ default: false }),
+            OPTIONAL_VAR: Type.Optional(Type.String())
+        })
+    })
+});
+```
+
+Then run the script with loaded environment variables, and these variables will be parsed and validated.
+
+```shell
+# Example loading environment variables with Node.js
+node --env-file=.env index.js
+# Example loading environment variables with TSX
+tsx --env-file=.env index.ts
+# Example loading environment variables with DotEnv
+dotenv -e .env -- node index.js
+```
+
+## Options
+
+### Logging
+
+In addition to throwing an `EnviousError`, errors can be logged in the console. To do so, use the `logErrors` option :
+
+```typescript
+import { envious } from '@pitininja/envious';
+import { typeboxResolver } from '@pitininja/envious-typebox';
+import { Type } from '@sinclair/typebox';
+
+const env = envious({
+    resolver: typeboxResolver({
+        schema: Type.Object({
+            STRING_VAR: Type.String()
+        })
+    }),
+    logErrors: true
+});
+```
+
+You can also provide your own logging function :
+
+```typescript
+import { envious } from '@pitininja/envious';
+import { typeboxResolver } from '@pitininja/envious-typebox';
+import { Type } from '@sinclair/typebox';
+
+const env = envious({
+    resolver: typeboxResolver({
+        schema: Type.Object({
+            STRING_VAR: Type.String()
+        })
+    }),
+    logErrors: true,
+    logger: (message) => {
+        myCustomLogger(message)
+    }
+});
+```
+
+## Errors
+
+If something goes wrong, Envious will throw an error of class `EnviousError`.
+
+An `EnviousError` error contains a message and a list of `EnviousErrorVariable`.
+
+Here is a simple example of how to handle Envious errors :
+
+```typescript
+import { envious, EnviousError } from '@pitininja/envious';
+import { typeboxResolver } from '@pitininja/envious-typebox';
+import { Type } from '@sinclair/typebox';
+
+try {
+    const env = envious({
+        resolver: typeboxResolver({
+            schema: Type.Object({
+                STRING_VAR: Type.String()
+            })
+        })
+    });
+} catch (err: unknown) {
+    if (err instanceof EnviousError) {
+        // General error message
+        console.log('Message:', err.message);
+        // Array of EnviousErrorVariable
+        console.log('Errors:', err.errors);
+        for (const { name, messages } of err.errors) {
+            // Variable name and error messages related to that variable
+            console.log(`${name} : ${messages.join(', ')}`);
+        }
+    }
+}
+```
+
+## Migration
+
+[Migration guide to v6](https://codeberg.org/pitininja/envious/src/branch/master/doc/migration-v6.md)
+
+## Legacy versions
+
+[Legacy documentation for v5 or lower](https://codeberg.org/pitininja/envious/src/branch/master/doc/legacy.md)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pitininja/envious",
-    "version": "6.0.0-beta8",
+    "version": "6.0.1",
     "license": "AGPL-3.0-or-later",
     "homepage": "https://codeberg.org/pitininja/envious",
     "repository": {
@@ -12,11 +12,12 @@
     },
     "files": [
         "./dist",
-        "./package.json"
+        "./package.json",
+        "./README.md"
     ],
-    "main": "./dist/core/src/index.js",
-    "types": "./dist/core/src/index.d.ts",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
     "scripts": {
-        "build": "npx tsgo --build --clean tsconfig.json && npx tsgo -b ./tsconfig.json"
+        "build": "npx tsgo --build --clean ./tsconfig.build.json && npx tsgo -b ./tsconfig.build.json"
     }
 }