# @idyllic/compiler

> Compiler source for the Idyllic API engine

Latest version **0.1.12** (published 2021-02-08) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @idyllic/compiler
pnpm add @idyllic/compiler
yarn add @idyllic/compiler
bun add @idyllic/compiler
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.12 |
| Published | 2021-02-08 |
| First published | 2021-02-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 355.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 55 |
| Author | Rishi Kothari |
| Maintainers | rishiosaur |

## Links

- npm: https://www.npmjs.com/package/@idyllic/compiler
- Repository: https://github.com/rishiosaur/idyllic
- Homepage: https://github.com/rishiosaur/idyllic#readme
- Issues: https://github.com/rishiosaur/idyllic/issues
- npm.io page: https://npm.io/package/@idyllic/compiler

## Recent versions

- 0.1.12 (latest) — 2021-02-08
- 0.1.7 — 2021-02-07
- 0.1.6 — 2021-02-07
- 0.1.5 — 2021-02-07
- 0.1.2 — 2021-02-07
- 0.1.1 — 2021-02-07
- 0.1.0 — 2021-02-06

## README

# `@idyllic/server`

Complete Typescript implementation of a compiler for the Idyllic Language.

## Usage

```typescript
import { IdyllicCompiler } from '@idyllic/compiler'
import * as util from 'util'
;(async () => {
	const compiled = await (await IdyllicCompiler.fromFile('spec.idl')).compile()

	console.log(util.inspect(compiled, false, null, true))
})()
```

## Structure

All source lives in the `src/` directory, as is the Typescript norm.

You can find the first stage of compilation (tokenization/lexing) & all associated models in the `lexer/` directory,
which holds the
`Lexer` class. Tokens & their types are also held here.

The next stage of the compilation pipeline is held in the `parser/` directory, along with all AST models.

The last three stages are held in the `compiler/` directory, and branch off from a single `Compiler` class, as
opposed to having individual classes for each. These last three stages can be fully chained with each other.

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