kawniy / go-parser

Golang parser written in PHP 8.1

GoParser

Golang (1.18) parser written in PHP 8.1

Installation

To install this package, run:

composer require tuqqu/go-parser

Example

use GoParser\Parser;

$program = <<<GO
    package main
    
    import "fmt"
    
    func main() {
        res := add(1, 2)
        fmt.Println("1+2 =", res)
    }
GO;

$parser = new Parser($program);
$ast = $parser->parse();
$errs = $parser->getErrors();

Supported language level: Go 1.18 (generics).

Parser is able to recover itself if a parse error occurs, in this case it will continue parsing at the closest node it is able to recognise.

The resulting AST will be as full as possible, and you have to check getErrors() to see errors.

Single declaration parsing

Parser can also handle a single declaration only (e.g. a single function), instead of a fully defined Go program:

use GoParser\{Parser, ParseMode};

$func = <<<GO
    func add(x, y int) int { 
        return x + y
    }
GO;

$parser = new Parser($func, mode: ParseMode::SingleDecl);
$decl = $parser->parseSingleDecl();

Abstract Syntax Tree

Parsing results in an Abstract Syntax Tree result. See src/Ast.

For the most part the AST nodes structure follows closely the official Golang specification.

Some Nodes may also have a bit different name (e.g. ExpressionList vs ExprList), but mostly the names are either the same or easily recognisable.

CLI

Package comes with a CLI command:

./vendor/bin/go-parser main.go [--flags]

By default, it uses a simple NodeDumper to print AST.

Use --help to see other options.