Hook cheatsheet

• GitHub
• Playground
• Examples
• VSCode Extension

fn factorial(n) {
  if (n == 0)
    return 1;
  return n * factorial(n - 1);
}

Hook features a modern syntax similar to C.

println("Hello, World!");
// Hello, World!

The Hello, World! program in Hook.

brew tap hook-lang/hook
brew install hook
hook --help

The interpreter is available on Homebrew.

List of basic types.

let x = true;
let y = false;

Bool is a boolean type. So, it can be true or false.

let x = 0;
let degree = 45; // integer number
let pi = 3.14;   // floating-point number

Numbers can be integers or floating-point.

let empty = "";

let name = "John";

let message = 'Hello, "John"!';

Strings can be single or double-quoted.

let range = 1..5;

println(range);
// 1..5

Ranges are a sequence of integers.

let fruits = [
  "apple",
  "banana",
  "cherry"
];

println(fruits);
// ["apple", "banana", "cherry"]

Arrays are a sequence of elements.

let p = { x: 5, y: 10 };

println(p);
// {x: 5, y: 10}

Records maps fields to values.

let x = nil;
var y;

println(x);  // nil
println(y);  // nil

nil is the absence of a value.

if (nil) "true" else "false";   // false
if (false) "true" else "false"; // false
if (true) "true" else "false";  // true
if (0) "true" else "false";     // true
if (1) "true" else "false";     // true
if ("") "true" else "false";    // true
if ([]) "true" else "false";    // true
if ({}) "true" else "false";    // true

Just nil and false are falsy.

// This is a single-line comment.

// And this is
// a multi-line
// comment. ;)

Hook supports single-line comments only. Sorry!

{
  println("Hello");
  {
    println("World");
  }
}

Blocks are used to define a scope.

There are few reserved words.

var lowercase;
var CAPS_LOCK;
var camelCase;
var PascalCase;
var snake_case;
var _123;

Identifiers are case-sensitive.

var x;      // x contains nil
x = 5;      // now, x contains a number
x = "foo";  // a string

println(x);

Values have types, but variables don't.

let x = 5;
{
  let x = 10; // shadows the outer `x`
  println(x); // 10
}
println(x);   // 5

Variables can be shadowed.

println(5 + 10); // 15
println(5 - 10); // -5
println(5 * 10); // 50
println(5 / 10); // 0.5
println(5 % 10); // 5
println(-5);     // -5

The basic arithmetic operators.

println(5 == 10); // false
println(5 != 10); // true
println(5 < 10);  // true
println(5 > 10);  // false
println(5 <= 10); // true
println(5 >= 10); // false

The comparison operators.

println(true && false); // false
println(true || false); // true
println(!true);         // false

The logical operators.

println(5 & 10); // 0
println(5 | 10); // 15
println(5 ^ 10); // 15
println(~5);     // -6
println(5 << 1); // 10
println(5 >> 1); // 2

The bitwise and shift operators.

var x = 5; // 5
x += 10;   // 15
x -= 10;   // 5
x *= 10;   // 50
x /= 10;   // 5
x %= 10;   // 5
x &= 10;   // 0
x |= 10;   // 10
x ^= 5;    // 15
x <<= 5;   // 480
x >>= 5;   // 15
x++;       // 16
x--;       // 15

The assignment operators.

let x = 5;
let y = if (x > 5) 10 else 20;

println(y);
// 20

In Hook, the ternary operator is if else.

let x = 10;

if (x > 5) {
  println("x is greater than 5");
}
// x is greater than 5

The if statement.

let x = 11;

if (x == 5) {
  println("x is 5");

} else if (x == 10) {
  println("x is 10");

} else {
  println("x is neither 5 nor 10");
}
// x is neither 5 nor 10

The if else statement.

let x = 5;

match (x) {
  1 => println("one");
  2 => println("two");
  3 => println("three");
  _ => println("other");
} 
// other

The match statement.

var x = 0;

while (x < 5) {
  print(x);
  x += 1;
}
// 01234

The while loop.

var x = 0;

do {
  print(x);
  x += 1;
} while (x < 5);
// 01234

The do while loop.

for (var i = 0; i < 5; i++) {
  print(i);
}
// 01234

The classic for loop.

loop {
  println("Press Ctrl+C to stop");
}

The unconditional loop.

var i = 0;

loop {
  if (i == 5) break;

  print(i);
  i += 1;
}
// 01234

Use break to exit a loop.

var i = 0;

loop {
  i += 1;
  if (i % 2 == 0) continue;

  print(i);

if (i == 5) break;
}
// 135

