# tiny-comp

> A tiny JS/TS compiler written in vanilla TS.

Latest version **1.3.0** (published 2022-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install tiny-comp
pnpm add tiny-comp
yarn add tiny-comp
bun add tiny-comp
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2022-03-05 |
| First published | 2022-02-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 98.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Maintainers | alex_w_00 |

## Links

- npm: https://www.npmjs.com/package/tiny-comp
- Repository: https://github.com/AlexW00/TinyCompTS
- Homepage: https://github.com/AlexW00/TinyCompTS#readme
- Issues: https://github.com/AlexW00/TinyCompTS/issues
- npm.io page: https://npm.io/package/tiny-comp

## Recent versions

- 1.3.0 (latest) — 2022-03-05
- 1.2.9 — 2022-03-05
- 1.2.8 — 2022-03-03
- 1.2.7 — 2022-02-26
- 1.2.6 — 2022-02-26
- 1.2.5 — 2022-02-26
- 1.2.4 — 2022-02-26
- 1.2.3 — 2022-02-26
- 1.2.2 — 2022-02-26
- 1.2.1 — 2022-02-26
- 1.2.0 — 2022-02-26

## README

<div align="center"> 
<h1>🤖 TinyCompTS</h1>

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

## 🦾 Capabilities

- **Tokens**: [Maximum Munch](https://en.wikipedia.org/wiki/Maximal_munch), RegEx matching
- **Syntax**: 
  - [Recursive descent parser](https://en.wikipedia.org/wiki/Recursive_descent_parser)
    - → linear time complexity
    - → support for [LL-Type Context Free Grammars](https://en.wikipedia.org/wiki/LL_grammar)
  - Quantifier support (→ see example [SyntaxRuleset](/ts/attributeGrammar/syntaxRuleset.ts)):
    - `?` = zero or one
    - `*` = zero or more
    - `+` = one or more
- **Semantics**: Bottom-up, demand driven evaluation
  - → support for arbitrary, non-recursive [Attribute Grammars](https://en.wikipedia.org/wiki/Attribute_grammar)

## 📖 Guide

### 1. Define an **attribute grammar**

Create an object that implements [AttributeGrammar](/ts/attributeGrammar/attributeGrammar.ts):

1. Define a lexical ruleset by creating an object that implements [LexicalRuleset](/ts/attributeGrammar/lexicalRuleset.ts)
2. Define a syntax ruleset by creating an object that implements [SyntaxRuleset](/ts/attributeGrammar/syntaxRuleset.ts)
3. Define a semantic ruleset by creating an object that implements [SemanticRuleset](/ts/attributeGrammar/semanticRuleset.ts)

### 2. Configure TinyComp

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

## 📔 Example 

→ see [example.ts](/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](https://deno.land/)
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.

---
_Source: https://npm.io/package/tiny-comp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._