tysonandre/php-parser-to-php-ast

A pure PHP substitute for nikic/php-ast, using nikic/php-parser. Can also be used to generate php-ast trees, even for files with some types of syntax errors.

0.2.1 2020-03-12 00:43 UTC

This package is auto-updated.

Last update: 2020-06-12 01:26:11 UTC


README

Build Status Build status (Windows)

This converts ASTs(Abstract Syntax Trees) from PHP-Parser to php-ast. It can be used as a PHP-only implementation of php-ast. It can alternatively be used as a best-effort parser for syntactically valid PHP code.

Also see https://github.com/TysonAndre/tolerant-php-parser-to-php-ast (in progress, may have better results)

Supported php-ast AST versions: 40, 45, 50

Current Status

No tests are failing

  • Need to normalize namespaces (Mostly done)

Current Issues

Remaining work:

  • Translate PhpParser exception to a \ParseError instance

Usage

Using it as a slow substitute for php-ast

Using it as an error-tolerant substitute for php-ast: (e.g. for use in IDEs)

  • There are currently two modes: omitting errors and adding placeholders (e.g. __INCOMPLETE_VARIABLE__).
  • Omitting errors only handles some common cases that come up while editing a file.
  • Placeholders may change in the future.
  • tests/ASTConverter/ErrorTolerantConversionTest.php
  • If performance is an issue, cache previous results for a file's contents (in combination with the version used to generate the file ASTConversion::ASTCONVERTER_VERSION)

Running unit tests

To run unit tests, you must install nikic/php-ast. A version supporting AST versions 40 and/or 50 should be installed (~0.1.5 is preferred)

  • Then run vendor/bin/phpunit

Possible Future Enhancements