Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@yasserfedsi/envfy",
"version": "0.1.0",
"version": "0.2.0",
"description": "A simple, type-safe environment variable validator for Node.js applications",
"type": "module",
"main": "./dist/index.cjs",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export { validateEnv } from "./validateEnv";
export type { Schema, PrimitiveType } from "./validateEnv";
export type { Schema, PrimitiveType, EnumType } from "./validateEnv";
16 changes: 14 additions & 2 deletions src/validateEnv.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
import { parseBoolean, parseNumber, parseString } from "./validators";
import {
parseBoolean,
parseNumber,
parseString,
parseEnum,
} from "./validators";

export type PrimitiveType = "string" | "number" | "boolean";

export type Schema = Record<string, PrimitiveType>;
export type EnumType = readonly string[];

export type Schema = Record<string, PrimitiveType | EnumType>;

export function validateEnv(schema: Schema) {
const result: Record<string, unknown> = {};
Expand All @@ -16,6 +23,11 @@ export function validateEnv(schema: Schema) {
throw new Error(`Missing environment variable: ${key}`);
}

if (Array.isArray(rule)) {
result[key] = parseEnum(key, value, rule);
continue;
}

switch (rule) {
case "string":
result[key] = parseString(value);
Expand Down
12 changes: 12 additions & 0 deletions src/validators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,15 @@ export function parseBoolean(key: string, value: string): boolean {
export function parseString(value: string): string {
return value;
}

export function parseEnum(
key: string,
value: string,
allowedValues: readonly string[],
): string {
if (!allowedValues.includes(value)) {
throw new Error(`${key} must be one of: ${allowedValues.join(", ")}`);
}

return value;
}
21 changes: 21 additions & 0 deletions tests/validate.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,32 @@ describe("validateEnv", () => {
});
}).toThrow();
});

test("validates enum values", () => {
process.env.NODE_ENV = "development";

const env = validateEnv({
NODE_ENV: ["development", "production", "test"],
});

expect(env.NODE_ENV).toBe("development");
});

test("throws on invalid enum", () => {
process.env.NODE_ENV = "staging";

expect(() =>
validateEnv({
NODE_ENV: ["development", "production", "test"],
}),
).toThrow("NODE_ENV must be one of");
});
});

beforeEach(() => {
delete process.env.NAME;
delete process.env.PORT;
delete process.env.DEBUG;
delete process.env.MISSING;
delete process.env.NODE_ENV;
});
Loading