lorenwest/node-config
Node Config
node-config is a configuration manager for Node.js applications that loads, merges, and manages application settings across different deployment environments. It functions as a hierarchical configuration loader that defines default settings and overrides them based on the environment, hostname, or instance ID.
The project provides an environment variable mapper to link external variables and command line arguments to internal configuration structures. It also includes an external configuration client to fetch settings from remote providers during the bootstrap process.
The system supports custom configuration directory specifications and the injection of external parsers for non-standard file formats. It includes a validation framework to ensure required configuration files are present before the application starts and allows for runtime configuration mutation to override immutability during testing.
Features
- Hierarchical Configuration Systems - Implements a hierarchical configuration system that defines default settings and overrides them for specific deployment environments.
- Hierarchical Configuration Overrides - Implements a priority-based hierarchy for merging default settings with environment, hostname, or instance-specific overrides.
- Environment Variable Mappers - Maps system-level environment variables and command line arguments to internal application configuration structures.
- Environment Variable Mapping - Overrides internal configuration structure values by mapping them to specific external environment variable names.
- Configuration Variable Overrides - Updates configuration values using environment variables or command line parameters without modifying source files.
- Environment-Based Path Resolution - Determines which environment-specific configuration files to load by matching filesystem paths against system environment variables.
- Loading Order Strategies - Selects and merges specific configuration files based on environment variables, hostname, and instance ID.
- Deployment Stage Management - Handles distinct configuration sets for development, staging, and production deployments to ensure consistent behavior.
- External Configuration Clients - Provides a client to fetch application settings from remote providers during the bootstrap process.
- Node.js Application Configurations - Manages application settings across different environments by merging default values with environment-specific overrides for Node.js apps.
- Hierarchical Configuration Overrides - Combines multiple JSON files into a single configuration object by overriding default settings with environment-specific values.
- Remote Data Fetching - Provides a client to fetch application settings from external network providers during the bootstrap process.
- Remote Configuration Retrieval - Reads application settings from a remote provider during the bootstrap process and merges them into the local configuration.
- External Configuration Loading - Fetches application settings from remote providers or environment variables during the bootstrap process to decouple code from config.
- Dynamic Configuration Updates - Updates application behavior at startup using command line arguments or environment variable mapping.
- Custom Configuration Parsers - Allows the injection of custom modules to read and decode configuration files in non-standard formats.
- Parsing Configuration Files - Supports the use of external modules to handle the reading and parsing of non-standard configuration file formats.
- Deployment Startup Validation - Ensures required configuration files are present and correctly loaded before a Node.js application starts in production.
- Configuration Validation - Ensures required configuration keys and values are present and valid during the application startup sequence.
- Startup Configuration Validation - Throws an exception during startup if required configuration files for the current environment are missing.
- Configuration Management - Configuration management for Node.js applications.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
