php-parser/README.md

106 lines
3.1 KiB
Markdown
Raw Normal View History

2018-05-16 11:02:28 +00:00
PHP Parser written in Go
========================
2018-04-10 20:45:26 +00:00
<img src="./parser.jpg" alt="PHP Parser written in Go" width="980"/>
2018-01-09 16:36:06 +00:00
2018-02-19 12:34:49 +00:00
[![GoDoc](https://godoc.org/github.com/z7zmey/php-parser?status.svg)](https://godoc.org/github.com/z7zmey/php-parser)
2018-08-06 18:16:47 +00:00
[![Build Status](https://travis-ci.org/z7zmey/php-parser.svg?branch=master)](https://travis-ci.org/z7zmey/php-parser)
[![Go Report Card](https://goreportcard.com/badge/github.com/z7zmey/php-parser)](https://goreportcard.com/report/github.com/z7zmey/php-parser)
[![Maintainability](https://api.codeclimate.com/v1/badges/950783b2e739db26e0ed/maintainability)](https://codeclimate.com/github/z7zmey/php-parser/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/950783b2e739db26e0ed/test_coverage)](https://codeclimate.com/github/z7zmey/php-parser/test_coverage)
2018-01-09 16:36:06 +00:00
2018-06-07 16:52:44 +00:00
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.
2018-03-04 13:47:41 +00:00
#### Try it online: [demo](https://php-parser.com)
2018-05-16 11:02:28 +00:00
Features:
---------
2018-04-10 20:45:26 +00:00
- Fully support PHP 5 and PHP 7 syntax
- Abstract syntax tree (AST) representation
2018-01-09 16:36:06 +00:00
- Traversing AST
2019-02-25 15:01:06 +00:00
- Resolving namespaced names
- Parsing syntax-invalid PHP files
- Saving and printing free-floating comments and whitespaces
2018-04-10 20:45:26 +00:00
2019-03-06 08:35:38 +00:00
Usage example
2018-05-16 11:02:28 +00:00
-------
2018-01-12 08:04:31 +00:00
```Golang
package main
import (
2018-04-10 12:51:00 +00:00
"fmt"
2018-01-12 08:04:31 +00:00
"bytes"
"os"
2018-01-12 08:04:31 +00:00
2018-02-04 19:49:53 +00:00
"github.com/z7zmey/php-parser/php7"
2018-01-12 08:04:31 +00:00
"github.com/z7zmey/php-parser/visitor"
)
func main() {
2018-01-12 08:17:41 +00:00
src := bytes.NewBufferString(`<? echo "Hello world";`)
2018-04-09 20:30:44 +00:00
2018-04-10 12:51:00 +00:00
parser := php7.NewParser(src, "example.php")
parser.Parse()
for _, e := range parser.GetErrors() {
fmt.Println(e)
}
2018-01-12 08:04:31 +00:00
2018-02-04 19:35:46 +00:00
visitor := visitor.Dumper{
2018-04-09 20:30:44 +00:00
Writer: os.Stdout,
2018-02-04 19:35:46 +00:00
Indent: "",
2018-04-10 12:51:00 +00:00
Comments: parser.GetComments(),
Positions: parser.GetPositions(),
2018-02-04 19:35:46 +00:00
}
2018-04-10 12:51:00 +00:00
rootNode := parser.GetRootNode()
rootNode.Walk(visitor)
2018-01-12 08:04:31 +00:00
}
```
2019-03-06 08:35:38 +00:00
Who Uses
--------
[VKCOM/noverify](https://github.com/VKCOM/noverify) - NoVerify is a pretty fast linter for PHP
Roadmap
-------
- Control Flow Graph (CFG)
- PhpDocComment parser
- Stabilize api
Install
-------
```
go get github.com/z7zmey/php-parser
```
CLI
---
```
php-parser [flags] <path> ...
```
| flag | type | description |
|-------|------|----------------------------------------------|
| -d |string| dump format: [custom, go, json, pretty-json] |
| -r | bool | resolve names |
| -ff | bool | parse and show free floating strings |
| -prof |string| start profiler: [cpu, mem, trace] |
| -php5 | bool | parse as PHP5 |
Dump AST to stdout.
2018-05-16 11:02:28 +00:00
Namespace resolver
------------------
2018-02-06 10:52:31 +00:00
2018-04-10 20:45:26 +00:00
Namespace resolver is a visitor that resolves nodes fully qualified name and saves into `map[node.Node]string` structure
2018-02-06 10:52:31 +00:00
2018-04-10 20:45:26 +00:00
- For `Class`, `Interface`, `Trait`, `Function`, `Constant` nodes it saves name with current namespace.
- For `Name`, `Relative`, `FullyQualified` nodes it resolves `use` aliases and saves a fully qualified name.