Skip to main content

A (toy) language that compiles to bash.

Project description

Compatibility Implementations Format Downloads

A (toy) language that compiles to bash. You can think of bashup as just a little syntactic sugar sprinkled on top of bash; any valid bash script is also a valid bashup script.

Just a spoonful of sugar makes the bashisms go down…
#/bin/bash

@fn hi greeting='Hello', target {
    echo "${greeting}, ${target}!"
}

hi --target 'World'

Installation:

$ pip install bashup

Compile and run the above example:

$ bashup -i above_example.bashup -o above_example.sh
$ bash above_example.sh
Hello, World!

Or just run it directly:

$ bashup -r above_example.bashup
Hello, World!

Compiled code (above_example.sh):

#/bin/bash

#
# usage: hi [--greeting <GREETING>] --target <TARGET> [ARGS]
#
function hi() {
    local greeting='Hello'
    local target
    local target__set=0
    local args=()
    local i

    for ((i = 1; i <= $#; i++)); do
        if [ "${!i}" == "--greeting" ]; then
            ((i++))
            greeting=${!i}
        elif [ "${!i}" == "--target" ]; then
            ((i++))
            target=${!i}
            target__set=1
        else
            args+=("${!i}")
        fi
    done

    if [ ${target__set} -eq 0 ]; then
        echo "[ERROR] The --target parameter must be given."
        return 1
    fi

    __hi "${greeting}" "${target}" "${args[@]}"
}

function __hi() {
    local greeting=${1}
    local target=${2}
    shift 2

    echo "${greeting}, ${target}!"
}

hi --target 'World'

Supported Bash Versions

The generated bash code works with bash 3.1 and above (tested against 3.1 to 4.3).

Nifty Features

Bashup tries its best to match the indentation of its compiled code against your hand-written bash. For example:

@fn hi greeting='Hello', target {
  echo "${greeting}, ${target}!"
}

…compiles to:

#
# usage: hi [--greeting <GREETING>] --target <TARGET> [ARGS]
#
function hi() {
  local greeting='Hello'
  local target
  local target__set=0
  local args=()
  local i

  for ((i = 1; i <= $#; i++)); do
    if [ "${!i}" == "--greeting" ]; then
      ((i++))
      greeting=${!i}
      ...

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bashup, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size bashup-1.1.1-py2.py3-none-any.whl (9.3 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size bashup-1.1.1.tar.gz (6.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page