Implement RecursiveIterator
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start with the traversal code in src/Node.php around the Generator implementation linked in the issue, then review how the parser represents child nodes. Define what class-based RecursiveIterator support should cover, including hasChildren(), getChildren(), filtering, and skipping children; done means traversal can be composed through the PHP iterator APIs described in the issue.
Written by the indexing model from the issue text.
Description
PHP has native interfaces and classes for Iterators (Generator implements Iterator). Iterators can be traversed with foreach and composed easily, for example by filtering through CallbackFilterIterator.
In particular, it has the RecursiveIterator interface, that adds two more methods to implement: hasChildren() and getChildren().
This allows it to be traversed with a RecursiveIteratorIterator, which has countless options for emitting all nodes or just leaves, using level order, etc. ParentIterator can be used to visit just nodes with child nodes, RecursiveLimitIterator to limit the nodes traversed, AppendIterator to concatenate Iterators, RecursiveTreeIterator can be used to draw an ASCII tree of an AST and RecursiveCallbackFilterIterator to filter nodes (including skipping children). Really a lot of awesome stuff in there.
The Parser already uses Generators for traversal, which is great, but it only has limited options for filtering and skipping certain children through a callback: https://sourcegraph.com/github.com/Microsoft/tolerant-php-parser/-/blob/src/Node.php#L158-159
I think providing class-based implementations for Iterators would give greater flexibility.
- Dominant language
- PHP
- Stars
- 894
- Forks
- 85
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/tolerant-php-parser
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
microsoft/tolerant-php-parser#423 ·
-
New release request Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
microsoft/tolerant-php-parser#420 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
microsoft/tolerant-php-parser#417 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
microsoft/tolerant-php-parser#413 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
microsoft/tolerant-php-parser#407 · 2 comments ·
All issues in microsoft/tolerant-php-parser
Similar issues
-
priority: p3
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
googleapis/librarian#7636 ·
-
0. Needs triage bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nextcloud/fulltextsearch#1011 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
phpstan/phpstan-doctrine#794 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Automattic/static-site-importer#1767 ·