Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VKCOM/php-parser
PHP parser written in Go
https://github.com/VKCOM/php-parser
Last synced: 2 months ago
JSON representation
PHP parser written in Go
- Host: GitHub
- URL: https://github.com/VKCOM/php-parser
- Owner: VKCOM
- License: mit
- Archived: true
- Created: 2021-07-28T14:04:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-23T02:23:02.000Z (over 1 year ago)
- Last Synced: 2024-09-26T21:41:38.985Z (4 months ago)
- Language: Go
- Homepage: https://php-parser.com
- Size: 11.7 MB
- Stars: 69
- Watchers: 7
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- go-awesome - VKCOM/php-parse - PHP AST parsing (Open source library / Interpreter)
README
> This is a fork of the [z7zmey](https://github.com/z7zmey) [parser](https://github.com/z7zmey/php-parser) that adds PHP 8 support.
PHP Parser written in Go
========================
[](https://godoc.org/github.com/VKCOM/php-parser)
[](https://github.com/VKCOM/php-parser/workflows/Go)
[](https://goreportcard.com/report/github.com/VKCOM/php-parser)
This project uses [goyacc](https://godoc.org/golang.org/x/tools/cmd/goyacc) and [ragel](https://www.colm.net/open-source/ragel/) tools to create PHP parser. It parses source code into [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree). It can be used to write static analysis, refactoring, metrics, code style formatting tools.
Features
---------
- Fully support PHP 5, PHP 7 and PHP 8.0-8.2 syntax
- Abstract syntax tree (AST) representation
- Traversing AST
- Resolving namespace names
- Parsing syntax-invalid PHP files
- Saving and printing free-floating comments and whitespaces
Who Uses
--------
- [VKCOM/noverify](https://github.com/VKCOM/noverify) — pretty fast linter for PHP
- [VKCOM/nocolor](https://github.com/VKCOM/nocolor) — architecture validation tool for PHP based on the [*concept of colored functions*](https://github.com/VKCOM/nocolor/blob/master/docs/introducing_colors.md)
- [quasilyte/phpgrep](https://github.com/quasilyte/phpgrep) — tool for syntax-aware PHP code search
Usage example
-------
```Golang
package main
import (
"log"
"os"
"github.com/VKCOM/php-parser/pkg/conf"
"github.com/VKCOM/php-parser/pkg/errors"
"github.com/VKCOM/php-parser/pkg/parser"
"github.com/VKCOM/php-parser/pkg/version"
"github.com/VKCOM/php-parser/pkg/visitor/dumper"
)
func main() {
src := []byte(` 0 {
for _, e := range parserErrors {
log.Println(e.String())
}
os.Exit(1)
}
// Dump
goDumper := dumper.NewDumper(os.Stdout).
WithTokens().
WithPositions()
rootNode.Accept(goDumper)
}
```
Install
-------
```
go get github.com/VKCOM/php-parser/cmd/php-parser
```
CLI
---
```
php-parser [flags] ...
```
| flag | type | description |
|------------|----------|-------------------------------------|
| `-p` | `bool` | Print file paths |
| `-e` | `bool` | Print errors |
| `-d` | `bool` | Dump AST in Golang format |
| `-r` | `bool` | Resolve names |
| `--pb` | `bool` | Print AST back into the parsed file |
| `--time` | `bool` | Print execution time |
| `--prof` | `string` | Start profiler: `[cpu, mem, trace]` |
| `--phpver` | `string` | PHP version (default: 8.0) |
Namespace resolver
------------------
Namespace resolver is a visitor that resolves nodes fully qualified name and saves into `map[node.Node]string` structure
- 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.