@devaloop/devalang 0.0.1-alpha.1 → 0.0.1-alpha.10

package/templates/minimal/README.md

@@ -0,0 +1,202 @@
+<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">
+</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)
+![License: MIT](https://img.shields.io/badge/license-MIT-green)
+![Platform](https://img.shields.io/badge/platform-Windows-blue)
+
+![npm](https://img.shields.io/npm/dt/@devaloop/devalang)
+![crates](https://img.shields.io/crates/d/devalang)
+
+## 🎼 Devalang, by **Devaloop Labs**
+
+🎶 Compose music with code — simple, structured, sonic.
+
+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.
+
+From studio sketches to live sets, Devalang gives you rhythmic control — with the elegance of code.
+
+> 🚧 **v0.0.1-alpha.5 Notice** 🚧
+>
+> Currently, Devalang CLI is only available for **Windows**.  
+> Linux and macOS binaries will be added in future releases via cross-platform builds.
+
+---
+
+## 📚 Quick Access
+
+- [📖 Documentation](./docs/)
+- [💡 Examples](./examples/)
+- [🌐 Project Website](https://devalang.com)
+
+## 🚀 Features
+
+- 🎵 **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
+
+## 📆 Installation
+
+### For users
+
+> - ⚠️ Requires [Node.js 18+](https://nodejs.org/en/download)
+
+Install the package globally (NPM)
+
+```bash
+npm install -g @devaloop/devalang
+```
+
+Usage without install (NPX)
+
+```bash
+npx @devaloop/devalang <command>
+```
+
+### 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)
+
+```bash
+> git clone https://github.com/devaloop-labs/devalang.git
+> cd devalang
+> npm install
+> cargo install --path .
+```
+
+Development usage (you can customize arguments in package.json)
+
+```bash
+# For syntax checking test
+npm run rust:dev:check
+# For building test
+npm run rust:dev:build
+```
+
+## ❔ Usage
+
+NOTE: Commands are available via `devalang` or `npx @devaloop/devalang`.
+
+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.
+
+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)
+
+### Initialize a new project
+
+In the current directory
+
+```bash
+devalang init
+```
+
+Or use optional arguments to specify a directory name and a template
+
+```bash
+devalang init --name <project-name> --template <template-name>
+```
+
+### Checking syntax only
+
+```bash
+devalang check --watch
+```
+
+### Building output files
+
+```bash
+devalang build --watch
+```
+
+### Playing audio files (once by file change)
+
+```bash
+devalang play --watch
+```
+
+### Playing audio files (continuous playback, even without file changes)
+
+```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
+
+@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
+
+loop 5:
+    .customKick kickDuration {reverb=50, drive=25}
+    # Will play 5 times a kick for the duration of the kickDuration variable with reverb and drive effects
+```
+
+```deva
+# global.deva
+
+let globalBpm = 120
+let globalBank = 808
+let kickDuration = 500
+
+@export { globalBpm, globalBank, kickDuration }
+```
+
+## 🧯 Known issues
+
+- No support yet for `if`, `else`, `else if` statements
+- No support yet for `@group`, `@pattern`, `@function` statements
+- No support yet for cross-platform builds (Linux, macOS)
+
+## 🧪 Roadmap Highlights
+
+For more info, see [docs/ROADMAP.md](./docs/ROADMAP.md)
+
+- ⏳ Other statements (e.g `if`, `@group`, ...)
+- ⏳ Cross-platform support (Linux, macOS)
+- ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
+
+## 🛡️ License
+
+MIT — see [LICENSE](./LICENSE)
+
+## 🤝 Contributing
+
+Contributions, bug reports and suggestions are welcome !  
+Feel free to open an issue or submit a pull request.
+
+## 📢 Contact
+
+📧 [contact@devaloop.com](mailto:contact@devaloop.com)

package/templates/minimal/src/index.deva

@@ -0,0 +1,2 @@
+# Write your Devalang code here
+# ...

package/templates/welcome/.devalang

@@ -0,0 +1,5 @@
+[defaults]
+entry = "./src"
+output = "./output"
+watch = false
+repeat = false

package/templates/welcome/README.md

@@ -0,0 +1,202 @@
+<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">
+</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)
+![License: MIT](https://img.shields.io/badge/license-MIT-green)
+![Platform](https://img.shields.io/badge/platform-Windows-blue)
+
+![npm](https://img.shields.io/npm/dt/@devaloop/devalang)
+![crates](https://img.shields.io/crates/d/devalang)
+
+## 🎼 Devalang, by **Devaloop Labs**
+
+🎶 Compose music with code — simple, structured, sonic.
+
+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.
+
+From studio sketches to live sets, Devalang gives you rhythmic control — with the elegance of code.
+
+> 🚧 **v0.0.1-alpha.5 Notice** 🚧
+>
+> Currently, Devalang CLI is only available for **Windows**.  
+> Linux and macOS binaries will be added in future releases via cross-platform builds.
+
+---
+
+## 📚 Quick Access
+
+- [📖 Documentation](./docs/)
+- [💡 Examples](./examples/)
+- [🌐 Project Website](https://devalang.com)
+
+## 🚀 Features
+
+- 🎵 **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
+
+## 📆 Installation
+
+### For users
+
+> - ⚠️ Requires [Node.js 18+](https://nodejs.org/en/download)
+
+Install the package globally (NPM)
+
+```bash
+npm install -g @devaloop/devalang
+```
+
+Usage without install (NPX)
+
+```bash
+npx @devaloop/devalang <command>
+```
+
+### 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)
+
+```bash
+> git clone https://github.com/devaloop-labs/devalang.git
+> cd devalang
+> npm install
+> cargo install --path .
+```
+
+Development usage (you can customize arguments in package.json)
+
+```bash
+# For syntax checking test
+npm run rust:dev:check
+# For building test
+npm run rust:dev:build
+```
+
+## ❔ Usage
+
+NOTE: Commands are available via `devalang` or `npx @devaloop/devalang`.
+
+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.
+
+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)
+
+### Initialize a new project
+
+In the current directory
+
+```bash
+devalang init
+```
+
+Or use optional arguments to specify a directory name and a template
+
+```bash
+devalang init --name <project-name> --template <template-name>
+```
+
+### Checking syntax only
+
+```bash
+devalang check --watch
+```
+
+### Building output files
+
+```bash
+devalang build --watch
+```
+
+### Playing audio files (once by file change)
+
+```bash
+devalang play --watch
+```
+
+### Playing audio files (continuous playback, even without file changes)
+
+```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
+
+@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
+
+loop 5:
+    .customKick kickDuration {reverb=50, drive=25}
+    # Will play 5 times a kick for the duration of the kickDuration variable with reverb and drive effects
+```
+
+```deva
+# global.deva
+
+let globalBpm = 120
+let globalBank = 808
+let kickDuration = 500
+
+@export { globalBpm, globalBank, kickDuration }
+```
+
+## 🧯 Known issues
+
+- No support yet for `if`, `else`, `else if` statements
+- No support yet for `@group`, `@pattern`, `@function` statements
+- No support yet for cross-platform builds (Linux, macOS)
+
+## 🧪 Roadmap Highlights
+
+For more info, see [docs/ROADMAP.md](./docs/ROADMAP.md)
+
+- ⏳ Other statements (e.g `if`, `@group`, ...)
+- ⏳ Cross-platform support (Linux, macOS)
+- ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
+
+## 🛡️ License
+
+MIT — see [LICENSE](./LICENSE)
+
+## 🤝 Contributing
+
+Contributions, bug reports and suggestions are welcome !  
+Feel free to open an issue or submit a pull request.
+
+## 📢 Contact
+
+📧 [contact@devaloop.com](mailto:contact@devaloop.com)

package/templates/welcome/src/index.deva

@@ -0,0 +1,13 @@
+# 🦊 Welcome to Devalang !
+# This is your first Devalang program ?
+# Let's start with a simple example that plays a sample in a loop.
+
+@import { bpmVar, bankVar, loopVar } from './variables.deva'
+@load "../samples/kick-808.wav" as sample
+
+bpm bpmVar
+
+bank bankVar
+
+loop loopVar:
+    .sample auto

package/templates/welcome/src/variables.deva

@@ -0,0 +1,5 @@
+let bpmVar = 120
+let bankVar = 808
+let loopVar = 10
+
+@export { bpmVar, bankVar, loopVar }

package/typescript/scripts/version/fetch.ts

@@ -1,23 +1,18 @@
 import fs from "fs";
-import path from "path";
 import { execSync } from "child_process";
 
 export const fetchVersion = async (projectVersionPath: string) => {
-    // Lire le fichier
     const data = JSON.parse(fs.readFileSync(projectVersionPath, "utf-8"));
 
-    // Incrémenter le numéro de build
     data.build = (data.build || 0) + 1;
 
-    // Récupérer le dernier hash git
     try {
         const commit = execSync("git rev-parse HEAD").toString().trim();
         data.lastCommit = commit;
     } catch (err) {
-        console.warn("⚠️ Impossible de récupérer le hash git.");
+        console.warn("⚠️ Unable to fetch git commit hash. Ensure you are in a git repository.");
     }
 
-    // Écrire la mise à jour
     fs.writeFileSync(projectVersionPath, JSON.stringify(data, null, 2));
 }
 

package/examples/exported.deva

@@ -1,7 +0,0 @@
-let duration = auto
-let default_bank = 808
-let params = {decay:10, delay:30}
-let loopCount = 15
-let tempo = 155
-
-@export { duration, default_bank, params, loopCount, tempo }

package/rust/audio/mod.rs

@@ -1 +0,0 @@
-// TODO Audio engine

package/rust/cli/new.rs

@@ -1 +0,0 @@
-// TODO Implement the new command to create a new project with a template

package/rust/core/parser/at.rs

@@ -1,142 +0,0 @@
-use crate::core::types::{
-    parser::Parser,
-    statement::{ Statement, StatementKind },
-    token::TokenKind,
-    variable::VariableValue,
-};
-
-pub fn parse_at(parser: &mut Parser) -> Result<Statement, String> {
-    let token = parser.peek().ok_or("Unexpected EOF")?.clone();
-
-    if token.kind != TokenKind::At {
-        return Err(format!("Expected '@', found {:?}", token.kind));
-    }
-
-    parser.next();
-
-    let identifier_token = parser.peek().ok_or("Expected identifier after '@'")?.clone();
-    if identifier_token.kind != TokenKind::Identifier {
-        return Err(format!("Expected Identifier, found {:?}", identifier_token.kind));
-    }
-
-    match identifier_token.lexeme.as_str() {
-        "export" => {
-            parser.next();
-
-            if let Some(next_token) = parser.peek() {
-                if next_token.kind == TokenKind::LBrace {
-                    parser.next(); // Consomme le LBrace
-                }
-            }
-
-            let exportable_tokens = parser.collect_until(|t| { t.kind == TokenKind::RBrace });
-
-            exportable_tokens.iter().for_each(|t| {
-                let variable_value = parser.variable_table
-                    .get(&t.lexeme)
-                    .cloned()
-                    .unwrap_or_else(|| VariableValue::Text(t.lexeme.clone()));
-
-                parser.export_table.exports.insert(t.lexeme.clone(), variable_value);
-            });
-
-            return Ok(Statement {
-                kind: StatementKind::Export,
-                value: VariableValue::Array(exportable_tokens),
-                indent: token.indent,
-                line: token.line,
-                column: token.column,
-            });
-        }
-        "import" => {
-            parser.next();
-
-            if let Some(next_token) = parser.peek() {
-                if next_token.kind == TokenKind::LBrace {
-                    parser.next();
-                }
-            }
-
-            let importable_tokens = parser.collect_until(|t| { t.kind == TokenKind::RBrace });
-
-            parser.next();
-
-            if let Some(from_token) = parser.peek() {
-                if from_token.kind == TokenKind::Identifier && from_token.lexeme == "from" {
-                    parser.next();
-                } else {
-                    return Err(format!("Expected 'from', found {:?}", from_token.kind));
-                }
-            } else {
-                return Err("Expected 'from' after import declaration".into());
-            }
-
-            let source_token = parser.peek().ok_or("Expected source after 'from'")?.clone();
-            if source_token.kind != TokenKind::String {
-                return Err(format!("Expected String, found {:?}", source_token.kind));
-            }
-
-            let statement = Statement {
-                kind: StatementKind::Import {
-                    names: importable_tokens
-                        .iter()
-                        .map(|t| t.lexeme.clone())
-                        .collect(),
-                    source: source_token.lexeme.clone(),
-                },
-                value: VariableValue::Array(importable_tokens),
-                indent: token.indent,
-                line: token.line,
-                column: token.column,
-            };
-
-            return Ok(statement);
-        }
-        "load" => {
-            parser.next();
-
-            let source_token = parser.peek().ok_or("Expected source after load")?.clone();
-            if source_token.kind != TokenKind::String {
-                return Err(format!("Expected String, found {:?}", source_token.kind));
-            }
-
-            parser.next();
-
-            let as_token = parser.peek().ok_or("Expected 'as' after load")?.clone();
-            if as_token.kind != TokenKind::Identifier || as_token.lexeme != "as" {
-                return Err(format!("Expected 'as', found {:?}", as_token.kind));
-            }
-
-            parser.next();
-
-            let alias_token = parser.peek().ok_or("Expected alias after load")?.clone();
-            if alias_token.kind != TokenKind::Identifier {
-                return Err(format!("Expected Identifier, found {:?}", alias_token.kind));
-            }
-
-            parser.next();
-
-            let statement = Statement {
-                kind: StatementKind::Load {
-                    source: source_token.lexeme.clone(),
-                    alias: alias_token.lexeme.clone(),
-                },
-                value: VariableValue::Text(alias_token.lexeme.clone()),
-                indent: token.indent,
-                line: token.line,
-                column: token.column,
-            };
-
-            return Ok(statement);
-        }
-
-        _ => {
-            return Err(
-                format!(
-                    "Expected 'export', 'import' or 'load', found '{}'",
-                    identifier_token.lexeme
-                )
-            );
-        }
-    }
-}

package/rust/core/parser/bank.rs

@@ -1,42 +0,0 @@
-use crate::core::types::{
-    parser::Parser,
-    statement::{ Statement, StatementKind },
-    store::GlobalStore,
-    token::TokenKind,
-    variable::VariableValue,
-};
-
-pub fn parse_bank(
-    parser: &mut Parser,
-    global_store: &mut GlobalStore
-) -> Result<Statement, String> {
-    let token = parser.peek().ok_or("Unexpected EOF")?.clone();
-
-    let mut bank_name = String::new();
-
-    if parser.next().map(|t| t.kind.clone()) != Some(TokenKind::Bank) {
-        return Err("Expected 'bank' keyword".to_string());
-    }
-
-    if let Some(token) = parser.next() {
-        if token.kind == TokenKind::Identifier {
-            bank_name = token.lexeme.clone();
-        } else if token.kind == TokenKind::String {
-            bank_name = token.lexeme.trim_matches('"').to_string();
-        } else if token.kind == TokenKind::Number {
-            bank_name = token.lexeme.clone();
-        } else {
-            return Err(format!("Expected bank name, found {:?}", token.kind));
-        }
-    } else {
-        return Err("Expected bank name after 'bank' keyword".to_string());
-    }
-
-    Ok(Statement {
-        kind: StatementKind::Bank,
-        value: VariableValue::Text(bank_name.clone()),
-        indent: token.indent,
-        line: token.line,
-        column: token.column,
-    })
-}