@safe-hand/safe-env-check 1.0.2 → 1.0.3

package/.github/workflows/release.yml

@@ -0,0 +1,34 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Publish to npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --access public
+
+      - name: Create GitHub Release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ github.ref_name }}

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)  
+and [Semantic Versioning](https://semver.org/).
+
+---
+
+## [Unreleased]
+
+### Added
+
+- Placeholder for upcoming changes
+
+---
+
+## [1.0.3] - 2026-02-18
+
+### Added
+
+- Initial CHANGELOG.md for tracking
+- Release workflow setup
+
+## [1.0.2] - 2026-02-18
+
+### Added
+
+- Initial npm release (version already existed)
+- Schema-based environment validation
+- CLI support
+- Strict mode
+- TypeScript support
+- Support for types: `string`, `number`, `boolean`, `enum`
+- Required and default value support
+
+### Fixed
+
+- None yet

package/README.md

@@ -1,19 +1,51 @@
 # safe-env-check
 
-A tiny TypeScript library to validate environment variables with schema, strict mode, dotenv and CLI support.
+![npm](https://img.shields.io/npm/v/@safe-hand/safe-env-check)
+![license](https://img.shields.io/npm/l/@safe-hand/safe-env-check)
+![downloads](https://img.shields.io/npm/dm/@safe-hand/safe-env-check)
 
-## Install
 
+A tiny TypeScript library to validate environment variables using a schema with support for:
+
+- ✅ Type validation
+- ✅ Required & default values
+- ✅ Enum values
+- ✅ Strict mode (no extra env vars)
+- ✅ dotenv integration
+- ✅ Custom error formatting
+- ✅ CLI support
+
+---
+
+## Installation
+
+```bash
+npm install @safe-hand/safe-env-check
+```
+or
 ```bash
-npm install safe-env-check
+yarn add @safe-hand/safe-env-check
 ```
 
-## Usage
+## Features
+
+- Validate process.env using a schema
+
+- Strongly typed output (TypeScript)
+
+- Prevents app startup with invalid configuration
+
+- Supports CLI for CI/CD and deployment checks
+
+- Customizable error messages
+
+- Optional strict mode to disallow unknown variables
 
-```js
-import { validateEnv } from "safe-env-check";
+## Basic Usage
 
-const env = validateEnv({
+### Define a schema
+```ts
+const schema = {
   PORT: { type: "number", required: true },
   JWT_SECRET: { type: "string", required: true },
   NODE_ENV: {
@@ -21,38 +53,77 @@ const env = validateEnv({
     values: ["development", "production"],
     default: "development",
   },
-});
+};
 ```
 
-**With Strict Mode**
+### Validate environment variables
+```ts
+import { validateEnv } from "@safe-hand/safe-env-check";
 
-```js
-validateEnv(schema, { strict: true });
+const env = validateEnv(schema);
+
+console.log(env.PORT);       // number
+console.log(env.NODE_ENV);   // "development" | "production"
+```
+
+## Schema Options
+Each environment variables supports the following options:
+
+| Field      | Type       | Description                      |           |         |                     |
+| ---------- | ---------- | -------------------------------- | --------- | ------- | ------------------- |
+| `type`     | `"string"  or "number" or "boolean" or "enum"` | Expected value type |
+| `required` | `boolean`  | Whether the variable is required |           |         |                     |
+| `default`  | `any`      | Default value if not provided    |           |         |                     |
+| `values`   | `string[]` | Required for `enum` type         |           |         |                     |
+
+## Example
+```ts
+DATABASE_URL: { type: "string", required: true },
+DEBUG: { type: "boolean", default: false },
+MODE: { type: "enum", values: ["dev", "prod"] }
 ```
 
-**With Custom Error Formatter**
+## Strict Mode
+Disallow environment variables that are not defined in the schema.
+```ts
+validateEnv(schema, { strict: true });
+```
+If extra variables are found, validation will fail.
 
-```js
+## Custom Error Formatter
+You can control how errors are displayed:
+```ts
 validateEnv(schema, {
   formatError: (errors) => `Config error:\n${errors.join("\n")}`,
 });
 ```
 
-## CLI
+## Dotenv Support
+
+By default, the library loads .env automatically using dotenv.
+
+Example .env file:
+```bash
+PORT=3000
+JWT_SECRET=supersecret
+NODE_ENV=development
+```
 
-Create a file called env.schema.js
+## CLI Usage
 
-```js
+Create a schema file called env.schema.js:
+```ts
 module.exports = {
   PORT: { type: "number", required: true },
-  NODE_ENV: { type: "enum", values: ["dev", "prod"] },
+  NODE_ENV: { type: "enum", values: ["dev", "prod"], default: "dev" },
 };
 ```
 
+Run validation:
 ```bash
 npx safe-env-check env.schema.js
 ```
 
 ## License
 
-MIT © Shakhawat Hossain
+MIT © Shakhawat Hossain

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@safe-hand/safe-env-check",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {