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

package/.devalang

@@ -0,0 +1,4 @@
+[defaults]
+entry = "./examples"
+output = "./output"
+watch = true

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "devalang"
-version = "0.0.1-alpha.1"
+version = "0.0.1-alpha.2"
 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"
@@ -42,4 +42,5 @@ serde-wasm-bindgen = "0.4"
 nom_locate = "4.0.0"
 chrono = "0.4"
 crossterm =  { version = "0.27", optional = true }
-indicatif = "0.17"
+indicatif = "0.17"
+inquire = "0.7.5"

package/README.md

@@ -41,6 +41,7 @@ From studio sketches to live sets, Devalang gives you rhythmic control — with
 - 🧩 Module system for importing and exporting variables between files (`@import`, `@export`)
 - 📜 Structured AST generation for debugging and future compilation
 - 🔢 Basic data types: strings, numbers, booleans, maps, arrays
+- 👁️ Watch mode for `build` and `check` commands
 - ⏱️ `bpm` assignment for setting tempo
 - 🧱 `bank` declaration to define the instrument set
 - 🔁 Looping system with fixed repetitions (`loop 4:`)
@@ -90,18 +91,40 @@ npm run rust:dev <command>
 
 For more examples, see [docs/COMMANDS.md](./docs/COMMANDS.md)
 
-Checking syntax only and output debug files
+### Initialize a new project
+
+In the current directory
 
 ```bash
-devalang check --entry <entry-directory> --output <output-directory>
+devalang init
 ```
 
-Building output file(s) (AST generation for the moment)
+Or use optional arguments to specify a directory name and a template
 
 ```bash
-devalang build --entry <entry-directory> --output <output-directory>
+devalang init --name <project-name> --template <template-name>
 ```
 
+### Checking syntax only and output debug files
+
+```bash
+devalang check --entry <entry-directory> --output <output-directory> --watch
+```
+
+### Building output file(s) (AST generation for the moment)
+
+```bash
+devalang build --entry <entry-directory> --output <output-directory> --watch
+```
+
+## ⚙️ 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)
@@ -127,7 +150,7 @@ loop 5:
 
 let globalBpm = 120
 let globalBank = 808
-let kickDuration = 500 
+let kickDuration = 500
 
 @export { globalBpm, globalBank, kickDuration }
 ```
@@ -145,7 +168,8 @@ For more info, see [docs/ROADMAP.md](./docs/ROADMAP.md)
 
 - ⏳ Audio engine integration
 - ⏳ Other statements (e.g `if`, `@group`, ...)
-- ⏳ Watch mode for automatic rebuilds
+- ⏳ Cross-platform support (Linux, macOS)
+- ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
 
 ## 🛡️ License
 

package/docs/CHANGELOG.md

@@ -0,0 +1,53 @@
+<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>
+
+# Changelog
+
+## Version 0.0.1-alpha.2 (2024-06-26)
+
+### Commands
+
+- Implemented `init` command to initialize a new Devalang project.
+- Implemented `template` command to manage templates.
+  - Added `list` subcommand to list available templates.
+  - Added `info` subcommand to show information about a specific template.
+- Implemented `watch` subcommand for the `build` and `check` command to watch for changes in files and automatically rebuild or check them.
+
+### Core Components
+
+- Implemented Config manager to handle configuration files.
+  - Added support for `.devalang` configuration file as a TOML file.
+  - Added support for `--no-config` flag to disable configuration file usage.
+- Implemented File System watcher to monitor file changes.
+- Implemented Template manager to handle templates and their metadata.
+- Refactored Lexer to support new syntax elements and directives.
+
+### Syntax
+
+- Added support for built-in triggers for `.snare`, `.hihat`, `.clap`, `.tom`, `.crash`, `.ride`.
+- Added support for custom triggers with `@load` using the syntax `.trigger-name`.
+
+## Version 0.0.1-alpha.1 (2024-06-25)
+
+### Syntax
+
+- Added support for `@import` directive to import other Devalang files.
+- Added support for `@export` directive to export variables and functions.
+- Added support for `@load` directive to load external resources.
+- Added support for `bpm` directive to set the beats per minute.
+- Added support for `bank` directive to define a bank of sounds.
+- Added support for `loop` directive to define loops in the code.
+
+### Commands
+
+- Implemented `check` command to check the syntax of Devalang files.
+- Implemented `build` command to build the Abstract Syntax Tree (AST) of Devalang files.
+
+### Core Components
+
+- Implemented Lexer to tokenize Devalang source code.
+- Implemented Parser to parse the tokens and build the AST.
+- Implemented Preprocessor to handle directives and preprocess the source code.
+- Implemented Debugger to debug Devalang code.
+- Implemented Builder to build the final output from the AST.

package/docs/COMMANDS.md

@@ -4,28 +4,51 @@
 
 # Devalang Commands Guide
 
+## Initialization
+
+Initialize a new Devalang project (current folder)
+
+```bash
+devalang init
+```
+
+Initialize a new Devalang project (new folder)
+
+```bash
+devalang init --name <project-name> --template <template-name>
+```
+
+Available arguments:
+
+- `--name`: The name of the project (cannot be empty)
+- `--template`: The template to use for the project (default to `welcome`)
+
 ## Checking
 
 Checking syntax of .deva file(s)
 
 ```bash
