bs

WARNING: IN PROGRESS

Bash Scripting is a simple programming language that compiles to Bash.

Todo

More tests
Syntax checking
Support for expressions in if, while and for in statements.
Pretty printing output script

Use

Execute Code

bs /path/to/file.bs

Generate Script

bs -script /path/to/file.bs

Syntax

The syntax of bs is C-based (derived from C programming language). If you have learned C, Java, C++ or JavaScript, bs is quite easy for you.

Comments

// This is a comment about your "code".
print("foo")

Assignment

a = 1
b = "string"
c = array(1, 2, "str", true, false)
d = c[2]

Expression

a = 1 + 2
b = a * 7
c = concat("Con", "cat")
d = c + b

Command

output = ls()
ex = exists("file.txt")

If condition

a = 3;
if a > 2 {
    println("Yes")
} else if (a == 2) {
    println("No")
}

For in

list = array(1, 2, 3)
for i in list {
    println(i)
}

While

n = 0
i = 0
j = 1
while n < 60 {
    k = i + j
    i = j
    j = k
    n = n + 1
    println(k)
}

Function

v1 = "Global V1"
v2 = "Global V2"
func foo(p) {
    v1 = concat("Local ", p)
    v2 = "V3 Modified."
}
foo("Var")

Recursion

func fibonacci(num) {
    if num == 0 {
        return 0
    } else if num == 1 {
        return 1
    } else {
        return fibonacci(num - 2) + fibonacci(num - 1)
    }
}
println(fibonacci(8))

Import module

import("./path/to/module/foo")
foo.function()

Built-in functions

`print(text, ...)`

Prints a text string to console without a newline.

`println(text, ...)`

Prints a text string to console with a new line.

`call(path, arg, ...)`

Runs command from path through the bash shell.

`bash(rawStatement)`

Put rawStatement into compiled code for Bash.

`concat(str...)`

Concatenates the given arguments and returns a string.

`array(arg...)`

Returns an array of the given arguments.

`pack(array)`

Converts an array into a string so it can be passed as a function argument.

arr = array(1, 2, 3)
foo(pack(arr))

`unpack(array_argument)`

Returns an array from a string if the value was a packed array.

func foo(arr) {
    a = unpack(arr)
    return a[2]
}

Testing

go test

Code Coverage

go test -coverprofile=coverage.out; go tool cover -html=coverage.out -o=coverage.html
open coverage.html

Inspiration

This project was inspired by Batsh.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

ricallinson/bs

bs