@geisonjr/envfy v1.0.0

Easy to use, fast and lightweight library for Node.js.

!WARNING This project is under development and is not yet ready for use.

🌱 Overview

The .env files are used to define environment variables for the project. The following files are used to manage configurations for different environments, such as development, testing, and production.

This structure enables a clear and organized approach to managing configurations, making it easier to customize settings for specific environments while maintaining a consistent setup for shared configurations

✨ Features

• process.env variables
• .env and .env.local files
• .env.${NODE_ENV} and .env.${NODE_ENV}.local files
• Default, required and strict values
• Get value as array, boolean, number, string
• Get value as date, object, url

🚀 Tecnologies

The following tools were used in the construction of the project:

• Jest
• Node.js
• TypeScript

📦 Install

Use the package manager npm, yarn.

npm install @geisonjr/envfy

yarn add @geisonjr/envfy

📋 Environment Files

!TIP Both .env and .env.local files are loaded across all environments, providing a foundation for common configurations.

!IMPORTANT These base configuration files reside in the root of the project.

!IMPORTANT The prority of the environment variables is as follows:

1. process.env - default environment variables from the OS
2. .env - overrides process.env
3. .env.local - overrides .env
4. .env.${NODE_ENV} - overrides .env.local
5. .env.${NODE_ENV}.local - overrides .env.${NODE_ENV}

Base Files

.env: Default environment variables.

Environment-Specific Files

The .env* files are selected based on the NODE_ENV environment variable, allowing tailored configurations for different deployment scenarios.

.env.${NODE_ENV}: Environment-specific settings.

Example

In the following example, the .env.development file is used to define environment variables for the development environment when the NODE_ENV environment variable is set to development.

NODE_ENV=development

# .env.development
ENV_VAR_STRING=development-value
ENV_VAR_NUMBER=456

Local Overrides

The .env*.local files are used to override configurations for local development, providing a way to customize settings without affecting the shared configurations.

!CAUTION The .env*.local files are not committed to the version control system, as they are intended for local overrides. This practice ensures that the local environment settings do not interfere with the shared configurations.

🏗️ Usage

Use environment variables directly from process.env

Create a .env file in the root of your project and add your environment variables.

ENV_VAR_STRING=my-value // Can also use double quotes
ENV_VAR_NUMBER=123 // Can also use floating point numbers
ENV_VAR_BOOLEAN=true // "true", "yes", "y", "1", "on" are considered true

!TIP The following types are supported:

• array - Can also use double quotes
  • 1;2;3 or "1;2;3"
• boolean - Can also use double quotes, Case insensitive
  • Truthy: true, yes, y, 1, on.
  • Falsy: false, no, n, 0, off.
• number - Can also use double quotes
  • 123
  • 123,456.789 or 123 456.789 or 123_456.789
• string - Can also use double quotes
  • my-value or "my-value"

Import the package in your code and use the environment variables.

import '@geisonjr/envfy/config'

// Environment variables are now available in process.env
console.log(process.env.ENV_VAR_STRING) // 'my-value'
console.log(process.env.ENV_VAR_NUMBER) // '123'
console.log(process.env.ENV_VAR_BOOLEAN) // 'true'

How use the Env class

import Env from '@geisonjr/envfy'

const env = new Env()

// Get value as string
env.string('ENV_VAR_STRING') // 'my-value'
// Get value as number
env.number('ENV_VAR_NUMBER') // 123
// Get value as boolean
env.boolean('ENV_VAR_BOOLEAN') // true

How use default values

import Env from '@geisonjr/envfy'

const env = new Env()

// Get value as string with default
env.string('ENV_VAR_STRING', 'default-value') // 'my-value'
env.string('ENV_VAR_NOT_EXISTS', 'default-value') // 'default-value'
// Get value as number with default
env.number('ENV_VAR_NUMBER', 456) // 123
env.number('ENV_VAR_NOT_EXISTS', 456) // 456

How use required values

import Env from '@geisonjr/envfy'

const env = new Env({
	required: boolean, // Default: false
})

// Required "off"
env.string('ENV_VAR_STRING') // 'my-value'

// Required "on"
env.string('ENV_VAR_NOT_EXISTS') // Error: Environment variable 'ENV_VAR_NOT_EXISTS' is required

How use strict values

import Env from '@geisonjr/envfy'

const env = new Env({
	strict: boolean, // Default: false
})

// Strict "off"
env.number('ENV_VAR_STRING') // 0

// Strict "on"
env.number('ENV_VAR_STRING') // Error: Environment variable 'ENV_VAR_STRING' is not a number

📋 License

This project is under the MIT License