Install and run

TorbScript is one program, torb. It runs your code, tests it, checks it and formats it.

Goal#

At the end of this page TorbScript is installed, you have run a file, and you have a project with a passing test.

Install#

Run the one command for your system from the install page, then open a new terminal and check:

$ torb --version
torb 0.1.0

Run a file#

Save this as hello.trb:

const name = "World"
print "Hello, {name}!"
// prints Hello, World!

And run it:

$ torb run hello.trb
Hello, World!

{name} puts a value into the text. A file like this one may hold code at the top level; it needs no main.

Make a project#

$ torb new hello --offline
wrote hello/project.trb, hello/src/main.trb, hello/tests/main.test.trb
$ cd hello
$ torb run
Hello, hello

--offline writes a small starter at once. Without it, torb new asks a few questions and starts from a template (torb new). The project is three files:

hello/
├ src/
├─ main.trb           the program that torb run starts
├ tests/
├─ main.test.trb      a test, because its name ends in .test.trb
└ project.trb         the manifest: name = "hello", version = "0.1.0"

project.trb is TorbScript too. File names decide the rest, so the manifest needs no more lines.

Test it#

tests/main.test.trb holds one test:

use test from "std/test"

test "hello runs" {
  assert(1 + 1 == 2)
}

$ torb test
tests/main.test.trb
  ok      hello runs

1 passed, 0 failed (1 file)

test takes a name and a block. assert takes a condition, and when it fails it prints the condition and the values in it, so there is nothing else to learn.

Check and format#

$ torb check .
3 files, no problems
$ torb format --check .
0 of 3 files would change

torb check finds mistakes without running anything and points at the line. torb format writes your files in the one layout of the language; --check only reports. Run both before you call something done.

Ship it#

torb run starts at once. When you want a program file that runs without TorbScript, build one:

$ torb build --output hello
wrote hello
$ ./hello
Hello, hello

torb build needs a C compiler on your computer; the install page says which.

Next#

• Values and bindings - const, var, and what a copy means.
• Modules and packages - more than one file, and how a test reaches your code.
• The torb command - every command and flag.