Use continue to skip the rest of the loop body.

let s = "Hello";

println(s[0]);   // H
println(s[1]);   // e
println(s[4]);   // o

Indexing a string returns a 1-character string.

let s = "Hello, World!";

println(s[0..5]);        // Hello,
println(s[7..12]);       // World!

Pass a range to slice a string.

let greeting = "Hi" + " there!";

println(greeting);
// Hi there!

Use the + operator to concatenate strings.

let a = [1, 2, 3];

println(a[0]);     // 1
println(a[1]);     // 2
println(a[2]);     // 3

Indexing an array returns an element.

let a = [1, 2, 3, 4];

println(a[0..2]);            // [1, 2, 3]
println(a[1..3]);            // [2, 3, 4]
println(a[2 .. len(a) - 1]); // [3, 4]

Arrays are zero-indexed.

var a = [1, 2];

a[] = 3;

println(a);
// [1, 2, 3]

Arrays are mutable. Use [] to append an element.

var a = [1, 2, 3];

a[0] = 4;

println(a);
// [4, 2, 3]

Update an element in an array.

let a = [1, 2];
let b = [3];
let c = a + b;

println(c);
// [1, 2, 3]

Use the + operator to concatenate arrays.

let a = [1, 2, 2, 3];
let b = [2];
let c = a - b;

println(c);
// [1, 3]

Get the difference between two arrays.

fn sum(a, b) {
  return a + b;
}

println(sum(5, 10));
// 15

Functions are first-class citizens.

fn greet(name) {
  println("Hi, " + name + "!");
}

greet("John", "Doe");
// Hi, John!

The number of arguments is adjusted.

let sum = |a, b| {
  return a + b;
};

println(sum(5, 10));
// 15

Anonymous functions are also supported.

let pi = 3.14;

fn area(r) {
  return pi * r * r;
}

println(area(5));
// 78.5

Closures in Hook capture values only.

fn apply(f, x) {
  return f(x);
}

fn double(x) {
  return x * 2;
}

println(apply(double, 5));
// 10

Functions can be passed as arguments or returned.

fn factorial(n) =>
  if (n == 0) 1
  else n * factorial(n - 1);

println(factorial(5));
// 120

Use => when the body is a single expression.

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

println(fib(10));
// 55

Recursion is supported.

println(type(5));
// number
println("1" + to_string(2));
// 12
println(len("foo"));
// 3

There are many built-in functions.

See: Built-in Functions

struct Point {
  x, y
}

let p = Point { 5, 10 };

println(p);
// {x: 5, y: 10}

A struct is a prototype for a record.

println(p.x); // 5
println(p.y); // 10

Use . to access a field in a record.

p.x = 10;
p.y = 20;

println(p);
// {x: 10, y: 20}

Update a value of a field in a record.

let a = [1, 2];
let [x, y] = a;

println(x);     // 1
println(y);     // 2

Varuables are declared and assigned.

let p = { x: 5, y: 10 };
let { x } = p;

println(x);
// 5

Use {} to destructure a record.

let a = [1, 2];
let [x] = a;
let [_, y] = a;

println(x);     // 1
println(y);     // 2

Use _ skip leading or middle elements.

import math;

println(math.sqrt(25));
// 5

Use import to bring a module into scope.

// my_module.hk
fn useful_fn() {
  return "Nothing";
}

return { useful: useful_fn };

Return a record with the symbols to export.

import "./my_module.hk" as my;

println(my.useful());
// Nothing

Specify the path to the local module.

import { pow, sqrt } from math;

let [ b, c ] = [ 4, 3 ];
let a = sqrt(pow(b, 2) + pow(c, 2));

println(a);
// 5

Use {} to import specific symbols.

See: Core Modules

This is a list of extension modules.

import { stderr, writeln } from io;

writeln(stderr, "Something went wrong");
// Something went wrong

Printing to stderr using io module.

import hashing as h;

let d = h.sha256("Hello, world!");

println(hex(d));
// 315f5bdb76d078c43b8ac0064e4a...

hashing module provides hash functions.

import json;

let j = '{"x": 1, "y": 2}';
let p = json.decode(j);

println(p.x);               // 1

let k = json.encode(p);
println(type(k));           // string

Use json module for working with JSON.

println("Hello, World!")

// syntax error: unexpected end of file
//   at main() in example.hk:1,25

Hook has a strict syntax.

panic("Something went wrong");

// panic: Something went wrong
//   at main() in example.hk:1

Use the panic built-in function to raise an error.

if (let [ok, err] = divide(5, 0); err) {
  return [nil, err];
}

Pass an error without handling it.