Clean up

Author: aayush-tripathi

.github/workflows/mdbook.yml

@@ -2,7 +2,7 @@ name: Deploy Docs
 
 on:
   push:
-    branches: [master]        # build on every push to master
+    branches: [master]        
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -15,15 +15,14 @@ jobs:
       - name: Build book
         run: mdbook build docs
 
-      # Upload the generated site as an artifact that Pages can deploy
       - uses: actions/upload-pages-artifact@v3
         with:
           path: docs/book
 
   deploy:
     needs: build
     permissions:
-      pages: write           # to push to gh-pages
+      pages: write          
       id-token: write
     runs-on: ubuntu-latest
     environment:

playground/README.md

@@ -1,69 +1 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      ...tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      ...tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      ...tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
-
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
+# An Interactive REPL for tundra 

playground/src/Editor.tsx

@@ -3,10 +3,7 @@ import { useCallback } from "react";
 import MonacoEditor, { Monaco } from "@monaco-editor/react";
 
 const registerTundra = (monaco: Monaco) => {
-/*──────────────── 1.  Register the language ────────────────*/
 monaco.languages.register({ id: "tundra" });
-
-/*──────────────── 2.  Tokenizer (Monarch) ───────────────────*/
 monaco.languages.setMonarchTokensProvider("tundra", {
   tokenizer: {
     root: [
@@ -15,31 +12,26 @@ monaco.languages.setMonarchTokensProvider("tundra", {
       [/'[^']*'/, "string"],                   // single-quoted strings
       [/\b(var|fun|class|for|while|if|else|return|print)\b/, "keyword"],
       [/[\+\-\*\/%]|\*\*|==|!=|<=|>=|<|>/, "operator"],
-      [/[{}\(\)\[\]:]/, "@brackets"],          // include colon as bracket
+      [/[{}\(\)\[\]:]/, "@brackets"],          
       [/[a-zA-Z_]\w*/, "identifier"],
       [/#.*$/, "comment"],
     ],
   },
 });
 
-/*──────────────── 3.  Language configuration for indentation ────────────*/
 monaco.languages.setLanguageConfiguration("tundra", {
   indentationRules: {
-    // Increase indent after lines ending with ':'
     increaseIndentPattern: /^\s*(if|while|for|fun|class|else)\b.*:\s*$/,
-    // Decrease indent for lines starting with 'else'
     decreaseIndentPattern: /^\s*(else)\b.*$/,
   },
   onEnterRules: [
     {
-      // After a line ending with ':', increase indent
       beforeText: /^\s*(if|while|for|fun|class|else)\b.*:\s*$/,
       action: {
         indentAction: monaco.languages.IndentAction.Indent,
       },
     },
     {
-      // For 'else' statements, align with the corresponding 'if'
       beforeText: /^\s*else\s*:\s*$/,
       action: {
         indentAction: monaco.languages.IndentAction.Outdent,
@@ -52,7 +44,7 @@ monaco.languages.setLanguageConfiguration("tundra", {
   ],
 });
 
-/*──────────────── 4.  Snippet-style completions ─────────────*/
+
 monaco.languages.registerCompletionItemProvider("tundra", {
   provideCompletionItems: (model, position) => {
     const word = model.getWordUntilPosition(position);
@@ -144,7 +136,6 @@ monaco.languages.registerCompletionItemProvider("tundra", {
   },
 });
 
-/*──────────────── 5.  (Optional) turn off the default JS/TS diagnostics ──*/
 monaco.languages.typescript.javascriptDefaults.setDiagnosticsOptions({
   noSemanticValidation: true,
   noSyntaxValidation: true,
@@ -157,7 +148,7 @@ interface Props {
 }
 
 export const Editor = ({ code, setCode }: Props) => {
-  // run once, before the editor mounts
+
   const handleBeforeMount = useCallback((monaco: Monaco) => {
     registerTundra(monaco);
   }, []);

playground/src/monaco-tundra.ts

@@ -1,9 +1,7 @@
 import * as monaco from "monaco-editor";
 
-/*──────────────── 1.  Register the language ────────────────*/
 monaco.languages.register({ id: "tundra" });
 
-/*──────────────── 2.  Tokenizer (Monarch) ───────────────────*/
 monaco.languages.setMonarchTokensProvider("tundra", {
   tokenizer: {
     root: [
@@ -12,31 +10,30 @@ monaco.languages.setMonarchTokensProvider("tundra", {
       [/'[^']*'/, "string"],                   // single-quoted strings
       [/\b(var|fun|class|for|while|if|else|return|print)\b/, "keyword"],
       [/[\+\-\*\/%]|\*\*|==|!=|<=|>=|<|>/, "operator"],
-      [/[{}\(\)\[\]:]/, "@brackets"],          // include colon as bracket
+      [/[{}\(\)\[\]:]/, "@brackets"],          
       [/[a-zA-Z_]\w*/, "identifier"],
       [/#.*$/, "comment"],
     ],
   },
 });
 
-/*──────────────── 3.  Language configuration for indentation ────────────*/
 monaco.languages.setLanguageConfiguration("tundra", {
   indentationRules: {
-    // Increase indent after lines ending with ':'
+
     increaseIndentPattern: /^\s*(if|while|for|fun|class|else)\b.*:\s*$/,
-    // Decrease indent for lines starting with 'else'
+
     decreaseIndentPattern: /^\s*(else)\b.*$/,
   },
   onEnterRules: [
     {
-      // After a line ending with ':', increase indent
+ 
       beforeText: /^\s*(if|while|for|fun|class|else)\b.*:\s*$/,
       action: {
         indentAction: monaco.languages.IndentAction.Indent,
       },
     },
     {
-      // For 'else' statements, align with the corresponding 'if'
+
       beforeText: /^\s*else\s*:\s*$/,
       action: {
         indentAction: monaco.languages.IndentAction.Outdent,
@@ -49,7 +46,7 @@ monaco.languages.setLanguageConfiguration("tundra", {
   ],
 });
 
-/*──────────────── 4.  Snippet-style completions ─────────────*/
+
 monaco.languages.registerCompletionItemProvider("tundra", {
   provideCompletionItems: (model, position) => {
     const word = model.getWordUntilPosition(position);
@@ -141,7 +138,7 @@ monaco.languages.registerCompletionItemProvider("tundra", {
   },
 });
 
-/*──────────────── 5.  (Optional) turn off the default JS/TS diagnostics ──*/
+
 monaco.languages.typescript.javascriptDefaults.setDiagnosticsOptions({
   noSemanticValidation: true,
   noSyntaxValidation: true,

tundra-cli/src/main.rs

@@ -35,21 +35,21 @@ fn main() {
         }
     };
 
-    // 1) Compile
+    // Compile
     let chunk = Rc::new(RefCell::new(Chunk::new()));
     let mut compiler = Compiler::new(chunk.clone());
     if !compiler.compile(&source) {
         eprintln!("Compile error");
         process::exit(1);
     }
 
-    // Optional bytecode dump
+    //  bytecode dump
     let debug = args.any(|a| a == "--debug");
     if debug {
         disassemble_chunk(&chunk.borrow(), &format!("== {} ==", script));
     }
 
-    // 2) Run with **interpreter only** (no JIT)
+    // interpreter only run
     let mut vm = VM::new_interpreter_only(chunk, Box::leak(Box::new(std::io::stdout())));
     match vm.run() {
         InterpretResult::Ok => {}

tundra/src/bytecode/chunk.rs

@@ -4,7 +4,7 @@ use super::opcode::OpCode;
 use crate::bytecode::value::Value;
 
 /// A compiled “chunk” of code:  
-/// - `code` holds your high-level `OpCode` instructions  
+/// - `code` holds high-level `OpCode` instructions  
 /// - `constants` is the literal pool  
 /// - `lines[i]` is the source‐line for `code[i]`
 /// - `max_register` to allocate CraneLift Variables

tundra/src/bytecode/debug.rs

@@ -2,7 +2,7 @@
 
 use crate::bytecode::chunk::Chunk;
 
-/// A one‐pass disassembler: we print each instruction via its Debug impl.
+/// A one‐pass disassembler
 pub fn disassemble_chunk(chunk: &Chunk, name: &str) {
     println!("== {} ==", name);
     for (offset, instr) in chunk.code.iter().enumerate() {

tundra/src/bytecode/opcode.rs

@@ -47,7 +47,7 @@ pub enum OpCode {
 }
 
 impl OpCode {
-    /// A compact numeric tag for each variant (useful for a real byte-buffer backend)
+    /// A compact numeric tag for each variant 
     pub fn tag(&self) -> u8 {
         match self {
             OpCode::LoadConstant(_, _) => 0x01,
@@ -91,7 +91,7 @@ impl OpCode {
             OpCode::IncLoopIfLess(_, _, _) => 0x27,
         }
     }
-    ///Convert to bytes (For Debugging)
+    ///Convert to bytes 
     pub fn to_bytes(&self) -> Vec<u8> {
         let mut buf = vec![self.tag()];
         match self {

tundra/src/bytecode/value.rs

@@ -11,16 +11,14 @@ pub enum ValueType {
     Float(f64),
     Char(char),
     Array(Rc<RefCell<Vec<Value>>>),
-    // A Rust‐side builtin function:
     NativeFunction(fn(&[Value]) -> Value, usize /*arity*/),
-    // A user‐defined function
     Function(Rc<RefCell<FunctionObject>>),
 }
 #[derive(Debug, Clone, PartialEq)]
 pub struct Value {
     pub value: ValueType,
 }
-/* ───────── Encoding helpers ───────── */
+
 
 pub const TAG_BITS: u64 = 0b111;
 pub const TAG_PTR: u64 = 0b000;
@@ -144,15 +142,14 @@ impl Value {
     /// loss-less, type-preserving packing into a single register
     pub fn as_i64(&self) -> i64 {
         match &self.value {
-            /* POD scalar slots */
+        
             ValueType::Int(i) => ((*i as u64) << 3 | TAG_INT) as i64,
             ValueType::Bool(false) => TAG_BOOL as i64,
             ValueType::Bool(true) => (1u64 << 3 | TAG_BOOL) as i64,
             ValueType::None => TAG_NONE as i64,
             ValueType::Char(c) => ((*c as u64) << 3 | TAG_CHAR) as i64,
             ValueType::Float(f) => f.to_bits() as i64,
 
-            /* everything heap-allocated – we just use the raw pointer      */
             ValueType::String(s) => {
                 let p = s.as_ptr() as u64;
                 (p | TAG_PTR) as i64
@@ -212,7 +209,7 @@ impl Value {
             }
             ValueType::Char(c) => {
                 let mut b = vec![0x05]; // Char tag
-                b.extend(&(*c as u32).to_le_bytes()); // char → 4-byte Unicode scalar
+                b.extend(&(*c as u32).to_le_bytes()); 
                 b
             }
             ValueType::String(s) => {

tundra/src/lib.rs

@@ -39,10 +39,9 @@ impl std::io::Write for OutputCapture {
 }
 
 pub fn run(src: &str) -> Result<String> {
-    // Create a shared buffer for capturing output
+    //  a shared buffer for capturing output
     let output_buffer = Rc::new(RefCell::new(Vec::<u8>::new()));
 
-    // Create the output capture and leak it to get a 'static reference
     let output_capture = Box::new(OutputCapture::new(output_buffer.clone()));
     let output_ref: &'static mut dyn std::io::Write = Box::leak(output_capture);
 
@@ -63,15 +62,10 @@ pub fn run(src: &str) -> Result<String> {
             InterpretResult::CompileError => unreachable!(),
         }
     };
-    
-    // Extract the output from the shared buffer
     let output_bytes = {
         let buffer = output_buffer.borrow();
         buffer.clone()
     };
-    
     let output_string = String::from_utf8(output_bytes).unwrap_or_default();
-    
-    // Return the result with the captured output
     result.map(|_| output_string)
 }