@devaloop/devalang 0.0.1-alpha.8 → 0.0.1-beta.1

package/.cargo/config.toml

@@ -0,0 +1,2 @@
+[target.wasm32-unknown-unknown]
+rustflags = ["--cfg", "getrandom_backend=\"wasm_js\""]

package/.devalang

@@ -1,4 +1,10 @@
-[defaults]
-entry = "./examples"
-output = "./output"
-watch = false
+[defaults]
+entry = "./examples"
+output = "./output"
+watch = false
+debug = true
+compress = true
+
+[[banks]]
+path = "devalang://bank/devaloop.808"
+version = "0.0.1"

package/.github/workflows/ci.yml

@@ -0,0 +1,103 @@
+name: CI & Release
+
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build binaries
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            bin_ext: ""
+          - os: macos-latest
+            target: x86_64-apple-darwin
+            bin_ext: ""
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+            bin_ext: ".exe"
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install ALSA (Linux)
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libasound2-dev pkg-config
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          target: ${{ matrix.target }}
+
+      - name: NPM Install
+        run: npm install
+
+      - name: Build TS
+        run: npx tsc
+
+      - name: Build release
+        run: cargo build --release --target ${{ matrix.target }}
+
+      - name: Ensure out-tsc/bin exists (Unix)
+        if: runner.os != 'Windows'
+        run: mkdir -p out-tsc/bin
+
+      - name: Ensure out-tsc/bin exists (Windows)
+        if: runner.os == 'Windows'
+        shell: pwsh
+        run: |
+          New-Item -ItemType Directory -Force out-tsc/bin | Out-Null
+
+      - name: Copy binary (Unix)
+        if: runner.os != 'Windows'
+        run: cp target/${{ matrix.target }}/release/devalang${{ matrix.bin_ext }} out-tsc/bin/devalang-${{ matrix.target }}${{ matrix.bin_ext }}
+
+      - name: Copy binary (Windows)
+        if: runner.os == 'Windows'
+        shell: pwsh
+        run: |
+          Copy-Item "target\${{ matrix.target }}\release\devalang${{ matrix.bin_ext }}" "out-tsc\bin\devalang-${{ matrix.target }}${{ matrix.bin_ext }}" -Force
+
+      - name: Upload artifact (CI)
+        uses: actions/upload-artifact@v4
+        with:
+          name: devalang-${{ matrix.target }}
+          path: out-tsc/bin/*
+
+  release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Download all build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          pattern: devalang-*
+          merge-multiple: true
+
+      - name: List files
+        run: ls -la dist
+
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*

package/Cargo.toml

@@ -1,48 +1,80 @@
-[package]
-name = "devalang"
-version = "0.0.1-alpha.8"
-authors = ["Devaloop <contact@devaloop.com>"]
-description = "Write music like code. Devalang is a domain-specific language (DSL) for sound designers and music hackers. Compose, automate, and control sound — in plain text."
-license = "MIT"
-repository = "https://github.com/devaloop-labs/devalang"
-keywords = ["music", "dsl", "audio", "cli"]
-categories = ["command-line-utilities", "development-tools", "parser-implementations"]
-readme = "README.md"
-homepage = "https://devalang.com"
-documentation = "https://docs.devalang.com/"
-license-file = "LICENSE"
-edition = "2024"
-
-[[bin]]
-name = "devalang"
-path = "rust/main.rs"
-required-features = ["cli"]
-
-[lib]
-path = "rust/lib.rs"
-crate-type = ["cdylib"]
-
-[profile.release]
-opt-level = "s"
-
-[features]
-default = ["cli"]
-cli = ["crossterm", "indicatif", "inquire"]
-
-[dependencies]
-clap = { version = "4.5", features = ["derive"] }
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
-rodio = "0.17"
-hound = "3.4.0"
-toml = "0.8"
-notify = "6.1"
-fs_extra = "1.3"
-include_dir = "0.7"
-wasm-bindgen = "0.2"
-serde-wasm-bindgen = "0.4"
-nom_locate = "4.0.0"
-chrono = "0.4"
-crossterm =  { version = "0.27", optional = true }
-indicatif = { version = "0.17", optional = true }
-inquire = { version = "0.7.5", optional = true }
+[package]
+name = "devalang"
+version = "0.0.1-beta.1"
+authors = ["Devaloop <contact@devaloop.com>"]
+description = "Write music like code. Devalang is a domain-specific language (DSL) for sound designers and music hackers. Compose, automate, and control sound — in plain text."
+license = "MIT"
+repository = "https://github.com/devaloop-labs/devalang"
+keywords = ["music", "dsl", "audio", "cli"]
+categories = ["command-line-utilities", "development-tools", "parser-implementations"]
+readme = "README.md"
+homepage = "https://devalang.com"
+documentation = "https://docs.devalang.com/"
+edition = "2024"
+
+[[bin]]
+name = "devalang"
+path = "rust/main.rs"
+
+[lib]
+name = "devalang_core"
+path = "rust/lib.rs"
+crate-type = ["cdylib", "rlib"]
+
+[profile.release]
+opt-level = "s"
+
+[features]
+default = ["cli"]
+cli = ["crossterm", "indicatif", "inquire", "zip", "reqwest", "flate2", "tokio"]
+
+[dependencies]
+devalang_types = { path = "rust/types", version = "0.0.2" }
+clap = { version = "4.5", features = ["derive"] }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+rodio = "0.17"
+hound = "3.4.0"
+toml = "0.8"
+notify = "6.1"
+fs_extra = "1.3"
+include_dir = "0.7"
+wasm-bindgen = "0.2"
+serde-wasm-bindgen = "0.4"
+nom_locate = "4.0.0"
+chrono = "0.4"
+crossterm =  { version = "0.27", optional = true }
+indicatif = { version = "0.17", optional = true }
+inquire = { version = "0.7.5", optional = true }
+js-sys = "0.3"
+getrandom = { version = "0.3", features = ["wasm_js"] }
+reqwest = { version = "0.12.22", optional = true, features = ["json"] }
+flate2 = { version = "1.0", optional = true }
+tokio = { version = "1", features = ["full"], optional = true }
+zip = { version = "4.3.0", optional = true }
+rayon = "1.10.0"
+webbrowser = "0.8"
+tiny_http = "0.9.0"
+dirs = "5"
+urlencoding = "2.1"
+uuid = { version = "1.18.0", features = ["v4"] }
+console_error_panic_hook = "0.1.7"
+
+[dev-dependencies]
+assert_cmd = "2"
+predicates = "2"
+tempfile = "3"
+
+# For wasm32, enable wasm-friendly randomness backends and avoid
+# pulling in native-only CLI dependencies.
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+getrandom = { version = "0.3", features = ["wasm_js"] }
+uuid = { version = "1.18.0", features = ["v4", "js", "rng-getrandom"] }
+# Keep a lightweight linkage to the utils crate for wasm builds without
+# enabling native CLI features.
+devalang_utils = { path = "rust/utils", default-features = false, version = "0.0.1" }
+
+# devalang_utils with CLI and wasmtime are only needed for native targets.
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+devalang_utils = { path = "rust/utils", features = ["cli"], version = "0.0.1" }
+wasmtime = "19"

package/README.md

@@ -1,231 +1,204 @@
 <div align="center">
-    <img src="https://firebasestorage.googleapis.com/v0/b/devaloop-labs.firebasestorage.app/o/devalang-teal-logo.svg?alt=media&token=d2a5705a-1eba-4b49-88e6-895a761fb7f7" alt="Devalang Logo">
+    <img src="https://devalang.com/images/devalang-logo-min.png" alt="Devalang Logo" width="100" />
 </div>
 
 ![Rust](https://img.shields.io/badge/Made%20with-Rust-orange?logo=rust)
 ![TypeScript](https://img.shields.io/badge/Built%20with-TypeScript-blue?logo=typescript)
 ![Node.js](https://img.shields.io/badge/Node.js-18%2B-brightgreen?logo=node.js)
 
-![Project Status](https://img.shields.io/badge/status-alpha-red)
-![Version](https://img.shields.io/badge/version-0.0.1-blue)
+![Project Status](https://img.shields.io/badge/status-beta-blue)
+![Version](https://img.shields.io/npm/v/@devaloop/devalang)
 ![License: MIT](https://img.shields.io/badge/license-MIT-green)
-![Platform](https://img.shields.io/badge/platform-Windows-blue)
+
+![Linux](https://img.shields.io/badge/linux-supported-blue?logo=linux)
+![macOS](https://img.shields.io/badge/macOS-supported-blue?logo=apple)
+![Windows](https://img.shields.io/badge/windows-supported-blue?logo=windows)
 
 ![npm](https://img.shields.io/npm/dt/@devaloop/devalang)
 ![crates](https://img.shields.io/crates/d/devalang)
 
-[![VSCode Extension](https://img.shields.io/visual-studio-marketplace/v/devaloop.devalang-vscode?label=VSCode%20Extension)](https://marketplace.visualstudio.com/items?itemName=devaloop.devalang-vscode)
-
-## 🎼 Devalang, by **Devaloop Labs**
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/devaloop-labs/devalang/.github/workflows/ci.yml)
 
-🎶 Compose music with code — structured, expressive, and fast.
+# 🦊 Devalang (CORE) — Compose music with code
 
 Devalang is a tiny domain-specific language (DSL) for music makers, sound designers, and audio hackers.
 Compose loops, control samples, render and play audio — all in clean, readable text.
 
-🦊 Whether you're building a track, shaping textures, or performing live, Devalang helps you think in rhythms. It’s designed to be simple, expressive, and fast — because your ideas shouldn’t wait.
+Whether you're building a track, shaping textures, or performing live, Devalang helps you think in rhythms. It’s designed to be simple, expressive, and fast — because your ideas shouldn’t wait.
 
 From studio sketches to live sets, Devalang gives you rhythmic control — with the elegance of code.
 
-> 🚧 **v0.0.1-alpha.8 Notice** 🚧
+> **🚧 Notice 🚧**
 >
-> NEW: Devalang VSCode extension is now available !
-> [Get it here](https://marketplace.visualstudio.com/items?itemName=devaloop.devalang-vscode).
+> Includes synthesis, playback, and rendering features, but is still in early development, and breaking changes may occur.
 >
-> NEW: Devalang supports conditional statements (`if`, `else`, `else if`) for more dynamic compositions !
+> **NEW**: [Devaforge is now available for creating addons](https://github.com/devaloop-labs/devaforge).
 >
-> Currently, Devalang CLI is only available for **Windows**.  
-> Linux and macOS binaries will be added in future releases via cross-platform builds.
-
----
+> **NEW**: Now available for Windows, Linux, and macOS.
 
 ## 📚 Quick Access
 
-- [📖 Documentation](./docs/)
-- [💡 Examples](./examples/)
+- [▶️ Playground](https://playground.devalang.com)
+- [📖 Documentation](https://docs.devalang.com)
 - [🧩 VSCode Extension](https://marketplace.visualstudio.com/items?itemName=devaloop.devalang-vscode)
 - [🎨 Prettier Plugin](https://www.npmjs.com/package/@devaloop/prettier-plugin-devalang)
+- [📜 Changelog](./docs/CHANGELOG.md)
+- [💡 Examples](./examples/)
 - [🌐 Project Website](https://devalang.com)
+- [📦 Devaforge on npm](https://www.npmjs.com/package/@devaloop/devaforge)
+- [📦 Devalang on npm](https://www.npmjs.com/package/@devaloop/devalang)
 
-## ❓ Why Devalang?
+## ⏱️ Try it now !
 
-- 🎹 Prototype audio ideas without opening a DAW
-- 💻 Integrate sound into code-based workflows
-- 🎛️ Control audio parameters through readable syntax
-- 🧪 Build musical logic with variables and conditions
+### Try Devalang in your browser
 
-> Producer, coder, or both — Devalang gives you musical structure, instantly.
+> [Have a look at the Playground to try Devalang directly in your browser](https://playground.devalang.com)
 
-## 🚀 Features
+### Try Devalang in your terminal
 
-- 🎵 **Audio Engine**: Integrated audio playback and rendering
-- 🧩 **Module system** for importing and exporting variables between files
-- 📜 **Structured AST** generation for debugging and future compilation
-- 🔢 **Basic data types**: strings, numbers, booleans, maps, arrays
-- 👁️ **Watch mode** for `build`, `check` and `play` commands
-- 📂 **Project templates** for quick setup
-- 🎛️ **Custom samples**: easily load and trigger your own audio files
-- 🔄 **Looping and grouping**: create complex patterns with ease
-
-## 📆 Installation
-
-### For users
-
-> - ⚠️ Requires [Node.js 18+](https://nodejs.org/en/download)
-
-Install the package globally (NPM)
+#### With Node.js
 
 ```bash
 npm install -g @devaloop/devalang@latest
 ```
 
-Usage without install (NPX)
-
-```bash
-npx @devaloop/devalang@latest
-```
-
-### For contributors
-
-> - ⚠️ Requires [Node.js 18+](https://nodejs.org/en/download)
-> - ⚠️ Requires [Rust 1.70+](https://www.rust-lang.org/learn/get-started#installing-rust)
+#### With Rust
 
 ```bash
-git clone https://github.com/devaloop-labs/devalang.git
-
-cd devalang
-
-npm install
+cargo install devalang
 ```
 
-Development usage (you can customize arguments in package.json)
+#### Initialize a new project
 
 ```bash
-# For syntax checking test
-npm run rust:dev:check
-
-# For building test
-npm run rust:dev:build
+devalang init --name my-project --template minimal
 ```
 
-## ❔ Usage
-
-NOTE: Commands are available via `devalang` or `npx @devaloop/devalang`.
+#### Write your first script
 
-NOTE: Arguments can be passed to commands using `--<argument>` syntax. You can also use a configuration file to set default values for various settings, making it easier to manage your Devalang project.
+Create a new Devalang file `src/index.deva` in the project directory:
 
-NOTE: Some commands require a mandatory `--entry` argument to specify the input folder, and a `--output` argument to specify the output folder. If not specified, they default to `./src` and `./output` respectively.
-
-For more examples, see [docs/COMMANDS.md](./docs/COMMANDS.md)
+```deva
+# src/index.deva
 
-### Initialize a new project
+# BPM definition
+bpm 125
 
-In the current directory
+# Bank picking (make sure you've installed it)
+bank devaloop.808 as my808Bank
 
-```bash
-devalang init
-```
+# Pattern literal without options
+pattern kickPattern with my808Bank.kick = "x--- x--- x--- x---"
 
-Or use optional arguments to specify a directory name and a template
-
-```bash
-devalang init --name <project-name> --template <template-name>
+group myGroup:
+    # Rhythmic (each beat playing a kick)
+    # on beat:
+    #     .my808Bank.kick 1/4
+
+    # Synth definition with ADSR
+    let myLead = synth sine {
+        attack: 0,
+        decay: 100,
+        sustain: 100,
+        release: 100
+    }
+
+    # Global automation
+    automate myLead:
+        param volume {
+            0% = 0.0
+            100% = 0.5
+        }
+        param pitch {
+            0% = -12.0
+            100% = 12.0
+        }
+
+    # Notes in a loop with condition
+    for i in [1, 2, 3]:
+        if i == 3:
+            myLead -> note(C5, { duration: 200 })
+            print "Playing note C5 for " + i
+
+    # Pause runtime for 500ms
+    sleep 500
+
+    # Note with automation
+    myLead -> note(C4, {
+        duration: 400,
+        velocity: 0.8,
+        automate: {
+            pan: {
+                0%: -1.0,
+                100%: 0.0
+            }
+        }
+    })
+
+    # Notes with params
+    myLead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
+    myLead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
+
+# Spawning the group & the pattern to play them in parallel
+spawn myGroup
+spawn kickPattern
 ```
 
-### Checking syntax only
-
-```bash
-devalang check --watch
-```
+### And the best part ? You can play it directly from the command line:
 
-### Building output files
+#### Play the script once
 
 ```bash
-devalang build --watch
+devalang play
 ```
 
-### Playing audio files (once by file change)
-
-```bash
-devalang play --watch
-```
-
-### Playing audio files (continuous playback, even without file changes)
+#### **LIVE mode** (repeat the playback + watch mode)
 
 ```bash
 devalang play --repeat
 ```
 
-## ⚙️ Configuration
-
-You can use a configuration file to set default values for various settings, making it easier to manage your Devalang project.
-
-To do this, create a `.devalang` file in the root of your project directory.
-
-See [docs/CONFIG.md](./docs/CONFIG.md) for more information.
-
-## 📄 Syntax example
-
-For more examples, see [docs/SYNTAX.md](./docs/SYNTAX.md)
-
-```deva
-# index.deva
+### 🎉 You can now hear your Devalang code in action
 
-@import { globalBpm, globalBank, kickDuration } from "global.deva"
-
-@load "./examples/samples/kick-808.wav" as customKick
-
-bpm globalBpm
-# Will declare the tempo at the globalBpm variable beats per minute
-
-bank globalBank
-# Will declare a custom instrument bank using the globalBank variable
-
-# Loops
-
-loop 5:
-    .customKick kickDuration {reverb=50, drive=25}
-    # Will play 5 times a custom sample for 500ms with reverb and overdrive effects
-
-# Groups
-
-group myGroup:
-    .customKick kickDuration {reverb=50, drive=25}
-    # Will play the same sample in a group, allowing for more complex patterns
+> For more examples, check out the [examples directory](./examples/)
 
-# Will be executed line by line (sequentially)
-call myGroup
+## ❓ Why Devalang ?
 
-# Will be executed in parallel (concurrently)
-# ⚠️ Note: `spawn` runs the entire group in parallel, but the group’s internal logic remains sequential unless it uses `spawn` internally.
-# spawn myGroup
-```
-
-> 🧠 Note: `call` and `spawn` only work with `group` blocks. They do not apply to individual samples or other statements.
-
-```deva
-# variables.deva
-
-let globalBpm = 120
-let globalBank = 808
-let kickDuration = 500
-
-@export { globalBpm, globalBank, kickDuration }
-```
-
-## 🧯 Known issues
-
-- No smart modules yet, all groups, variables, and samples must be explicitly imported where used
-- No support yet for `pattern`, `function`, ... statements
-- No support yet for cross-platform builds (Linux, macOS)
-
-## 🧪 Roadmap Highlights
+- 🎹 Prototype audio ideas without opening a DAW, even VSCode with our Playground
+- 💻 Integrate sound into code-based workflows
+- 🎛️ Control audio parameters through readable syntax
+- 🧪 Build musical logic with variables and conditions
+- 🔄 Create complex patterns with ease
 
-For more info, see [docs/ROADMAP.md](./docs/ROADMAP.md)
+## 🚀 Features
 
-- ⏳ Other statements (e.g `function`, `pattern`, ...)
-- ⏳ Cross-platform support (Linux, macOS)
-- ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
+- ⚡ **Fast Build & Hot Reload** — optimized build process for quicker iteration.
+- 🎵 **Audio Engine & Real-time runner** — low-latency playback, render-to-file, and a realtime runner used by `devalang play` for live feedback.
+- ▶️ **Live mode (watch + repeat)** — edit and hear changes instantly with `devalang play --repeat` and watch mode.
+- 🧩 **Language primitives** — synths, notes, ADSR, maps, arrays, loops, conditionals and functions for expressive musical logic.
+- 🎛️ **Per-note automation & modulators** — `automate` maps, `$mod.*`, `$easing.*` and `$math.*` helpers for envelopes and LFOs.
+- 🧩 **Module system & structured AST** — import/export variables, stable AST output for debugging and tooling.
+- 🧰 **Plugins & Addons (WASM-ready)** — install plugins/banks, `@use` directive, and WASM plugin integration so plugins can render or process audio at runtime.
+- 📦 **Addon manager & Devaforge** — CLI commands to discover/install banks, plugins and templates; `devaforge` helps create addons.
+- ⚙️ **CLI tooling** — `build`, `check`, `play`, `install`, `init`, `discover`, `telemetry` and more with consistent flags (`--watch`, `--debug`, `--compress`).
+- 📂 **Project templates & examples** — quick-start templates and many example projects in `examples/`.
+- 🧑‍💻 **TypeScript API & WASM distribution** — Node-friendly package with TypeScript bindings and a WASM build for browser/Node usage.
+- 🧰 **Editor & formatting support** — VSCode extension and Prettier plugin to edit Devalang with syntax and formatting support.
+- 🎵 **Custom samples & banks** — drop samples into `.deva` and reference them from code; banks of sounds for fast composition.
+- 🔄 **Looping, grouping & scheduling** — precise beat-tied scheduling primitives for complex rhythmic patterns.
+
+## 📄 Documentation
+
+### [Please refer to the online documentation](https://docs.devalang.com) for detailed information on syntax, features, and usage examples
+
+## 📰 What's new
+
+- **Devaforge**: Introduced a new system for creating and managing addons, including a CLI for addon generation.
+- **Documentation updates**: Improved documentation for clarity and completeness.
+- **Discovering addons**: Introduced a new command to detect addons.
+- **Public TypeScript API**: Added a public TypeScript API for easier integration.
+- **Improved error messages**: Enhanced error messages for better debugging.
+- **Bug fixes**: Various bug fixes and stability improvements.
 
 ## 🛡️ License
 
@@ -236,6 +209,10 @@ MIT — see [LICENSE](./LICENSE)
 Contributions, bug reports and suggestions are welcome !  
 Feel free to open an issue or submit a pull request.
 
+For more info, see [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md).
+
 ## 📢 Contact
 
+Feel free to reach out for any inquiries or feedback.
+
 📧 [contact@devaloop.com](mailto:contact@devaloop.com)