dot-env-syncer

A Node.js module that loads .env files and sets environment variables for Polkadot projects.

Installation

npm install dot-env-syncer

Usage

Basic Usage

const { config } = require('dot-env-syncer');

// Load .env file and set environment variables
await config();

// Access environment variables
const dbHost = process.env.DB_HOST;
const apiKey = process.env.API_KEY;

With TypeScript

import { config } from 'dot-env-syncer';

const result: ConfigParsed = await config();
console.log(result.parsed);

config(options)

Loads a .env file and sets environment variables.

Parameters:

• options (Object): Configuration options
  • path (string): Path to .env file. Default: '.env'

Returns:

• Promise<ConfigParsed>: Object containing:

Example:

const { config } = require('dot-env-syncer');

// Use default .env file
const result1 = await config();

// Use custom path
const result2 = await config({ path: '.env.local' });

console.log(result2.parsed);
// {
//   "DB_HOST": "localhost",
//   "DB_PORT": "5432",
//   ...
// }

Features

• ✅ Loads .env files and sets environment variables
• ✅ Parses environment variables from .env files
• ✅ Supports quoted values (single and double quotes)
• ✅ Skips comments and empty lines
• ✅ TypeScript support with type definitions
• ✅ Only sets variables that aren't already set (dotenv behavior)
• ✅ Designed for Polkadot ecosystem

Example .env File

# Database configuration
DB_HOST=localhost
DB_PORT=5432
DB_NAME=myapp
DB_USER=admin
DB_PASSWORD=secret123

# API Keys
API_KEY=your-api-key-here
SECRET_KEY="your-secret-key"

# Feature flags
ENABLE_FEATURE_X=true
ENABLE_FEATURE_Y=false

# Polkadot Configuration
POLKADOT_RPC_URL=ws://localhost:9944
POLKADOT_CHAIN=polkadot

Parsed Format

{
  "parsed": {
    "DB_HOST": "localhost",
    "DB_PORT": "5432",
    "DB_NAME": "myapp",
    "API_KEY": "your-api-key-here"
  }
}

Error Handling

const { config } = require('dot-env-syncer');

try {
  const result = await config({ path: '.env' });
  console.log('Environment variables loaded successfully');
} catch (error) {
  console.error('Failed to load .env file:', error.message);
  // Error: .env file not found at: /path/to/.env
}

Requirements

• Node.js >= 14.0.0

License

MIT