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

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.

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch main on the remote Git repository with URL https://[secure]@github.com/unterdrueckt/easy-conf-manager.

This can be caused by:

a misconfiguration of the repositoryUrl option
the repository being unavailable
or missing push permission for the user configured via the Git credentials on your CI environment

Good luck with your project ✨

Your semantic-release bot 📦🚀

unterdrueckt / easy-conf-manager Goto Github PK