mle-tools-configuration

A configuration management tool for TypeScript/JavaScript applications

🚀 Features

• 🔧 Type-safe configuration management
• 🔄 Dynamic configuration updates
• 🎯 Domain-based configuration organization
• 🛠 JSON-based configuration storage
• 📦 Easy integration with existing projects
• 🔍 Comprehensive documentation with Memory Bank

📦 Installation

npm install mle-tools-configuration

🎯 Quick Start

import { Configuration, configurationFactory } from 'mle-tools-configuration';

// Set up initial configuration
configurationFactory.setUp(
  [{ key: 'database', value: { host: 'localhost', port: 5432 } }],
  [{ domain: 'app', keys: ['database'] }]
);

// Get configuration instance
const config = configurationFactory.getConfiguration();

// Access configuration values
const dbConfig = config.getSubConf('database');
console.log(dbConfig); // { host: 'localhost', port: 5432 }

// Merge new configuration
config.merge({
  database: { username: 'admin' }
});

📚 Documentation

Memory Bank

This project uses a Memory Bank for comprehensive documentation and context retention. The Memory Bank is located in the .memory-bank directory and contains the following files:

• memory-bank-rules.md: Rules to follow and to consider in all contexts
• projectbrief.md: Overview of the project, core requirements, and goals
• productContext.md: Why the project exists, problems it solves, and how it works
• systemPatterns.md: System architecture, key technical decisions, and design patterns
• techContext.md: Technologies used, development setup, and technical constraints
• activeContext.md: Current work focus, recent changes, and next steps
• progress.md: What works, what's left to build, and known issues

=> !! These files should always be considered as a context and keep up-to-date !!

🔧 API Reference

Configuration Class

• getJSON(domain?): Get the entire configuration as a JSON string
• getSubJSON(key): Get a specific configuration section as a JSON string
• getConf(domain?): Get the configuration object
• getSubConf(key): Get a specific configuration section
• contains(configurationAsString): Check if configuration contains the specified configuration
• merge(conf): Merge new configuration
• set(key, value): Set a specific configuration value
• add(key, value): Add to existing configuration
• update(factory): Update the configuration factory

ConfigurationFactory

• setUp(configs, domains): Initialize the configuration factory
• getConfiguration(override?): Get a configuration instance

🧪 Testing

npm test

📝 Changelog

See CHANGELOG.md for a detailed list of changes.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

🙏 Acknowledgments

• Built with TypeScript
• Tested with Mocha and Chai
• Coverage with NYC