Renk

Renk is an indentation-based syntax for Rust, inspired by Rust's Ugly Syntax.

Documentation: https://scarf005.github.io/renk/ (한국어)

Example

#[derive(Debug, Clone)]
pub struct User:
    pub id: u64
    pub name: String

impl User:
    pub fn new(id: u64, name: String) -> Self = Self{ id, name }
    pub fn display_name(&self) -> &str = &self.name

pub fn main():
    let user = User.new(1, "Ada".to_string())
    println!("{user.display_name()}")

Generated Rust:

#[derive(Debug, Clone)]
pub struct User {
    pub id: u64,
    pub name: String,
}
impl User {
    pub fn new(id: u64, name: String) -> Self {
        Self{ id, name }
    }
    pub fn display_name(&self) -> &str {
        &self.name
    }
}
pub fn main() {
    let user = User::new(1, "Ada".to_string());
    println!("{}", user.display_name());
}

Usage

cargo install --path crates/renk --bin renk --bin renk-lsp
renk transpile input.rk -o output.rs
renk from-rust input.rs -o output.rk
cat input.rk | renk

See Getting started and Syntax.

Formatter

renk fmt formats a file with rustfmt's layout; --check prints a diff and exits with 1 for unformatted files. Details.

renk fmt src/main.rk -o src/main.rk
renk fmt --check src/*.rk

Cargo wrapper

renk build, renk run, renk test, and renk cargo ... transpile .rk files under Cargo source roots into .rs files, then run Cargo. Details.

renk cargo test

Scripts

renk script runs a single-file script with cargo +nightly -Zscript. Dependencies go in --- frontmatter; renk add edits it. Details.

#!/usr/bin/env -S renk script
---
[dependencies]
regex = "1"
---

fn main():
    println!("{}", regex::Regex::new("a+").unwrap().is_match("caab"))

renk script tool.rk arg
renk add tool.rk regex

Language server

renk-lsp is a stdio language server. It reports syntax errors and symbols, and forwards rust-analyzer's diagnostics, hover, definition, completion, references, rename, code actions, and inlay hints. Editor setup.

Web runner

podman compose up --build serves the web editor at http://localhost:8080. just web starts it from a checkout. Details.

Limits

Renk reads text, not types, so some names are misread. See Limits.