0xwaleed / confy

Load yaml configuration. 📄

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.

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
}

confy's Issues

Add CI