https://github.com/felixfaisal/syntax-analyzer-rs

A syntax analyzer written in Rust with handwritten logic for validating JSON with trailing commas and comments without using Lex or YACC
https://github.com/felixfaisal/syntax-analyzer-rs

compiler lexer parser rust

Last synced: 15 days ago
JSON representation

A syntax analyzer written in Rust with handwritten logic for validating JSON with trailing commas and comments without using Lex or YACC

• Host: GitHub
• URL: https://github.com/felixfaisal/syntax-analyzer-rs
• Owner: felixfaisal
• Created: 2021-12-05T19:08:40.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-04T11:21:51.000Z (almost 3 years ago)
• Last Synced: 2024-10-24T16:21:10.728Z (2 months ago)
• Topics: compiler, lexer, parser, rust
• Language: Rust
• Homepage:
• Size: 25.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        
# Syntax-Analyzer-rs

A Rust binary crate that is used to validate JSON files with trailing commas,comments and multiline strings.

In order to solve this challenge, I'm using basics of Compiler Design concepts. So the program is divided into two parts 

    - Tokenizer (Lexical Analyzer)

    - Parser (Syntax Analyzer)

### Tokenizer

This scans the file and identifies tokens, So currently as of writing this. We are looking for the following tokens

```rust

pub enum TokenTypes {

    LeftBrace = 0, \\ {

    RightBrace,\\ }

    LeftBracket, \\ [

    RightBracket, \\ ]

    Colon, \\ :

    Comma, \\ ,

    String, 

    MultiLineString,

    Comment,

}

```

After getting all the tokens, We send the tokens to the parser

### Parser

A syntax analyzer basically constructs an **Abstract Syntax Tree** using **Context Free Grammar**. The difference here is that we are using CFG but not creating an AST as that goes beyond the scope of the problem statement. So we can check for productions according to the rules of ANON and parse the entire token list.

## How to run

```bash 

cargo run 

``` 

Here's an example 

```bash

felix@felix-TUF-Gaming-FX505DY-FX505DY ~/d/anonvalidator (main)> cargo run testcases/test_4.anon

   Compiling anonvalidator v0.1.0 (/home/felix/deepsource/anonvalidator)

    Finished dev [unoptimized + debuginfo] target(s) in 0.38s

     Running `target/debug/anonvalidator testcases/test_4.anon`

Valid file ✅

```

## Test Suite

There are couple of JSON files already which are being used for testing purposes and have been integrated with GitHub Actions, If you would like to run it locally then use the following command

```bash

cargo test 

```

**Output**

```bash

felix@felix-TUF-Gaming-FX505DY-FX505DY ~/d/anonvalidator (main)> cargo test

   Compiling anonvalidator v0.1.0 (/home/felix/deepsource/anonvalidator)

    Finished test [unoptimized + debuginfo] target(s) in 0.47s

     Running unittests (target/debug/deps/anonvalidator-5e245d5b622a2128)

running 5 tests

test tests::test_example_2 - should panic ... ok

test tests::test_example_1 - should panic ... ok

test tests::test_example_3 ... ok

test tests::test_example_4 ... ok

test tests::test_example ... ok

test result: ok. 5 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

```