https://github.com/0xwal/confy

Load yaml configuration. 📄
https://github.com/0xwal/confy

server yaml-configuration

Last synced: 6 months ago
JSON representation

Load yaml configuration. 📄

• Host: GitHub
• URL: https://github.com/0xwal/confy
• Owner: 0xwal
• License: mit
• Created: 2022-03-26T18:24:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-04-02T21:55:53.000Z (about 4 years ago)
• Last Synced: 2025-01-30T03:43:42.121Z (over 1 year ago)
• Topics: server, yaml-configuration
• Language: Dart
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
confy to load YAML based configuration file.

## Why

I love yaml <3

## Features

* Load global configuration file `.confy.yaml` or `.confy.yml`.

* Load specific configuration file conditionally based. `.confy.prod.yml` or `.confy.dev.yml`.

## Usage

1. Add your global configuration `.confy.yml` in the same dart application directory.

2. Optionally add another envy file to override specific environment keys `.confy.prod.yml`.

3. Load Confy as follows.

```dart

import "package:confy/confy.dart";

main() {

  // to load configuration files global and another one based on APP_ENV environment.

  confyLoad(environmentResolver: () => Platform.environment["APP_ENV"]);

  print("name ${confy("NAME")}");

  print("description ${confy("DESC")}");

  print("environment path: ${confy("PATH")}"); // from System Environment set ./examples/.confy.yml

  final v = confy("APP.VERSION");

  final appVersion = "${v?["MAJOR"]}.${v?["MINOR"]}.${v?["PATCH"]}";

  print("app version: $appVersion");

  print("key not exist ${confy("MY_SECRET", defaultValue: 123)}");

  confySet("NAME", "Edited"); // useful when doing unit testing

  print("name ${confy("NAME")}");

  // ... your code

}

```