rust-shell-script - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #linux #docker #macos #nodejs #windows #cli #kubernetes #vue #mcp #openai #open-source

rust-shell-script

(★ 59)

Rustlike shell scripting language; Resilient & robust shell script, compiling to rust code/bash script

File Explorer

Download Latest Version (.zip)

- cmd_lib.rs
- cmd_lib.sh
- hello.rs
- hello.rss
- hello.sh
- cmd_lib.rs
- cmd_lib.sh
- - char.rs
  - mod.rs
  - scan_iter.rs
- bash_backend.rs
- main.rs
- parser.rs
- resolver.rs
- rust_backend.rs
- scanner.rs
.gitignore
Cargo.lock
Cargo.toml
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/rust-shell-script/rust-shell-script

Downloads the entire project code from GitHub to your computer.

cd rust-shell-script

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

$ cargo build

Compiles the Rust project.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# rust-shell-script
~~Rustlike shell scripting language (WIP)~~  -> use [rust_cmd_lib](https://github.com/rust-shell-script/rust_cmd_lib) instead.

Resilient & robust shell script, compiling to rust code/bash script

# Build & Install
```bash
$ cargo build
```

# Example

## Source file

```bash
rust-shell-script$:~/rust-shell-script$ cat examples/hello.rss
cmd error_command() {
    do_something_failed
}

fun bad_greeting(name) {
    info "Running error_command ..."
    error_command
    output "hello, ${name}!"
}

fun good_greeting(name) {
    info "Running good_command ..."
    output "hello, ${name}!"
}

cmd main() {
    let bad_ans = $(bad_greeting "rust-shell-script")
    info "${bad_ans}"
    let good_ans = $(good_greeting "rust-shell-script")
    info "${good_ans}"
    return 0
}
```

## Compiling to bash

### compiling
```bash
rust-shell-script:~/rust-shell-script$ target/debug/rust-shell-script -t bash examples/hello.rss 
Generating bash script to examples/hello.sh ...
```

### passing shellcheck
```bash
rust-shell-script:~/rust-shell-script$ shellcheck examples/hello.sh 
rust-shell-script:~/rust-shell-script$ echo $?
0
```

### generated bash script
```bash
#!/bin/bash
#
# Generated by rust-shell-script
#
. "${RUNTIME:-.}/cmd_lib.sh"

error_command() {
    do_something_failed
}

function bad_greeting() {
    local name="$1"

info "Running error_command ..."
    error_command
    output "hello, ${name}!"
}

function good_greeting() {
    local name="$1"

info "Running good_command ..."
    output "hello, ${name}!"
}

main() {
    local bad_ans
    bad_ans=$(_call bad_greeting "rust-shell-script")
    info "${bad_ans}"
    local good_ans
    good_ans=$(_call good_greeting "rust-shell-script")
    info "${good_ans}"
    return 0
}

main "$@"
```

### running script

All command errors will be captured automatically, even within bash function:
```bash
rust-shell-script:~/rust-shell-script/examples$ ./hello.sh 
Running error_command ...
/bin/bash: line 219: do_something_failed: command not found
FATAL: Running command (bad_ans=$(_call bad_greeting "rust-shell-script")) near script hello.sh:main():1 failed (ret=127)
```

## Compiling to rust

### compiling
```bash
tao@sophia:~/rust-shell-script$ target/debug/rust-shell-script -t rust examples/hello.rss 
Generating rust code to examples/hello.rs ...
```

### generated rust code
```rust
// Generated by rust-shell-script
mod cmd_lib;
use crate::cmd_lib::{CmdResult, FunResult};

fn error_command() -> CmdResult {
    run_cmd!("do_something_failed")
}

fn bad_greeting(name: &str) -> FunResult {
    info!("Running error_command ...");
    error_command()?;
    output!("hello, {}!", name)
}

fn good_greeting(name: &str) -> FunResult {
    info!("Running good_command ...");
    output!("hello, {}!", name)
}

fn main() -> CmdResult {
    let bad_ans = bad_greeting("rust-shell-script")?;;
    info!("{}", bad_ans);
    let good_ans = good_greeting("rust-shell-script")?;;
    info!("{}", good_ans);
    return Ok(())
}
```

### running rust code
```bash
rust-shell-script:~/rust-shell-script/examples$ rustc hello.rs
rust-shell-script:~/rust-shell-script/examples$ ./hello
Running error_command ...
Running ["do_something_failed"] ...
Error: Os { code: 2, kind: NotFound, message: "No such file or directory" }
```