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

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/docs/COMMANDS.md

@@ -1,31 +0,0 @@
-<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>
-
-# Devalang Commands Guide
-
-## Checking
-
-Checking syntax of .deva file(s)
-
-```bash
-devalang check --entry ./examples --output ./output
-```
-
-Available arguments :
-
-- `entry`: The input folder (default to `./src`)
-- `output`: The output folder (default to `./output`)
-
-## Building
-
-Building AST of .deva file(s)
-
-```bash
-devalang build --entry ./examples --output ./output
-```
-
-Available arguments :
-
-- `entry`: The input folder (default to `./src`)
-- `output`: The output folder (default to `./output`)

package/docs/SYNTAX.md

@@ -1,148 +0,0 @@
-<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>
-
-# Devalang Syntax Guide
-
-Devalang supports a simple and intuitive syntax for composing music and sound design. Below is a guide to the basic syntax elements, types, and usage examples.
-
-The engine is designed to be easy to read and write, allowing you to focus on your music rather than the code.
-
-The engine uses indentation to define blocks, similar to Python. Each block must be indented consistently.
-
-➡️ For full examples, check the `examples/` folder of the repository.
-
-## Types
-
-<details>
-<summary>Show available types</summary>
-
-### String
-
-Strings are defined using double quotes.
-
-```deva
-let string = "myValue"
-```
-
-### Number
-
-Numbers can be integers or floating-point values. They do not require quotes.
-
-```deva
-let number = 99
-```
-
-### Boolean
-
-Booleans can be either `true` or `false` without quotes.
-
-```deva
-let boolean = false
-```
-
-### Map
-
-Maps are key-value pairs defined using curly braces. Keys are strings, and values can be of any type (string, number, boolean, map, or array).
-
-```deva
-let map = {myKey: 99}
-```
-
-### Array
-
-Arrays are ordered lists of values defined using square brackets. Values can be of any type (string, number, boolean, map, or array).
-
-```deva
-let array = [3, 4]
-```
-
-</details>
-
-## Syntax usage
-
-### Beats Per Minute
-
-BPM is used to set the global tempo of the music.
-
-```deva
-bpm 125
-```
-
-### Sound Bank
-
-Bank is used to select a sound bank for the audio engine.
-
-```deva
-bank 808
-```
-
-### Importing / Exporting Modules
-
-Modules can be imported and exported to share variables between different files.
-
-Exporting variables from a module :
-
-```deva
-# exported.deva
-
-let exportedIterator = 10
-let exportedParams = {drive: 50, decay: 30}
-
-@export { exportedIterator, exportedParams }
-```
-
-Importing and using the exported variables in another module :
-
-```deva
-# index.deva
-
-@import { exportedIterator, exportedParams } "./exported.deva"
-
-loop exportedIterator:
-    .kick auto exportedParams
-```
-
-### Built-in triggers
-
-Usage : `.<trigger-name> <duration> <effects-map>`
-
-Other triggers will be added in future releases (e.g. `.snare`, `.hihat`, `.tom`, `.clap`, `.crash`, `.ride`, `.synth`, `.bass`, `.pad`).
-You can also create custom triggers using the `@load` directive.
-
-```deva
-.kick
-.kick 1/4
-.kick auto {reverb: 50, decay: 30}
-```
-
-### Custom triggers
-
-Same usage as built-in triggers, but with custom audio files or effects.
-
-```deva
-@load "./path/to/instrument.mp3" as mySample
-
-.mySample auto {reverb: 50, drive: 25}
-```
-
-### Let variables
-
-Variables are defined using the `let` keyword, followed by the variable name and its value. The value can be of any type (string, number, boolean, map, or array).
-
-```deva
-let number = 0
-let boolean = true
-let string = "string"
-let map = {myKey: 200}
-let array = [0, 1, 2]
-```
-
-### Basic loops
-
-Loops are defined using the `loop` keyword, followed by the number of iterations. The body of the loop is indented.
-
-```deva
-loop 10:
-    # ...
-```

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