parser/README.md
azjezz c25fe105f9
chore: fix readme code
Signed-off-by: azjezz <azjezz@protonmail.com>
2022-12-05 20:17:21 +01:00

1.6 KiB

PHP-Parser

A handwritten recursive-descent parser for PHP written in Rust, for fun.

justforfunnoreally.dev badge

Warning

: This crate is not ready for any form of production use yet. There are still a lot of things missing from the parser, so please use at your own risk.


Usage

Add php-parser-rs in your Cargo.toml's dependencies section

[dependencies]
php-parser-rs = "0.0.0-b1"

or use cargo add

cargo add php-parser-rs

Example

use php_parser_rs::prelude::*;

fn main() -> ParseResult<()> {
    let lexer = Lexer::new();
    let parser = Parser::new();

    let code = "
<?php

function hello(): void {
    echo 'Hello, World!';
}

hello();
    ";

    let tokens = lexer.tokenize(code.as_bytes())?;
    let ast = parser.parse(tokens)?;

    dbg!(ast);

    Ok(())
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Credits