@devaloop/devalang 0.0.1-alpha.15 → 0.0.1-alpha.16

package/templates/welcome/README.md

@@ -1,5 +1,5 @@
 <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)
@@ -7,184 +7,156 @@
 ![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)
+![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)
 
 ![npm](https://img.shields.io/npm/dt/@devaloop/devalang)
 ![crates](https://img.shields.io/crates/d/devalang)
 
-## 🎼 Devalang, by **Devaloop Labs**
+[![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)
 
-🎶 Compose music with code — simple, structured, sonic.
+# 🦊 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.5 Notice** 🚧
+> 🚧 Alpha Notice 🚧
 >
-> Currently, Devalang CLI is only available for **Windows**.  
+> Includes synthesis, playback, and rendering features, but is still in early development.
+>
+> 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/)
+- [▶️ 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)
+- [📦 Devalang CLI on npm](https://www.npmjs.com/package/@devaloop/devalang)
 
-## 🚀 Features
+## ⏱️ Try it now !
 
-- 🎵 **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
+### Try Devalang in your browser
 
-## 📆 Installation
+> Have a look at the [Playground](https://playground.devalang.com) to try Devalang directly in your browser
 
-### For users
-
-> - ⚠️ Requires [Node.js 18+](https://nodejs.org/en/download)
-
-Install the package globally (NPM)
+### Try Devalang CLI
 
 ```bash
+# Install Devalang CLI globally
 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
+# Create a new Devalang project
+devalang init --name my-project --template minimal
+cd my-project
 ```
 
-Or use optional arguments to specify a directory name and a template
+Create a new Devalang file `src/index.deva` in the project directory:
 
-```bash
-devalang init --name <project-name> --template <template-name>
-```
-
-### Checking syntax only
-
-```bash
-devalang check --watch
+```deva
+# src/index.deva
+
+group main:
+    let lead = synth sine {
+        attack: 0,
+        decay: 100,
+        sustain: 100,
+        release: 100
+    }
+
+    # Global automation for this synth (applies to subsequent notes)
+    automate lead:
+        param volume {
+            0% = 0.0
+            100% = 1.0
+        }
+        param pan {
+            0% = -1.0
+            100% = 1.0
+        }
+        param pitch {
+            0% = -12.0
+            100% = 12.0
+        }
+
+    lead -> note(C4, {
+        duration: 400,
+        velocity: 0.8,
+        automate: { pan: { 0%: -1.0, 100%: 0.0 } }
+    })
+
+    lead -> note(E4, { duration: 400 })
+    lead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
+    lead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
+
+    for i in [1, 2, 3]:
+        lead -> note(C5, { duration: 200 })
+
+# Play the lead
+
+call main
 ```
 
-### Building output files
+### And the best part ? You can play it directly from the command line:
 
 ```bash
-devalang build --watch
-```
-
-### Playing audio files (once by file change)
+# Play the Devalang file
+devalang play
 
-```bash
+# Play the Devalang file with watch mode
 devalang play --watch
-```
 
-### Playing audio files (continuous playback, even without file changes)
-
-```bash
+# LIVE mode (repeat the playback + watch mode)
 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
+### 🎉 You can now hear your Devalang code in action
 
-For more examples, see [docs/SYNTAX.md](./docs/SYNTAX.md)
+> For more examples, check out the [examples directory](./examples/)
 
-```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
+## ❓ Why Devalang ?
 
-bank globalBank
-# Will declare a custom instrument bank using the globalBank variable
+- 🎹 Prototype audio ideas without opening a DAW, even VSCode
+- 💻 Integrate sound into code-based workflows
+- 🎛️ Control audio parameters through readable syntax
+- 🧪 Build musical logic with variables and conditions
+- 🔄 Create complex patterns with ease
 
-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
-```
+## 🚀 Features
 
-```deva
-# global.deva
+- 🎵 **Audio Engine**: Integrated audio playback and rendering
+- 🧩 **Module system** for importing and exporting variables between files
+- 📦 **Addon manager** for managing external banks, plugins and more
+- 📜 **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
 
-let globalBpm = 120
-let globalBank = 808
-let kickDuration = 500
+## 📄 Documentation
 
-@export { globalBpm, globalBank, kickDuration }
-```
+### Please refer to the [online documentation](https://docs.devalang.com) for detailed information on syntax, features, and usage examples
 
 ## 🧯 Known issues
 
-- No support yet for `if`, `else`, `else if` statements
-- No support yet for `@group`, `@pattern`, `@function` statements
+- No smart modules yet, all groups, variables, and samples must be explicitly imported where used
 - 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`, ...)
+- ⏳ Other statements (e.g `function`, `pattern`, ...)
 - ⏳ Cross-platform support (Linux, macOS)
 - ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
 
@@ -197,6 +169,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)

package/typescript/bin/index.ts

@@ -1,14 +1,28 @@
 #!/usr/bin/env node
 
 import { spawn } from "child_process";
-import path from "path";
+import * as path from "path";
 
-const binaryPath = path.join(__dirname, "devalang.exe");
+let binaryName: string;
 
-const subCommand = process.argv[2] || "help";
+switch (process.platform) {
+  case "win32":
+    binaryName = "devalang-x86_64-pc-windows-msvc.exe";
+    break;
+  case "darwin":
+    binaryName = "devalang-x86_64-apple-darwin";
+    break;
+  case "linux":
+    binaryName = "devalang-x86_64-unknown-linux-gnu";
+    break;
+  default:
+    console.error(`Unsupported platform: ${process.platform}`);
+    process.exit(1);
+}
+
+const binaryPath = path.join(__dirname, binaryName);
 
 const args = process.argv.slice(2);
 const child = spawn(binaryPath, args, { stdio: "inherit" });
 
-
-child.on("exit", (code) => process.exit(code));
+child.on("exit", (code) => process.exit(code ?? 1));

package/typescript/index.ts

@@ -1 +1,3 @@
-// This file is part of the Devalang project
+/**
+ * TypeScript wrapper for Devalang.
+ */

package/typescript/scripts/postbuild.ts

@@ -1,8 +1,12 @@
-import fs from "fs";
-import path from "path";
+/**
+ * NOTE: This script is deprecated since we use Github Actions
+ */
 
-const source = path.join(__dirname, "..", "..", "target", "release", "devalang.exe");
-const destination = path.join(__dirname, "..", "bin", "devalang.exe");
+// import fs from "fs";
+// import path from "path";
 
-fs.copyFileSync(source, destination);
-fs.chmodSync(destination, 0o755); 
+// const source = path.join(__dirname, "..", "..", "target", "release", "devalang.exe");
+// const destination = path.join(__dirname, "..", "bin", "devalang.exe");
+
+// fs.copyFileSync(source, destination);
+// fs.chmodSync(destination, 0o755);

package/typescript/scripts/postinstall.ts

@@ -0,0 +1,56 @@
+import { createWriteStream, mkdirSync } from "fs";
+import { join } from "path";
+import { https } from "follow-redirects";
+import fs from "fs";
+import path from "path";
+
+const projectVersionPath = path.join(
+  __dirname,
+  "../../project-version.json"
+);
+
+const version = fs.readFileSync(projectVersionPath, "utf-8").trim();
+const versionString = JSON.parse(version).version;
+
+const platform = process.platform;
+
+let binaryName: string;
+switch (platform) {
+  case "win32":
+    binaryName = "devalang-x86_64-pc-windows-msvc.exe";
+    break;
+  case "darwin":
+    binaryName = "devalang-x86_64-apple-darwin";
+    break;
+  case "linux":
+    binaryName = "devalang-x86_64-unknown-linux-gnu";
+    break;
+  default:
+    console.error(`❌ Unsupported platform: ${platform}`);
+    process.exit(1);
+}
+
+const destDir = join(__dirname, "..", "..", "out-tsc", "bin");
+const dest = join(destDir, binaryName);
+
+const url = `https://github.com/devaloop-labs/devalang/releases/download/v${versionString}/${binaryName}`;
+
+mkdirSync(destDir, { recursive: true });
+
+console.log(`⬇️  Downloading ${binaryName} from ${url}`);
+
+https.get(url, (res: any) => {
+  if (res.statusCode !== 200) {
+    console.error(`❌ Failed (HTTP ${res.statusCode})`);
+    process.exit(1);
+  }
+  const file = createWriteStream(dest, { mode: 0o755 });
+  res.pipe(file);
+  file.on("finish", () => {
+    file.close();
+    console.log(`✅ Downloaded ${binaryName} to ${dest}`);
+  });
+}).on("error", (err) => {
+  console.error(`❌ Error: ${err.message}`);
+  process.exit(1);
+});

package/typescript/scripts/version/bump.ts

@@ -1,5 +1,4 @@
 import fs from "fs";
-import path from "path";
 
 export const bumpVersion = async (bumpType: string, projectVersionPath: string) => {
     const versionData = JSON.parse(fs.readFileSync(projectVersionPath, "utf-8"));

package/typescript/scripts/version/index.ts

@@ -1,5 +1,4 @@
 import path from "path";
-import fs from "fs";
 
 import { bumpVersion } from "./bump";
 import { syncVersion } from "./sync";