esther-medina-quintero-parser-nearley/README.md

Lab for language processors

[![Open in Codespaces](https://classroom.github.com/assets/launch-codespace-7f7980b617ed060a017424585567c406b6ee15c891e84e1186181d67ecf80aa0.svg)](https://classroom.github.com/open-in-codespaces?assignment_repo_id=14247780)
## Egg Parser

Egg Language utility. Translates egg programs into ASTs.

## Installation

```
npm i esther-medina-quintero-parser-nearley
```

## Usage from code:

```javascript
const { parseFromFile } = require('esther-medina-quintero-parser-nearley')
const example_file = "./testFile.txt"

console.log("Original Code: \n", example_code);
console.log("AST generated from code: \n", parseFromFile(example_code));
```

## Usage as executable:

An input file must be specified. You also may or may not specify an output file. If not given, it will default to the original file's name, with a .json extension.

```
npx eggc input_file --o output_file
```

## Examples

You can check various examples in the examples/ directory.

## Author

alu0101434780 (Esther M. Quintero) - [GitHub Profile](https://github.com/EstherMedinaQuintero)

## Tests

```
npm run test
```

## Version History

1.0.0 Initial Release
1.0.1 Added module documentation
1.0.2 Minor fixes
1.0.3 Added the parser
1.0.4 Added the builds
1.0.5 Added the tests
1.0.6 Documentation
1.1.0 Added new features
2.0.0 Breaking changes