@romaintaillandier1978/dotenv-never-lies 0.3.0 → 1.1.0

package/dist/cli/utils/toFile.js

@@ -0,0 +1,8 @@
+import { ExportError } from "../../errors.js";
+import fs from "node:fs";
+export const toFile = async (content, path, force = false) => {
+    if (fs.existsSync(path) && !force) {
+        throw new ExportError(`${path} already exists. Use --force to overwrite.`);
+    }
+    fs.writeFileSync(path, content);
+};

package/dist/core.d.ts

@@ -1,41 +1,41 @@
 import { z } from "zod";
 /**
- * Un objet contenant les variables d'environnement sous forme de string, issue d'un fichier .env ou de process.env.
+ * An object containing environment variables as strings, coming from a .env file or from process.env.
  */
 export type EnvSource = Record<string, string | undefined>;
 /**
- * Une variable d'environnement.
+ * An environment variable.
  */
 export interface EnvVarDefinition<T extends z.ZodType = z.ZodType> {
     /**
-     * Le schéma Zod de la variable d'environnement.
+     * The Zod schema of the environment variable.
      */
     schema: T;
     /**
-     * La description de la variable d'environnement.
+     * The description of the environment variable.
      */
     description: string;
     /**
-     * Indique si la variable d'environnement est secrète (pour les token, les mots de passe), RFU.
+     * Whether the environment variable is secret (for tokens, passwords), reserved for future use (RFU).
      */
     secret?: boolean;
     /**
-     * Indique des exemple pour cette variable
+     * Provides examples for this variable.
      */
     examples?: string[];
 }
 /**
- * Un objet contenant les variables d'environnement définies.
+ * An object containing the defined environment variables.
  */
 export type EnvDefinition = Record<string, EnvVarDefinition<any>>;
 /**
- * Le shape Zod du schéma d'environnement.
+ * The Zod shape of the environment schema.
  */
 export type ZodShapeFromEnv<T extends EnvDefinition> = {
     [K in keyof T & string]: T[K]["schema"];
 };
 /**
- * Le type inféré du schéma d'environnement.
+ * The inferred type of the environment schema.
  */
 export type InferEnv<T extends EnvDefinition> = {
     [K in keyof T & string]: z.infer<T[K]["schema"]>;
@@ -47,60 +47,60 @@ type AssertFn<T extends EnvDefinition> = (options?: {
     source?: EnvSource | undefined;
 }) => InferEnv<T>;
 /**
- * Un objet contenant les fonctions pour vérifier, charger et afficher les variables d'environnement.
- * @template T - Le schéma d'environnement à définir.
+ * An object containing functions to check and assert environment variables.
+ * @template T - The environment schema to define.
  */
 export type EnvDefinitionHelper<T extends EnvDefinition> = {
     /**
-     * Le schéma d'environnement défini.
+     * The defined environment schema.
      */
     def: T;
     /**
-     * Le shape Zod du schéma d'environnement.
+     * The Zod shape of the environment schema.
      */
     zodShape: ZodShapeFromEnv<T>;
     /**
-     * Le schéma Zod du schéma d'environnement.
+     * The Zod schema of the environment schema.
      */
     zodSchema: z.ZodObject<ZodShapeFromEnv<T>>;
     /**
-     * Vérifie si les variables d'environnement sont valides sans lever d'exception.
+     * Checks whether the environment variables are valid without throwing.
      *
-     * Si `options.source` est fourni, il est utilisé avec le mode strict (zod.strict())
-     * Si `options.source` est fourni, on utilise `process.env`, en mode non strict
+     * If `options.source` is provided, it is used with strict mode (zod.strict()).
+     * Otherwise, `process.env` is used in non-strict mode.
      *
-     * @param options - Les options pour vérifier les variables d'environnement.
-     * @returns true si les variables d'environnement sont valides, false sinon.
+     * @param options - Options to check the environment variables.
+     * @returns true if the environment variables are valid, false otherwise.
      */
     check: CheckFn;
     /**
-     * Vérifie les variables d'environnement et arrête le process si elle ne sont pas conformes au schéma.
+     * Validates the environment variables and throws if they do not conform to the schema.
      *
-     * Si `options.source` est fourni, il est utilisé avec le mode strict (zod.strict())
-     * Si `options.source` est fourni, on utilise `process.env`, en mode non strict
+     * If `options.source` is provided, it is used with strict mode (zod.strict()).
+     * Otherwise, `process.env` is used in non-strict mode.
      *
-     * @param options - Les options pour charger les variables d'environnement.
-     * @returns Les variables d'environnement chargées.
-     * @throws Si les variables d'environnement sont invalides.
+     * @param options - Options to load the environment variables.
+     * @returns The loaded environment variables.
+     * @throws If the environment variables are invalid.
      */
     assert: AssertFn<T>;
 };
 /**
- * Définit un schéma d'environnement.
- * @param def - Le schéma d'environnement à définir.
- * @returns Un objet contenant les fonctions pour vérifier, charger et afficher les variables d'environnement.
+ * Defines an environment schema.
+ * @param def - The environment schema to define.
+ * @returns An object exposing functions to check and assert environment variables.
  */
 export declare const define: <T extends EnvDefinition>(def: T) => EnvDefinitionHelper<T>;
 /**
- * Lit un fichier .env et retourne les variables d'environnement sous forme d'objet.
- * Utilise dotenv et dotenv-expand.
+ * Reads a .env file and returns environment variables as an object.
+ * Uses dotenv and dotenv-expand.
  * @example
  * ```typescript
  * const ENV = envDefinition.load({ source: readEnvFile(".env") });
  * ```
- * @param path - Le chemin vers le fichier .env.
- * @returns Les variables d'environnement sous forme d'objet.
- * @throws Si le fichier .env n'existe pas, ou n'est pas conforme
+ * @param path - The path to the .env file.
+ * @returns The environment variables as an object.
+ * @throws If the .env file does not exist, or is not valid.
  */
 export declare const readEnvFile: (path: string) => EnvSource;
 export {};

package/dist/core.js

@@ -1,12 +1,12 @@
 import { z } from "zod";
 import dotenv from "dotenv";
 import dotenvExpand from "dotenv-expand";
-import { EnvFileNotFoundError } from "./errors.js";
+import { DnlError, ExitCodes } from "./errors.js";
 import fs from "fs";
 /**
- * Définit un schéma d'environnement.
- * @param def - Le schéma d'environnement à définir.
- * @returns Un objet contenant les fonctions pour vérifier, charger et afficher les variables d'environnement.
+ * Defines an environment schema.
+ * @param def - The environment schema to define.
+ * @returns An object exposing functions to check and assert environment variables.
  */
 export const define = (def) => {
     const zodShape = Object.fromEntries(Object.entries(def).map(([key, value]) => [key, value.schema]));
@@ -29,19 +29,19 @@ export const define = (def) => {
     return { def, zodShape, zodSchema, check, assert };
 };
 /**
- * Lit un fichier .env et retourne les variables d'environnement sous forme d'objet.
- * Utilise dotenv et dotenv-expand.
+ * Reads a .env file and returns environment variables as an object.
+ * Uses dotenv and dotenv-expand.
  * @example
  * ```typescript
  * const ENV = envDefinition.load({ source: readEnvFile(".env") });
  * ```
- * @param path - Le chemin vers le fichier .env.
- * @returns Les variables d'environnement sous forme d'objet.
- * @throws Si le fichier .env n'existe pas, ou n'est pas conforme
+ * @param path - The path to the .env file.
+ * @returns The environment variables as an object.
+ * @throws If the .env file does not exist, or is not valid.
  */
 export const readEnvFile = (path) => {
     if (!fs.existsSync(path)) {
-        throw new EnvFileNotFoundError(path);
+        throw new DnlError(`Env file not found: ${path}`, ExitCodes.usageError);
     }
     const content = fs.readFileSync(path);
     const parsed = dotenv.parse(content);

package/dist/errors.d.ts

@@ -1,4 +1,31 @@
-export declare class EnvFileNotFoundError extends Error {
-    constructor(path: string);
+export declare enum ExitCodes {
+    success = 0,
+    usageError = 1,
+    schemaNotFound = 2,
+    validationError = 3,
+    exportError = 4
+}
+export declare class DnlError extends Error {
+    readonly exitCode: ExitCodes;
+    constructor(message: string, exitCode: ExitCodes);
+}
+export declare class UsageError extends DnlError {
+    constructor(message: string);
+}
+export declare class SchemaNotFoundError extends DnlError {
+    constructor(message: string);
+}
+export declare class ValidationError extends DnlError {
+    readonly issues?: {
+        key: string;
+        message: string;
+    }[] | undefined;
+    constructor(message: string, issues?: {
+        key: string;
+        message: string;
+    }[] | undefined);
+}
+export declare class ExportError extends DnlError {
+    constructor(message: string);
 }
 //# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,oBAAqB,SAAQ,KAAK;gBAC/B,IAAI,EAAE,MAAM;CAI3B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACjB,OAAO,IAAI;IACX,UAAU,IAAI;IACd,cAAc,IAAI;IAClB,eAAe,IAAI;IACnB,WAAW,IAAI;CAClB;AAED,qBAAa,QAAS,SAAQ,KAAK;aAGX,QAAQ,EAAE,SAAS;gBADnC,OAAO,EAAE,MAAM,EACC,QAAQ,EAAE,SAAS;CAI1C;AACD,qBAAa,UAAW,SAAQ,QAAQ;gBACxB,OAAO,EAAE,MAAM;CAG9B;AACD,qBAAa,mBAAoB,SAAQ,QAAQ;gBACjC,OAAO,EAAE,MAAM;CAG9B;AAED,qBAAa,eAAgB,SAAQ,QAAQ;aAGrB,MAAM,CAAC,EAAE;QACrB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;KACnB,EAAE;gBAJH,OAAO,EAAE,MAAM,EACC,MAAM,CAAC,EAAE;QACrB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;KACnB,EAAE,YAAA;CAIV;AAED,qBAAa,WAAY,SAAQ,QAAQ;gBACzB,OAAO,EAAE,MAAM;CAG9B"}

package/dist/errors.js

@@ -1,6 +1,35 @@
-export class EnvFileNotFoundError extends Error {
-    constructor(path) {
-        super(`Env file not found: ${path}`);
-        this.name = "EnvFileNotFoundError";
+export var ExitCodes;
+(function (ExitCodes) {
+    ExitCodes[ExitCodes["success"] = 0] = "success";
+    ExitCodes[ExitCodes["usageError"] = 1] = "usageError";
+    ExitCodes[ExitCodes["schemaNotFound"] = 2] = "schemaNotFound";
+    ExitCodes[ExitCodes["validationError"] = 3] = "validationError";
+    ExitCodes[ExitCodes["exportError"] = 4] = "exportError";
+})(ExitCodes || (ExitCodes = {}));
+export class DnlError extends Error {
+    constructor(message, exitCode) {
+        super(message);
+        this.exitCode = exitCode;
+    }
+}
+export class UsageError extends DnlError {
+    constructor(message) {
+        super(message, ExitCodes.usageError);
+    }
+}
+export class SchemaNotFoundError extends DnlError {
+    constructor(message) {
+        super(message, ExitCodes.schemaNotFound);
+    }
+}
+export class ValidationError extends DnlError {
+    constructor(message, issues) {
+        super(message, ExitCodes.validationError);
+        this.issues = issues;
+    }
+}
+export class ExportError extends DnlError {
+    constructor(message) {
+        super(message, ExitCodes.exportError);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@romaintaillandier1978/dotenv-never-lies",
-    "version": "0.3.0",
+    "version": "1.1.0",
     "description": "Typed, validated, and explicit environment variables — powered by Zod.",
     "license": "MIT",
     "author": "Romain TAILLANDIER",
@@ -9,6 +9,14 @@
         "type": "git",
         "url": "https://github.com/romaintaillandier1978/dotenv-never-lies"
     },
+    "scripts": {
+        "build": "tsc",
+        "pack": "rm -rf dist && yarn build && npm pack --pack-destination ./dist",
+        "pack:check": "npm pack --dry-run",
+        "release:patch": "npm version patch",
+        "release:minor": "npm version minor",
+        "release:major": "npm version major"
+    },
     "keywords": [
         "env",
         "environment",
@@ -42,14 +50,6 @@
     "bin": {
         "dnl": "./dist/cli/index.js"
     },
-    "scripts": {
-        "build": "tsc",
-        "prepublishOnly": "npm test && npm run build",
-        "test": "yarn build &&  node dist/DnlTest.js",
-        "dev": "tsx src/cli/index.ts",
-        "devold": "yarn build && node dist/cli/index.js",
-        "gen": "rm -rf dist; rm dotenv-never-lies-v*.tgz; yarn build && yarn pack"
-    },
     "peerDependencies": {
         "zod": ">=4.2.1"
     },