🌶️
FlavorLang
"Cook 'n' Code"

FlavorLang blends coding with culinary creativity! Write programs like recipes — add ingredients, cook, and serve ideas with unique keywords that make coding as fun and flavorful as your imagination.

---

Important

FlavorLang is currently in Beta. While core functionality is largely stable, new features, syntax, and language designs are subject to change without prior notice.

Please feel free to contribute by reporting any issues or suggestions in the repository's Issues.

---

📖 Table of Contents

README.md

1. 🌶️ Why FlavorLang?

2. ⚡ Quick Start

3. 🚀 Terminal Flags & Behaviors

4. 🎨 Install Syntax Highlighter Extension

docs/

5. 📚 Tutorial

6. 📦 Standard Library

7. 🔌 Creating & Using Plugins

8. 🧠 Brainf Interpreter

9. 🐞 Debugging

10. 🛠️ Language Design

11. 🔤 Lexer

12. 📜 Parser

13. 🌀 Interpreter

14. 🌟 Resources & Inspirations

---

🌶️ Why FlavorLang?

• Unique & Fun: Express your programs like recipes!
• Flexible Execution: File extensions and flags allow customized program behavior.
• Readable Syntax: Keywords like add, mix, cook, and deliver make code approachable and enjoyable.
• Debug-Friendly: Easily trace and test your code step-by-step with --debug mode.

---

⚡ Quick Start

Get up and running with FlavorLang in just a few steps!

1. Install the Compiler

For macOS Users

1. Download & Extract the ZIP

Latest FlavorLang Release

2. Run the Install Script

$ bash install.sh

3. Handle macOS Security Prompt (If Any)

• If macOS prompts a security warning, navigate to System Preferences > Security & Privacy > General.
• Click Open Anyway for flavor.

4. Verify Installation

$ flavor --about

Note

If this step fails (expected on macOS due to security) go back to step 3.

For Ubuntu Users

1. Download & Extract the ZIP

Latest FlavorLang Release

2. Run the Install Script

$ bash install.sh

3. Verify Installation

$ flavor --about

Make it Yourself

$ git clone https://github.com/KennyOliver/FlavorLang.git
$ cd src
$ make

Warning

Unless you move flavor to /usr/local/bin/, you'll have to use ./flavor for commands with relative file paths.

2. Write Your First Recipe

# recipe.flv

serve("Welcome to FlavorLang!");

3. Run the Program

$ flavor recipe.flv

Welcome to FlavorLang!

4. Debug Your Code

Enable debug mode to inspect tokens and execution flow.

$ flavor recipe.flv --debug

This will print detailed information about the tokenization and parsing process.

---

🚀 Terminal Flags & Behaviors

$ flavor recipe.flv            # Run a FlavorLang script
$ flavor recipe.flv --debug    # Debug mode (verbose output)
$ flavor recipe.flv --minify   # Minify the script (creates recipe.min.flv)
$ flavor --about               # Show information about FlavorLang
$ flavor --github              # Open the GitHub repository

Command	Description
flavor recipe.flv	Run a FlavorLang script
flavor recipe.flv --debug	Debug mode (verbose output)
flavor recipe.flv --minify	Minify script (recipe.min.flv)
flavor --about	Show info about FlavorLang
flavor --github	Open GitHub repository

Note

The --debug flag is especially useful for understanding how FlavorLang processes your file, including tokenizing, parsing, and interpreting.

---

🎨 Install the VS Code Syntax Highlighter

Installation Instructions

1. Download & Extract the ZIP (FlavorLang Releases)

2. Open VS Code and Navigate to the Extensions Tab

3. Click the ... Menu and Select Install from VSIX...

4. Restart your Extensions via the Popup Notification

Make it Yourself

1. Build the Extension

Navigate to the vscode-extension folder and install dependencies:

$ cd vscode-extension
$ npm install

2. Package the Extension

Use vsce (Visual Studio Code Extension Manager) to build the .vsix package:

$ npx vsce package

3. Install in VS Code

• Open VS Code.
• Press ⌘⇧P (CtrlShiftP on Windows) and select Extensions: Install from VSIX….
• Select the generated .vsix file within the vscode-extension folder.
• Restart your extensions via the popup notification.

---

License

This project is licensed under the Apache 2.0 License — see the LICENSE file for details.

© 2024-2025 Kenneth Oliver. All rights reserved.