-devalang check --entry ./examples --output ./output
+devalang check --entry ./examples --output ./output --watch
 ```
 
 Available arguments :
 
-- `entry`: The input folder (default to `./src`)
-- `output`: The output folder (default to `./output`)
+- `--no-config`: Whether to ignore the configuration file (default to `false`)
+- `--entry`: The input folder (default to `./src`)
+- `--output`: The output folder (default to `./output`)
+- `--watch`: Whether to watch for changes and re-analyze (default to `false`)
 
 ## Building
 
 Building AST of .deva file(s)
 
 ```bash
-devalang build --entry ./examples --output ./output
+devalang build --entry ./examples --output ./output --watch
 ```
 
 Available arguments :
 
-- `entry`: The input folder (default to `./src`)
-- `output`: The output folder (default to `./output`)
+- `--no-config`: Whether to ignore the configuration file (default to `false`)
+- `--entry`: The input folder (default to `./src`)
+- `--output`: The output folder (default to `./output`)
+- `--watch`: Whether to watch for changes and rebuild (default to `false`)

package/docs/CONFIG.md

@@ -0,0 +1,28 @@
+<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 Configuration File
+
+Use a configuration file if you don't want to pass command-line arguments every time you run a command. The configuration file allows you to set default values for various settings, making it easier to manage your Devalang project.
+
+## Ignoring the Configuration File
+
+If you prefer not to use a configuration file, you can ignore it by passing the `--no-config` flag when running Devalang commands. This will bypass any settings defined in the configuration file and use only the command-line arguments you provide.
+
+## Structure of the Configuration File
+
+The configuration file is a TOML (Tom's Obvious, Minimal Language) file that contains key-value pairs to define various settings for your Devalang project. Below is a sample configuration file:
+
+```toml
+[defaults]
+entry = "./src"
+output = "./output"
+watch = true
+```
+
+### Available Settings
+
+- `entry`: (String) The entry point for your Devalang project
+- `output`: (String) The output directory for generated files
+- `watch`: (Boolean) Whether to watch for changes in files and automatically rebuild or check them

package/docs/ROADMAP.md

@@ -7,6 +7,7 @@
 Devalang is a work in progress. Here’s what we’re planning next:
 
 - ✅ **Basic syntax**: Implement the core syntax for Devalang, including data types and basic statements.
+- ✅ **Watch mode**: Add a watch mode to automatically rebuild on file changes.
 - ✅ **Module system**: Add support for importing and exporting variables between files using `@import` and `@export`.
 - ✅ **AST generation**: Implement the Abstract Syntax Tree (AST) generation for debugging and future compilation.
 - ✅ **Basic data types**: Support strings, numbers, booleans, maps, and arrays.
@@ -21,7 +22,6 @@ Devalang is a work in progress. Here’s what we’re planning next:
 - ⏳ **WASM support**: Compile Devalang to WebAssembly for use in web applications.
 - ⏳ **Other statements**: Implement `if`, `else`, and other control structures.
 - ⏳ **Pattern and group statements**: Add support for `@pattern` and `@group` to organize code.
-- ⏳ **Watch mode**: Add a watch mode to automatically rebuild on file changes.
 - ⏳ **Functions**: Add support for defining and calling functions.
 - ⏳ **Audio engine**: Integrate the audio engine for sound playback.
 - ⏳ **Testing**: Expand test coverage for all features.

package/docs/TODO.md

@@ -8,16 +8,19 @@ This is a list of tasks and features to be implemented in Devalang. Note that th
 
 ## Commands
 
-- [ ] New project
-- [ ] Template
-  - [ ] Implement template list
-  - [ ] Implement template info
+- [x] Init project
+  - [x] Implement init command
+  - [x] Implement template selector
+  - [ ] Implement project name validation
+- [x] Template
+  - [x] Implement template list
+  - [x] Implement template info
 - [x] Checking
-  - [ ] Implement watch mode
+  - [x] Implement watch mode
   - [ ] Implement debug mode
   - [ ] Implement compilation mode
 - [x] Building
-  - [ ] Implement watch mode
+  - [x] Implement watch mode
   - [ ] Implement debug mode
   - [ ] Implement compilation mode
   - [ ] Implement compression mode
@@ -28,6 +31,7 @@ This is a list of tasks and features to be implemented in Devalang. Note that th
 ## Core components
 
 - [ ] Audio Engine
+- [x] Configuration
 - [x] Lexer
 - [x] Parser
 - [x] Preprocessor
@@ -36,7 +40,7 @@ This is a list of tasks and features to be implemented in Devalang. Note that th
 
 ## Syntax elements
 
-- [ ] #
+- [x] #
 - [x] @import
 - [x] @export
 - [ ] @group
@@ -52,15 +56,39 @@ This is a list of tasks and features to be implemented in Devalang. Note that th
 - [ ] else
 - [ ] else if
 
-## Built-in triggers
+## Triggers
+
+### One-shot triggers
 
 - [x] .kick
-- [ ] .snare
-- [ ] .hihat
-- [ ] .tom
-- [ ] .clap
-- [ ] .crash
-- [ ] .ride
-- [ ] .synth
+- [x] .snare
+- [x] .hihat
+- [x] .tom
+- [x] .clap
+- [x] .crash
+- [x] .ride
+
+### Instrument triggers
+
+- [ ] .guitar
+- [ ] .piano
+- [ ] .flute
+- [ ] .violin
+
+### Synth & effects triggers
+
+- [ ] .lead
 - [ ] .bass
 - [ ] .pad
+- [ ] .arp
+- [ ] .fx
+- [ ] .vocal
+
+## Other TODOs
+
+- [ ] Possibility to overload built-in triggers
+- [ ] Implement a more robust error handling system
+- [ ] Replace eprintln & println with `log_message` function
+- [ ] Implement a more comprehensive logging system
+- [ ] Add unit tests for all core components
+- [ ] Comment all core components

package/examples/index.deva

@@ -6,4 +6,4 @@ bpm tempo
 bank default_bank
 
 loop loopCount:
-    .sample duration params
+    .sample duration params

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@devaloop/devalang",
   "private": false,
-  "version": "0.0.1-alpha.1",
+  "version": "0.0.1-alpha.2",
   "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.",
   "main": "out-tsc/index.js",
   "bin": {
@@ -40,4 +40,4 @@
   "dependencies": {
     "@types/node": "^24.0.3"
   }
-}
+}

package/project-version.json

@@ -1,6 +1,6 @@
 {
-  "version": "0.0.1-alpha.1",
+  "version": "0.0.1-alpha.2",
   "channel": "alpha",
-  "lastCommit": "",
-  "build": 1
+  "lastCommit": "6f92a4421db96f45c6accd6607e09876c0735531",
+  "build": 2
 }

package/rust/cli/build.rs

@@ -5,24 +5,77 @@ use crate::{
         builder::{ build_ast, write_ast_to_file },
         debugger::Debugger,
         preprocessor::module::load_all_modules,
+        types::config::DevalangConfig,
     },
     runner::executer::execute_statements,
-    utils::{ loader::with_spinner, logger::log_message, path::{ find_entry_file, normalize_path } },
+    utils::{
+        loader::with_spinner,
+        logger::log_message,
+        path::{ find_entry_file, normalize_path },
+        watcher::watch_directory,
+    },
 };
 
-pub fn handle_build_command(entry: String, output: String) {
-    let entry_file = find_entry_file(&entry).unwrap_or_else(|| {
-        eprintln!("❌ index.deva not found in directory: {}", entry);
+pub fn handle_build_command(
+    config: Option<DevalangConfig>,
+    entry: Option<String>,
+    output: Option<String>,
+    watch: bool
+) {
+    let fetched_entry = if entry.is_none() {
+        config
+            .as_ref()
+            .and_then(|c| c.defaults.entry.clone())
+            .unwrap_or_else(|| "".to_string())
+    } else {
+        entry.clone().unwrap_or_else(|| "".to_string())
+    };
+
+    let fetched_output = if output.is_none() {
+        config
+            .as_ref()
+            .and_then(|c| c.defaults.output.clone())
+            .unwrap_or_else(|| "".to_string())
+    } else {
+        output.clone().unwrap_or_else(|| "".to_string())
+    };
+
+    let fetched_watch = if watch {
+        watch
+    } else {
+        config
+            .as_ref()
+            .and_then(|c| c.defaults.watch)
+            .unwrap_or(false)
+    };
+
+    let entry_file = find_entry_file(&fetched_entry).unwrap_or_else(|| {
+        eprintln!("❌ index.deva not found in directory: {}", fetched_entry);
         std::process::exit(1);
     });
 
+    if watch == true {
+        log_message("Watch mode enabled, waiting for file changes...", "INFO");
+
+        begin_build(entry_file.clone(), fetched_output.clone(), watch);
+
+        watch_directory(entry_file.clone(), move || {
+            log_message("File change detected, rebuilding...", "INFO");
+            begin_build(entry_file.clone(), fetched_output.clone(), watch);
+        }).unwrap();
+    } else {
+        begin_build(entry_file.clone(), fetched_output.clone(), watch);
+    }
+}
+
+fn begin_build(entry: String, output: String, watch: bool) {
     let spinner = with_spinner("Building...", || {
         thread::sleep(Duration::from_millis(800));
     });
 
     let duration = std::time::Instant::now();
 
-    let normalized_entry_file = normalize_path(&entry_file);
+    let normalized_entry_file = normalize_path(&entry);
     let normalized_output_dir = normalize_path(&output);
 
     let global_store = load_all_modules(&normalized_entry_file);

package/rust/cli/check.rs

@@ -5,33 +5,89 @@ use crate::{
         debugger::Debugger,
         preprocessor::module::load_all_modules,
         types::{
-            statement::{
-                Statement,
-                StatementIterator,
-                StatementKind,
-                StatementResolved,
-                StatementResolvedValue,
-            },
-            variable::VariableValue,
+            config::{ DevalangConfig },
+            statement::{ StatementKind, StatementResolved, StatementResolvedValue },
         },
     },
     runner::executer::execute_statements,
-    utils::{ loader::with_spinner, logger::log_message, path::{ find_entry_file, normalize_path } },
+    utils::{
+        loader::with_spinner,
+        logger::log_message,
+        path::{ find_entry_file, normalize_path },
+        watcher::watch_directory,
+    },
 };
 
-pub fn handle_check_command(entry: String, output: String) -> () {
-    let entry_file = find_entry_file(&entry).unwrap_or_else(|| {
-        eprintln!("❌ index.deva not found in directory: {}", entry);
+pub fn handle_check_command(
+    config: Option<DevalangConfig>,
+    entry: Option<String>,
+    output: Option<String>,
+    watch: bool
+) -> () {
+    let fetched_entry = if entry.is_none() {
+        config
+            .as_ref()
+            .and_then(|c| c.defaults.entry.clone())
+            .unwrap_or_else(|| "".to_string())
+    } else {
+        entry.clone().unwrap_or_else(|| "".to_string())
+    };
+
+    let fetched_output = if output.is_none() {
+        config
+            .as_ref()
+            .and_then(|c| c.defaults.output.clone())
+            .unwrap_or_else(|| "".to_string())
+    } else {
+        output.clone().unwrap_or_else(|| "".to_string())
+    };
+
+    let fetched_watch = if watch {
+        watch
+    } else {
+        config
+            .as_ref()
+            .and_then(|c| c.defaults.watch)
+            .unwrap_or(false)
+    };
+
+    if fetched_entry.is_empty() {
+        eprintln!("❌ Entry path is not specified. Please provide a valid entry path.");
+        std::process::exit(1);
+    }
+
+    if fetched_output.is_empty() {
+        eprintln!("❌ Output directory is not specified. Please provide a valid output directory.");
+        std::process::exit(1);
+    }
+
+    let entry_file = find_entry_file(&fetched_entry).unwrap_or_else(|| {
+        eprintln!("❌ index.deva not found in directory: {}", fetched_entry);
         std::process::exit(1);
     });
 
+    if fetched_watch.clone() == true {
+        log_message("Watch mode enabled, waiting for file changes...", "INFO");
+
+        begin_check(entry_file.clone(), fetched_output.clone(), fetched_watch.clone());
+
+        watch_directory(entry_file.clone(), move || {
+            log_message("File change detected, rebuilding...", "INFO");
+            begin_check(entry_file.clone(), fetched_output.clone(), fetched_watch.clone());
+        }).unwrap();
+    } else {
+        begin_check(entry_file.clone(), fetched_output.clone(), fetched_watch.clone());
+    }
+}
+
+fn begin_check(entry: String, output: String, watch: bool) {
     let spinner = with_spinner("Checking...", || {
         thread::sleep(Duration::from_millis(800));
     });
 
     let duration = std::time::Instant::now();
 
-    let normalized_entry_file = normalize_path(&entry_file);
+    let normalized_entry_file = normalize_path(&entry);
     let normalized_output_dir = normalize_path(&output);
 
     let global_store = load_all_modules(&normalized_entry_file);
@@ -45,9 +101,9 @@ pub fn handle_check_command(entry: String, output: String) -> () {
         let debug_dir = format!("{}/debug/", normalized_output_dir.clone());
         debugger.write_files(debug_dir.as_str(), resolved_statements.clone());
 
-        let has_errors = resolved_statements.iter().any(|stmt| {
-            match_error_recursively_resolved(&stmt.clone())
-        });
+        let has_errors = resolved_statements
+            .iter()
+            .any(|stmt| { match_error_recursively_resolved(&stmt.clone()) });
 
         if has_errors {
             let warning_message = format!(
@@ -109,7 +165,7 @@ fn match_error_recursively_resolved_value(value: &StatementResolvedValue) -> boo
                 }
             }
         }
-        
+
         StatementResolvedValue::Array(array) => {
             for item in array {
                 if match_error_recursively_resolved(item) {

package/rust/cli/init.rs

@@ -0,0 +1,77 @@
+use std::{ fs, path::Path };
+use include_dir::{ include_dir, Dir };
+use inquire::{ Select, Confirm };
+
+use crate::{ cli::template::{ get_available_templates }, utils::file::copy_dir_recursive };
+
+static TEMPLATES_DIR: Dir = include_dir!("$CARGO_MANIFEST_DIR/templates");
+
+pub fn handle_init_command(name: Option<String>, template: Option<String>) {
+    let current_dir = std::env::current_dir().unwrap();
+    let project_name = name
+        .clone()
+        .unwrap_or_else(|| {
+            current_dir.file_name().unwrap_or_default().to_string_lossy().to_string()
+        });
+
+    // Select a template if not provided
+    let selected_template = template.unwrap_or_else(|| {
+        Select::new("Select a template for your project:", get_available_templates())
+            .prompt()
+            .unwrap_or_else(|_| {
+                eprintln!("No template selected. Exiting...");
+                std::process::exit(1);
+            })
+    });
+
+    if selected_template.is_empty() {
+        eprintln!("Template cannot be empty.");
+        std::process::exit(1);
+    }
+
+    if name.is_none() {
+        // Case of initialization in the current directory
+        if fs::read_dir(&current_dir).unwrap().next().is_some() {
+            let confirm = Confirm::new(
+                "The current directory is not empty. Do you want to continue?"
+            )
+                .with_default(false)
+                .prompt()
+                .unwrap_or(false);
+
+            if !confirm {
+                eprintln!("Operation cancelled by the user.");
+                std::process::exit(0);
+            }
+        }
+
+        scaffold_project_current_dir(current_dir.as_path(), selected_template);
+        println!(
+            "✅ Initialized '{}' project in current directory: {}",
+            project_name,
+            current_dir.display()
+        );
+    } else {
+        // Case of initialization in a new directory
+        let target_path = current_dir.join(&project_name);
+
+        if target_path.exists() {
+            eprintln!("❌ A folder named '{}' already exists.", project_name);
+            std::process::exit(1);
+        }
+
+        fs::create_dir_all(&target_path).expect("Error creating project directory");
+
+        scaffold_project_current_dir(&target_path, selected_template);
+        println!("✅ Initialized '{}' project in: {}", project_name, target_path.display());
+    }
+}
+
+fn scaffold_project_current_dir(path: &Path, template: String) {
+    let template_dir = TEMPLATES_DIR.get_dir(&template).unwrap_or_else(|| {
+        eprintln!("❌ The template '{}' doesn't exist.", template);
+        std::process::exit(1);
+    });
+
+    copy_dir_recursive(template_dir, path, &template_dir.path());
+}

package/rust/cli/mod.rs

@@ -1,3 +1,4 @@
 pub mod check;
-pub mod new;
+pub mod init;
 pub mod build;
+pub mod template;