dotenv

Environment variable (.env) parser, interpolation, and configuration loader for the Alya Programming Language.

---

🌟 Features

• ⚡ Lightweight & Fast: Fast lexical parsing and configuration loading
• 📄 File & In-Memory Support: Load .env from disk or parse arbitrary strings
• 🛡️ Quoted & Escaped Strings: Supports single (') and double (") quotes, escaped newlines and tabs
• 💬 Inline Comments: Automatically strips trailing # comments outside quotes
• 🔄 Variable Interpolation: Expands ${VAR} references using parsed values and OS environment
• 🎯 Type-Safe Getters: Safe conversions to string, int, bool, and float with custom fallbacks
• 🧰 Dump Support: Export parsed environment maps back to .env formatted text

---

📁 Project Architecture

dotenv/
├── alya.toml               # Package manifest
├── src/
│   ├── lib.alya            # Public API facade
│   ├── parser.alya         # Lexical line parser, quote/escape, interpolation
│   ├── serializer.alya     # .env text serializer (dump)
│   └── getters.alya        # Type-safe value extractors
├── examples/
│   └── demo.alya           # Runnable usage example
├── tests/
│   └── test_basic.alya     # Automated test suite
└── benches/
    └── bench_basic.alya    # Micro-benchmarks

---

📦 Installation

Add dotenv to the [dependencies] section in your alya.toml:

[dependencies]
dotenv = { git = "https://github.com/alya-lang/dotenv", branch = "main" }

Or install it directly using the Alya package CLI:

alya add dotenv --git https://github.com/alya-lang/dotenv --branch main
alya install

Package Features

Feature	Default	Description
io	✅	File loading (load_file, load, dotenv_load*, load_env). Without it only in-memory parse/dump/getters remain.

# Full build (default)
alya install
alya test

# Slim build without file loading
alya install --no-default-features
alya test --no-default-features

---

🚀 Quick Start

Create a .env file in your project root:

# Application Settings
APP_NAME=AlyaService
PORT=8080
DEBUG=true
MAX_RETRIES=5

# Database URL with interpolation
DB_HOST=127.0.0.1
DB_PORT=5432
DATABASE_URL="postgres://${DB_HOST}:${DB_PORT}/prod_db"

Load and read configuration in your Alya application:

import "dotenv" as dotenv

function main()
    # 1. Load .env file
    let config = dotenv::load()

    # 2. Access typed values with fallback defaults
    let app_name = dotenv::get(config, "APP_NAME", "DefaultApp")
    let port = dotenv::get_int(config, "PORT", 3000)
    let is_debug = dotenv::get_bool(config, "DEBUG", 0)
    let db_url = dotenv::get(config, "DATABASE_URL")

    say "Starting " + app_name + " on port " + str(port)
    say "Database: " + db_url
    if is_debug == 1
        say "[DEBUG MODE ACTIVE]"
    end
end

main()

---

📖 API Reference

Loading & Parsing

Function	Arguments	Returns	Description
load()	None	Map	Loads .env from cwd (or .env.local), parses and returns a configuration map.
load_file(path)	path: string	Map	Reads the file at path and returns a parsed configuration map.
parse(content)	content: string	Map	Parses raw multi-line .env string content into a key-value map.
dump(env_map)	env_map: Map	string	Formats an environment map back into valid .env string syntax.

Accessors & Typed Getters

Function	Arguments	Returns	Description
get(map, key, default)	map, key: string, default = ""	string	Returns string value, or default if missing or empty.
get_int(map, key, default)	map, key: string, default = 0	int	Parses integer value, or returns default.
get_bool(map, key, default)	map, key: string, default = 0	int (0/1)	Evaluates "true", "1", "yes", "on" to 1, and "false", "0", "no", "off" to 0.
get_float(map, key, default)	map, key: string, default = 0.0	float	Parses floating-point value, or returns default.
has(map, key)	map, key: string	int (0/1)	Returns 1 if key is present in map, 0 otherwise.

---

🧪 Running Tests & Benchmarks

Run the automated test suite:

alya test

Run the performance micro-benchmarks:

alya run benches/bench_basic.alya

Run the runnable usage demo:

alya run examples/demo.alya

Check code formatting:

alya fmt . --check

Run static code linter:

alya lint . --check

---

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository and clone it locally
2. Install dependencies:

   alya install

3. Create your feature branch (git checkout -b feature/my-feature)
4. Verify tests and formatting before opening a PR:

   alya test
   alya fmt . --check

5. Commit your changes (git commit -m "feat: add feature") and open a Pull Request

---

📄 License

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