maride/php-parser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Vadym Slizov 2018-06-07 19:52:44 +03:00 committed by GitHub
parent af379a61dd
commit 9f0d4b02c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -15,6 +15,8 @@ PHP Parser written in Go
[![Exago](https://api.exago.io:443/badge/cov/github.com/z7zmey/php-parser)](https://exago.io/project/github.com/z7zmey/php-parser) [![Exago](https://api.exago.io:443/badge/cov/github.com/z7zmey/php-parser)](https://exago.io/project/github.com/z7zmey/php-parser)
[![GoDoc](https://godoc.org/github.com/z7zmey/php-parser?status.svg)](https://godoc.org/github.com/z7zmey/php-parser) [![GoDoc](https://godoc.org/github.com/z7zmey/php-parser?status.svg)](https://godoc.org/github.com/z7zmey/php-parser)
This project uses [goyacc](https://godoc.org/golang.org/x/tools/cmd/goyacc) and [golex](https://github.com/cznic/golex) libraries to parse PHP sources into [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree). It can be used to write static analysis, refactoring, metrics, code style formatting tools.
#### Try it online: [demo](https://php-parser.com) #### Try it online: [demo](https://php-parser.com)
Features: Features:
@ -29,7 +31,7 @@ Features:
Roadmap Roadmap
------- -------
- Saving comments and empty lines - Pretty printer
- Control Flow Graph (CFG) - Control Flow Graph (CFG)
- PhpDocComment parser - PhpDocComment parser
- Stabilize api - Stabilize api
@ -45,7 +47,7 @@ CLI
--- ---
``` ```
php-parser [-php5] <path> ... php-parser [-php5 -noDump] <path> ...
``` ```
Dump AST to stdout. Dump AST to stdout.
@ -100,8 +102,8 @@ Parsing syntax-invalid PHP files
If we try to parse `$a$b;` then the parser triggers error 'syntax error: unexpected T_VARIABLE'. Token `$b` is unexpected, but parser recovers parsing process and returns `$b;` statement to AST, because it is syntactically correct. If we try to parse `$a$b;` then the parser triggers error 'syntax error: unexpected T_VARIABLE'. Token `$b` is unexpected, but parser recovers parsing process and returns `$b;` statement to AST, because it is syntactically correct.
Pretty printer Pretty printer [work in progress]
-------------- ---------------------------------
```Golang ```Golang
nodes := &stmt.StmtList{ nodes := &stmt.StmtList{
@ -123,14 +125,14 @@ nodes := &stmt.StmtList{
}, },
}, },
Extends: &stmt.ClassExtends{ Extends: &stmt.ClassExtends{
ClassName: &name.Name{ ClassName: &name.Name{
Parts: []node.Node{ Parts: []node.Node{
&name.NamePart{ &name.NamePart{
Value: "Baz" Value: "Baz"
}, },
}, },
}, },
}, },
Stmts: []node.Node{ Stmts: []node.Node{
&stmt.ClassMethod{ &stmt.ClassMethod{
Modifiers: []node.Node{ Modifiers: []node.Node{
@ -164,9 +166,9 @@ It prints to stdout:
namespace Foo; namespace Foo;
abstract class Bar extends Baz abstract class Bar extends Baz
{ {
public function greet() public function greet()
{ {
echo 'Hello world'; echo 'Hello world';
} }
} }
``` ```