brett-compiler 1.0.27 → 1.0.28

package/README.md

@@ -0,0 +1,276 @@
+# Brett Language Reference
+
+Brett is a statically-typed, C-style programming language with modern control structures, functions, and object/array support. This guide covers all syntax and language features.
+
+---
+
+## Table of Contents
+
+1. [Program Structure](#program-structure)
+2. [Variables](#variables)
+3. [Functions](#functions)
+4. [Control Flow](#control-flow)
+    - [If and Else](#if-and-else)
+    - [While](#while)
+    - [Do-While](#do-while)
+    - [For](#for)
+    - [Switch](#switch)
+5. [Try, Catch, and Finally](#try-catch-and-finally)
+6. [Expressions](#expressions)
+    - [Literals](#literals)
+    - [Identifiers](#identifiers)
+    - [Operators](#operators)
+    - [Function Calls](#function-calls)
+    - [Arrays](#arrays)
+    - [Objects](#objects)
+    - [Member Access and Indexing](#member-access-and-indexing)
+    - [Increment and Decrement](#increment-and-decrement)
+7. [Types](#types)
+8. [Miscellaneous](#miscellaneous)
+
+---
+
+## Program Structure
+
+A Brett program is a series of statements, optionally organized into blocks:
+
+```brett
+program : statement* EOF ;
+
+block : '{' statement* '}' ;
+```
+
+Example:
+
+```brett
+{
+    let x = 10;
+    let y = 20;
+}
+```
+
+---
+
+## Variables
+
+Brett supports mutable (`let`) and immutable (`const`) variables:
+
+```brett
+let x = 5;          // mutable
+const y: number = 10;  // immutable, type-annotated
+```
+
+- Optional type annotations are allowed: `let z: string = "hello";`
+- Immutable variables must always be initialized.
+
+---
+
+## Functions
+
+Functions are declared with `def`:
+
+```brett
+def add(a: number, b: number): number {
+    return a + b;
+}
+```
+
+- Parameters can have optional type annotations.
+- Functions can have an optional return type.
+- Blocks define the function body.
+
+---
+
+## Control Flow
+
+### If and Else
+
+```brett
+if (x > 0) {
+    print("Positive");
+} else {
+    print("Non-positive");
+}
+```
+
+- Standard `if-else` branching.
+
+### While
+
+```brett
+while (x < 10) {
+    x++;
+}
+```
+
+- Repeats the block while the condition is true.
+
+### Do-While
+
+```brett
+do {
+    x++;
+} while (x < 10);
+```
+
+- Executes the block at least once, then checks the condition.
+
+### For
+
+```brett
+for (let i = 0; i < 10; i++) {
+    print(i);
+}
+```
+
+- Supports initialization, condition, and iteration expressions.
+- Can omit parts of the `for` declaration if not needed.
+
+### Switch
+
+```brett
+switch {
+    case 1 => { print("One"); }
+    case 2 => { print("Two"); }
+    default => { print("Other"); }
+}
+```
+
+- Expression-based cases using `=>`.
+- Optional `default` case.
+
+---
+
+## Try, Catch, and Finally
+
+```brett
+try {
+    riskyOperation();
+} catch (e: Error) {
+    print("Caught an error: " + e);
+} finally {
+    cleanup();
+}
+```
+
+- Standard exception handling.
+- `finally` block executes regardless of exceptions.
+
+---
+
+## Expressions
+
+Brett supports a rich set of expressions.
+
+### Literals
+
+```brett
+42       // number
+3.14     // float
+"hello"  // string
+true
+false
+nil
+```
+
+### Identifiers
+
+```brett
+let name = "Alice";
+```
+
+### Operators
+
+Binary operators:
+
+```brett
++, -, *, /, <, <=, >, >=, ==, !=
+```
+
+Assignment (right-associative):
+
+```brett
+x = 10;
+y = x = 5;
+```
+
+### Function Calls
+
+```brett
+print("Hello, world!");
+sum(3, 4);
+```
+
+### Arrays
+
+```brett
+let nums = [1, 2, 3, 4];
+```
+
+### Objects
+
+```brett
+let person = {
+    name: "Alice",
+    age: 30
+};
+```
+
+### Member Access and Indexing
+
+```brett
+person.name;   // "Alice"
+nums[0];       // 1
+```
+
+### Increment and Decrement
+
+```brett
+x++;    // post-increment
+++x;    // pre-increment
+x--;    // post-decrement
+--x;    // pre-decrement
+```
+
+---
+
+## Types
+
+```brett
+string, number, bool, any, void
+```
+
+- Arrays: `number[]`, `string[]`
+- Custom types: `MyType`
+
+---
+
+## Miscellaneous
+
+- **Break / Continue**:
+
+```brett
+for (let i = 0; i < 10; i++) {
+    if (i == 5) break;
+    if (i % 2 == 0) continue;
+}
+```
+
+- **Return**:
+
+```brett
+return x + y;
+```
+
+---
+
+### Comments
+
+```brett
+// single-line comment
+/* multi-line comment */
+```
+
+---
+
+This guide covers **all core features** of Brett, from variables and functions to advanced control flow and expressions.

package/dist/README.md

@@ -0,0 +1,276 @@
+# Brett Language Reference
+
+Brett is a statically-typed, C-style programming language with modern control structures, functions, and object/array support. This guide covers all syntax and language features.
+
+---
+
+## Table of Contents
+
+1. [Program Structure](#program-structure)
+2. [Variables](#variables)
+3. [Functions](#functions)
+4. [Control Flow](#control-flow)
+    - [If and Else](#if-and-else)
+    - [While](#while)
+    - [Do-While](#do-while)
+    - [For](#for)
+    - [Switch](#switch)
+5. [Try, Catch, and Finally](#try-catch-and-finally)
+6. [Expressions](#expressions)
+    - [Literals](#literals)
+    - [Identifiers](#identifiers)
+    - [Operators](#operators)
+    - [Function Calls](#function-calls)
+    - [Arrays](#arrays)
+    - [Objects](#objects)
+    - [Member Access and Indexing](#member-access-and-indexing)
+    - [Increment and Decrement](#increment-and-decrement)
+7. [Types](#types)
+8. [Miscellaneous](#miscellaneous)
+
+---
+
+## Program Structure
+
+A Brett program is a series of statements, optionally organized into blocks:
+
+```brett
+program : statement* EOF ;
+
+block : '{' statement* '}' ;
+```
+
+Example:
+
+```brett
+{
+    let x = 10;
+    let y = 20;
+}
+```
+
+---
+
+## Variables
+
+Brett supports mutable (`let`) and immutable (`const`) variables:
+
+```brett
+let x = 5;          // mutable
+const y: number = 10;  // immutable, type-annotated
+```
+
+- Optional type annotations are allowed: `let z: string = "hello";`
+- Immutable variables must always be initialized.
+
+---
+
+## Functions
+
+Functions are declared with `def`:
+
+```brett
+def add(a: number, b: number): number {
+    return a + b;
+}
+```
+
+- Parameters can have optional type annotations.
+- Functions can have an optional return type.
+- Blocks define the function body.
+
+---
+
+## Control Flow
+
+### If and Else
+
+```brett
+if (x > 0) {
+    print("Positive");
+} else {
+    print("Non-positive");
+}
+```
+
+- Standard `if-else` branching.
+
+### While
+
+```brett
+while (x < 10) {
+    x++;
+}
+```
+
+- Repeats the block while the condition is true.
+
+### Do-While
+
+```brett
+do {
+    x++;
+} while (x < 10);
+```
+
+- Executes the block at least once, then checks the condition.
+
+### For
+
+```brett
+for (let i = 0; i < 10; i++) {
+    print(i);
+}
+```
+
+- Supports initialization, condition, and iteration expressions.
+- Can omit parts of the `for` declaration if not needed.
+
+### Switch
+
+```brett
+switch {
+    case 1 => { print("One"); }
+    case 2 => { print("Two"); }
+    default => { print("Other"); }
+}
+```
+
+- Expression-based cases using `=>`.
+- Optional `default` case.
+
+---
+
+## Try, Catch, and Finally
+
+```brett
+try {
+    riskyOperation();
+} catch (e: Error) {
+    print("Caught an error: " + e);
+} finally {
+    cleanup();
+}
+```
+
+- Standard exception handling.
+- `finally` block executes regardless of exceptions.
+
+---
+
+## Expressions
+
+Brett supports a rich set of expressions.
+
+### Literals
+
+```brett
+42       // number
+3.14     // float
+"hello"  // string
+true
+false
+nil
+```
+
+### Identifiers
+
+```brett
+let name = "Alice";
+```
+
+### Operators
+
+Binary operators:
+
+```brett
++, -, *, /, <, <=, >, >=, ==, !=
+```
+
+Assignment (right-associative):
+
+```brett
+x = 10;
+y = x = 5;
+```
+
+### Function Calls
+
+```brett
+print("Hello, world!");
+sum(3, 4);
+```
+
+### Arrays
+
+```brett
+let nums = [1, 2, 3, 4];
+```
+
+### Objects
+
+```brett
+let person = {
+    name: "Alice",
+    age: 30
+};
+```
+
+### Member Access and Indexing
+
+```brett
+person.name;   // "Alice"
+nums[0];       // 1
+```
+
+### Increment and Decrement
+
+```brett
+x++;    // post-increment
+++x;    // pre-increment
+x--;    // post-decrement
+--x;    // pre-decrement
+```
+
+---
+
+## Types
+
+```brett
+string, number, bool, any, void
+```
+
+- Arrays: `number[]`, `string[]`
+- Custom types: `MyType`
+
+---
+
+## Miscellaneous
+
+- **Break / Continue**:
+
+```brett
+for (let i = 0; i < 10; i++) {
+    if (i == 5) break;
+    if (i % 2 == 0) continue;
+}
+```
+
+- **Return**:
+
+```brett
+return x + y;
+```
+
+---
+
+### Comments
+
+```brett
+// single-line comment
+/* multi-line comment */
+```
+
+---
+
+This guide covers **all core features** of Brett, from variables and functions to advanced control flow and expressions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brett-compiler",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "description": "Een compiler voor de .Brett taal",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",