vlaamscodex
v0.2.5
Published
Platskript transpiler toolchain (Multi-Vlaams dialect) packaged for npm as a thin wrapper around the Python implementation.
Maintainers
Readme
VlaamsCodex - Multi-Vlaams Editie 🇧🇪
't Es simpel, 't es plansen, 't es Vlaams!
A transpiler toolchain for Platskript (.plats), a programming language that uses Flemish dialect keywords. VlaamsCodex compiles Platskript source code to Python and executes it.
NEW in v0.2.5: Browser playground + fixed website examples + improved compiler support (als/zolang, safer plakt).
Quick Start
# Install
pip install vlaamscodex
# Run your first program
plats run examples/hello.plats
# Or use magic mode - run .plats directly with Python!
python examples/hello.platsOutput:
gdag aan weeireldMulti-Vlaams Dialect Commands 🇧🇪
Every command works in 7 Flemish dialects! Use whichever feels most natural:
Run a Program
| Dialect | Command | Meaning |
|---------|---------|---------|
| English | plats run script.plats | Run |
| West-Vlaams | plats voertuut script.plats | Voer 't uut |
| Antwerps | plats doet script.plats | Doe 't |
| Limburgs | plats gaon script.plats | Gaan |
| Brussels | plats doeda script.plats | Doe da |
Interactive REPL
plats repl # English
plats proboir # West-Vlaams: proberen
plats smos # Antwerps: praten/uitproberen
plats efkes # Limburgs: eventjes
plats praot # Brussels: pratenBrowse Examples
plats examples # List all examples
plats tuuntnekeer # West-Vlaams: toon eens
plats toondada # Antwerps: toon da da
plats loatskiejn # Limburgs: laat 's kijken
plats examples --run hello # Run an exampleCheck Syntax
plats check script.plats # English
plats zijdezekers script.plats # West-Vlaams: zijt ge zeker?
plats istdagoe script.plats # Antwerps: is da goe?
plats kloptda script.plats # Limburgs: klopt da?Error messages come in your dialect:
Manneke, gij zijt 'amen' vergeten op lijn 5! (Antwerps)
Jansen, ge zijt 'amen' vergeten op lijn 5! (West-Vlaams)Create a New Project
plats init myproject # English
plats allehop mijnproject # West-Vlaams: hier gaan we!
plats awel mijnproject # Antwerps: kom, we beginnen
plats allei mijnproject # Limburgs: vooruit danFlemish Fortune (Easter Egg!)
plats fortune # Random Flemish proverb
plats zegt # West-Vlaams: "zen moeder zegt..."
plats watteda # Antwerps: wat is da?
plats wiste # Limburgs: wist ge dat?Example output:
╔════════════════════════════════════════╗
║ Beter een vogel in de hand dan tien ║
║ op 't dak, jong! ║
╚════════════════════════════════════════╝All Dialect Aliases
| Command | Standard | West-Vlaams | Antwerps | Limburgs | Brussels | Genks |
|---------|----------|-------------|----------|----------|----------|-------|
| run | loop | voertuut | doet | gaon | doeda | jaowdoen |
| repl | repl | proboir | smos | efkes | praot | babbel |
| examples | examples | tuuntnekeer | toondada | loatskiejn | toontmansen | jaowkiek |
| check | check | zijdezekers | istdagoe | kloptda | isdagoe | istokin |
| init | init | allehop | awel | allei | maakaan | pakaan |
| fortune | fortune | zegt | watteda | wiste | spreuk | jaowzegt |
| build | bouw | moakt | bouwt | maakt | fabrikeert | bouwt |
| help | haalp | hulpe | helptemij | helpt | aidez | hulp |
Installation
Option A: pip (Recommended)
pip install vlaamscodexOption B: pipx (Isolated)
pipx install vlaamscodexOption C: Development
git clone https://github.com/brentishere41848/Vlaams-Codex.git
cd Vlaams-Codex
pip install -e ".[dev]"Example Programs
Hello World
# coding: vlaamsplats
plan doe
zet naam op tekst weeireld amen
maak funksie groet met wie doe
klap tekst gdag plakt spatie plakt tekst aan plakt spatie plakt da wie amen
gedaan
roep groet met da naam amen
gedaanCalculator
# coding: vlaamsplats
plan doe
zet x op getal 10 amen
zet y op getal 5 amen
zet som op da x derbij da y amen
klap da som amen
zet verschil op da x deraf da y amen
klap da verschil amen
zet product op da x keer da y amen
klap da product amen
gedaanRun Built-in Examples
plats examples --list # Show all examples
plats examples --show hello # View the code
plats examples --run rekenen # Run calculator exampleMagic Mode
Platskript files with the encoding header can run directly with Python:
# coding: vlaamsplats
plan doe
klap tekst hallo amen
gedaanpython script.plats # Works after installing VlaamsCodex!Language Specification (v0.1)
Program Structure
Programs are wrapped in plan doe ... gedaan. Statements terminate with amen.
Statements
| Syntax | Description |
|--------|-------------|
| zet <var> op <expr> amen | Variable assignment |
| klap <expr> amen | Print expression |
| maak funksie <name> met <params...> doe ... gedaan | Function definition |
| roep <name> met <args...> amen | Function call |
| geeftterug <expr> amen | Return statement |
Expressions
| Syntax | Description |
|--------|-------------|
| tekst <words...> | String literal |
| getal <digits> | Numeric literal |
| da <name> | Variable reference |
| spatie | Space character |
| plakt | String concatenation |
Operators
| Platskript | Python | Description |
|------------|--------|-------------|
| derbij | + | Addition |
| deraf | - | Subtraction |
| keer | * | Multiplication |
| gedeeld | / | Division |
| isgelijk | == | Equals |
| isniegelijk | != | Not equals |
| isgroterdan | > | Greater than |
| iskleinerdan | < | Less than |
VS Code Extension
Install the VlaamsCodex extension for syntax highlighting:
- Open VS Code
- Go to Extensions (Ctrl+Shift+X)
- Search for "VlaamsCodex"
- Click Install
Documentation
- Overview
- How Python Runs It
- Packaging & Installation
- Language Specification
- Security Notes
- User Guide
- CLI Documentation
Contributing
Contributions are welcome! Please read our Contributing Guidelines before submitting a pull request.
Bugs? Ideas? Open an issue!
License
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ in Flanders
't Es simpel, 't es plansen!
