How bsfishy/boa works
Project's Purpose and Type
• This is a language design project for “boa,” wherein the creator is experimenting with language design ideas, API choices, standard library structure, and language features.
• It isn’t a typical full-stack application or an operational tool yet—it is mostly about design documentation, exploratory code in the src directory, and example programs.
File Structure
• Top-level files and configurations: Files like .envrc, .gitignore, build.zig, flake.nix, and zls.json indicate that a build system (using Zig as the main tool) and development environment configurations are set up.
• The src directory contains key modules:
• boac.zig – likely the main driver or compiler shell for the language.
• lexer.zig – responsible for tokenizing the language input.
• parser.zig – constructs parsing logic to create an abstract syntax tree (AST) or similar structure.
• tools.zig – helper utilities or tools that support the design or development of the language.
• The examples directory holds sample “.boa” files (like add.boa, hello_world.boa, postfix.boa, vtable.boa) which illustrate the language's syntax or test its features.
• The presence of documentation files (README.md, notes.md) emphasizes that the repository is used for design notes and experimental ideas.
README Content
• The README explains that “boa” is in the design and experimentation phase. Its focus is on sorting out how APIs will function and what language features should be implemented.
• It indicates that when implementation begins, it will likely be housed within this repository.
• The current role is to collect notes, design ideas, and experiment with language features rather than to provide a finished compiler or runtime.
• Component (e.g., Lexer, Parser, Compiler Driver, Tools, Examples, Build Environment) is clearly labeled.
• Dependencies or interactions (for example, the reliance of boac.zig on both lexer.zig and parser.zig).