easy-conf-manager

A lightweight and easy-to-use configuration manager.

Features

• Human-Readable Config File: Utilize a configuration file format inspired by TOML.
• Dynamic Comment Support: Comments in the config file can be added programmatically.
• Default Values: Set default values for configuration options, ensuring your application gracefully falls back to predefined settings.
• Simple API: Enjoy a straightforward API with methods for effortlessly setting, getting, and managing configuration values.
• TypeScript Support: Written in TypeScript, providing full type safety.
• Dynamic Key Management: Easily add custom keys and dynamically manage configurations, adapting to your application's evolving needs.

Installation

Install easy-conf-manager:

npm install easy-conf-manager

or

pnpm add easy-conf-manager

Usage

import globalConfigManager from "easy-conf-manager";

// Set a configuration value
globalConfigManager.set("AppSettings.apiKey", "api-key");

// Get a configuration value
const apiKey = globalConfigManager.get("AppSettings.apiKey");
console.log("API Key:", apiKey);

// Modify a configuration value and adding a comment
globalConfigManager.set(
  "AppSettings.apiKey",
  "your-api-key",
  "This is is the setting for your app api key."
);

auto generates the config.conf file in /config:

[AppSettings]
# This is is the setting for your app api key.
apiKey="your-api-key"

Default Configuration

You can set default values through default.conf in /config:

[AppSettings]
appKey="your-default-value"

License

This project is licensed under the MIT License.