bish

Shell scripting with a modern feel. Wiki.

Attention

(!) This is a copy of https://github.com/tdenniston/bish repository, which isn't under maintenance anymore.

Anyone who wants to be a contributor of this package, just let me know. As I'm not a C++ developer and I can add new features from /lib/stdlib.bish only.

What is it?

Bish is a lightweight language created to bring shell scripting into the 21st century. It gives programmers the comfort of modern syntax but compiles to Bash, resulting in good portability (in as much as Bash is portable).

Currently, Bish is still a very new language. I am adding new features as fast as I can, but it is bound not to support something you might like. In that case, see if you can implement it and submit a pull request!

As a side note, I won't stop you, but you would probably be crazy to use Bish in any sort of production environment until it stabilizes a bit more.

Some small examples are below, BUT see the introduction wiki page for a more comprehensive introduction!

Examples

Function calls

def fib(n) {
    if (n < 2) {
        return 1
    }
    return fib(n-1) + fib(n-2)
}

Shell commands

def printall(files) {
    for (f in files) {
        println(f)
    }
}

# cwd, ls, and cd are all builtin functions.
dir = cwd()

files = ls()
println("Files in current directory $dir:")
printall(files)

cd("/")
println("Files in root directory:")
printall(ls());

# read line from terminal
line = readln()
println(line)
age = readpln("Enter your age: ")
println(age)

Shell-like features

# I/O redirection (like pipes) is a first-class language feature.
pattern = "bish"
matches = ls() | @(grep $pattern)
println("Files in current directory matching $pattern:")
for (m in matches) {
    println(m)
}

Imports

You can import one script to another

# importing second.bish script from the same directory
import second

second.someMethod()

How to install

Сlone the repository for the latest and greatest. Build with 'make'. There are no dependencies other than the C++ standard library (and make itself).

$ git clone https://github.com/adamasantares/tdenniston-bish.git
$ cd tdenniston-bish && make
$ sudo ln -s /ABSOLUTE_PATH/tdenniston-bish/bish /usr/bin/bish
$ bish

Compile a bish program to bash with the command:

$ ./bish input.bish > output.bash

Then run the compiled file:

$ bash output.bash

You can also perform this in a single step by using the -r (for "run") argument:

$ ./bish -r input.bish

This compiles and pipes the output directly to a bash process.

Why

I can't count the number of times when I wanted to write a quick shell script to automate an easy task, only to waste hours tracking down idiosyncrasies in Bash syntax and semantics. Bish tries to fill this niche: when you want a lightweight shell scripting language and don't wish to break out the larger hammer of Python, Perl, etc...

However, I created this language first and foremost as a weekend project and exercise in writing a compiler from scratch. I've dealt with pieces of compilers before, but have never written one from start to finish. Thus, I hope this project can also serve as a good teaching tool. I tried to design it with clarity in mind, so it should be simple to extend the language, or write a new back end.

News (Archive)

• Apr 20 2015 -- Bish version 0.1 released. This is the first tagged release for bish.
• Apr 8 2015 -- I've been caught up in my day job recently, and a few of the features I want to implement before doing a 0.1 release are requiring more infrastructure work than I anticipated. I'm hoping to do a 0.1 release within the next week or two weeks.

To do (Archive?)

The language and compiler are pretty bare-bones as of now, but quite functional. There are numerous things in the pipeline (see the open issues for a list). Longer term, here are some ideas of features that might be implemented:

• Additional compiler targets, e.g. sh for even wider compatability, or ksh for vanilla AIX support.
• Multidimensional arrays, and potentially arrays of mixed types.
• Syntactical sugar for more shell-like function invocation. For example, typing cd("path") or ls("-l") might get old when writing bish scripts. Bish could support an alternate invocation syntax of function arg0 arg1... so that these functions could be invoked like cd path or ls -l directly in the bish script.
• Language support for executing portions of bish scripts as other users (e.g. the administrator).
• Language support for executing commands on remote machines.