readme.md

🤖 TinyCompTS

A tiny (~ 26kb) Javascript/Typescript compiler written in vanilla Typescript as a hobby project.

🦾 Capabilities

• Tokens: Maximum Munch, RegEx matching
• Syntax:
  • Recursive descent parser
    • → linear time complexity
    • → support for LL-Type Context Free Grammars
  • Quantifier support (→ see example SyntaxRuleset):
    • ? = zero or one
    • * = zero or more
    • + = one or more
• Semantics: Bottom-up, demand driven evaluation
  • → support for arbitrary, non-recursive Attribute Grammars

📖 Guide

1. Define an attribute grammar

Create an object that implements AttributeGrammar:

1. Define a lexical ruleset by creating an object that implements LexicalRuleset
2. Define a syntax ruleset by creating an object that implements SyntaxRuleset
3. Define a semantic ruleset by creating an object that implements SemanticRuleset

2. Configure TinyComp

1. Create an object that implements TinyCompOptions
2. Create an instance of TinyComp using the AttributeGrammar and TinyCompOptions object
3. Use compiler.compile(input: string) to compile input

📔 Example

→ see example.ts

Import

🦖 Denoland

import TinyComp, {...} from "https://deno.land/x/tiny_comp_ts/ts/TinyComp.ts";

❤️ Npm

npm i tiny-comp

import TinyComp, {...} from "tiny-comp";

🧪 Just test

1. Install the JS/TS runtime Deno
2. Clone this repo & navigate into the root directory
3. deno run ./example.ts

Alternatively, run via docker

1. Clone this repo & navigate into the root directory
2. docker run -it -v $PWD:/app denoland/deno:1.17.1 run --allow-net /app/example.ts

👨‍💻 Development

Contributing

Feel free to make a pull request if you like. Keep it minimal and efficient.

Codebase diagram: