# metaf-parser-ts

> MetaF Parser is a typescript library that utilizes ANTLR4 grammars to parse scripts written in the Metaf language to an easy to work with model format.

Latest version **0.1.2** (published 2023-12-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install metaf-parser-ts
pnpm add metaf-parser-ts
yarn add metaf-parser-ts
bun add metaf-parser-ts
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2023-12-16 |
| First published | 2023-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 504.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | metaf |
| Maintainers | trev.is |

## Links

- npm: https://www.npmjs.com/package/metaf-parser-ts
- Homepage: https://gitlab.com/metaf/metaf-parser-ts
- npm.io page: https://npm.io/package/metaf-parser-ts

## Dependencies (1)

- [antlr4ng](https://npm.io/package/antlr4ng.md) ^2.0.2

## Recent versions

- 0.1.2 (latest) — 2023-12-16
- 0.1.1 — 2023-12-16
- 0.1.0 — 2023-12-15
- 0.0.6 — 2023-12-14
- 0.0.5 — 2023-12-13
- 0.0.4 — 2023-12-07
- 0.0.3 — 2023-12-07
- 0.0.2 — 2023-12-06
- 0.0.1 — 2023-11-26

## README

# Metaf Parser

metaf-parser-ts is a typescript library that utilizes ANTLR4 grammars to parse scripts written in the Metaf language to an easy to work with model format.

## Features

- **ANTLR4 Grammar:** The project includes a comprehensive ANTLR4 grammar for the Metaf language, defining the syntax and structure of the scripts.

- **Model Parser:** A typescript class (`ModelParser`) with a simplified interface for turning meta file contents into a `Meta` model.

- **Meta Model:** The `Meta` model represents the structured information extracted from Metaf scripts, including states, rules, conditions, actions, nav routes, and more.

## Installation

`npm install metaf-parser-ts`

## Example

```typescript
import { ModelParser } from 'metaf-parser-ts'

const afContents = "..."; // Your Metaf script here
const parser = new ModelParser(afContents);
const parseResult = parser.tryParse();

if (!parseResult.success || parseResult.meta == null) {
	// check parser.ErrorHandler.Errors for a list of parser errors.
}
else {
	// Now you can use the 'meta' object to access the parsed information
	for (const state of parseResult.meta.States) {
		// do stuff
	}
}
```

## Updating the grammar

To update the grammar, update the lexer/parser .g4 grammar files and run `npm run antlr4ts`. The updated parser / lexer code should be automatically generated to the `./gen/` directory.

You also need to manually add the following line to the top of the generated `./gen/MetaFlexer.ts` file:
```typescript
import { MetaFLexerBase } from "./../src/lib/MetaFLexerBase";
```

## Building release

```
npm run build
```

## Contributions

Contributions are welcome! If you find any issues, have suggestions, or want to improve the project, feel free to submit a pull request or open an issue on the GitLab repository.


## License

This project is licensed under the MIT License.

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