How ro80t/envl works
Project type and purpose
• This is an open-source, multi-language toolchain—a monorepo providing a domain-specific “Environment Language” (envl) with:
– A core Rust library for parsing, representing, and generating code/configurations (packages/envl, envl-config, envl-vars, envl-codeblock, envl-utils)
– A Rust-based CLI (packages/envl-cli)
– A JavaScript/TypeScript package (packages/envl-js)
• Purpose: define, validate, and generate code/config from a typed, structured .envl DSL.
File structure
Top-level “packages” directory contains self-contained crates/packages:
• envl – core generator library
• envl-config – parser/lexer for .envlconf settings/vars
• envl-vars – parser for typed variable definitions
• envl-codeblock – runtime support & codeblock embedding
• envl-utils – shared helpers (error handling, naming, casing)
• envl-cli – command-line interface wrapping the core crates
• envl-js – JS/TS wrapper integrating core functionality in Node
Common patterns:
• Each crate has src/lib.rs (public API), src/parser & src/lexer (for parsing stages), tests, and Cargo.toml
• The core crate (envl) depends on config, vars, codeblock, utils
README for additional insights
• It shows syntax examples (.envl and .envlconf files)
• It enumerates the available packages and their roles (Rust lib, CLI, JS)
Main components & their relationships
a. Components
1. Input files (.envl, .envlconf)
2. envl-config & envl-vars (lexing → parsing .envlconf DSL)
3. Core AST & validation (shared types in envl)
4. envl-codeblock (runtime embedding, code-block evaluation support)
5. envl-utils (shared helpers)
6. Code generator (packages/envl/src/generator) → emits target code (Rust, potentially others)
7. User-facing layers:
• envl-cli (CLI binary)
• envl-js (JavaScript/TypeScript package)
8. Output: generated code or runtime execution results
b. Relationships & data flow
– CLI or JS layer accepts user input (.envl, .envlconf)
– Delegates to envl-config and envl-vars for parsing → produces an abstract model (AST, Config structs)
– Core envl library uses that model + codeblock runtime to generate code or execute values
– envl-utils supports error formatting, naming conventions at each stage
– Generated artifacts are returned to user (console, file, in-memory JS object)
c. Architectural patterns & principles
• Modular crates: single responsibility (parsing, validation, generation, CLI, JS)
• “Front controller” at CLI/JS layer
• Pipeline style: Lexing → Parsing → AST → Generation/Runtime
• Shared utility library prevents duplication
d. Key technologies
• Rust (core crates, CLI)
• Node.js/TypeScript (envl-js)
• Cargo monorepo with workspaces
• tsup/ESLint/Prettier for JS packaging