Skip to content

Commit e4e8dfc

Browse files
committed
Update README.md
1 parent afd07c5 commit e4e8dfc

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,28 @@ PHP-Parser to php-ast
33

44
[![Build Status](https://travis-ci.org/TysonAndre/php-parser-to-php-ast.svg?branch=master)](https://travis-ci.org/TysonAndre/php-parser-to-php-ast)
55

6-
This is incomplete. Only 6 of 28 tests are passing.
6+
5 out of 28 tests are failing, and only due to line numbers being wrong in php-ast. This is fixed in php 7.1-dev (will be in 7.1.4)
7+
8+
[Current Issues](https://github.com/TysonAndre/php-parser-to-php-ast/issues/)
9+
10+
- The test suite this is based off of is not comprehensive, and edge cases still remain.
11+
See https://github.com/TysonAndre/php-parser-to-php-ast/issues/4
12+
13+
Usage
14+
-----
15+
16+
Using it as a slow substitute for php-ast
17+
18+
- [tests/ASTConverter/ConversionTest.php](https://github.com/TysonAndre/php-parser-to-php-ast/blob/master/tests/ASTConverter/ConversionTest.php)
19+
20+
Using it as an error-tolerant substitute for php-ast (e.g. for use in IDEs)
21+
22+
- There are currently two modes: omitting errors and adding placeholders (e.g. `__INCOMPLETE_VARIABLE__`).
23+
- Omitting errors only handles some common cases that come up while editing a file.
24+
- Placeholders may change in the future.
25+
- [tests/ASTConverter/ErrorTolerantConversionTest.php](https://github.com/TysonAndre/php-parser-to-php-ast/blob/master/tests/ASTConverter/ErrorTolerantConversionTest.php)
26+
27+
Possible Future Enhancements
28+
----------------------------
29+
30+
- https://github.com/Microsoft/tolerant-php-parser/issues/113

0 commit comments

Comments
 (0)