allow WP_Parser\get_wp_files() to follow symlinks

Open
#212 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
52/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
php

Research direction

Locate WP_Parser\get_wp_files() and inspect where its RecursiveDirectoryIterator is instantiated. Update the iterator options so recursive traversal follows symlinks, then verify that the function includes files reached through symlinked directories without breaking normal traversal.

Written by the indexing model from the issue text.

Description

For those of us using this plugin outside of the .org Code Reference, it would be really helpful if WP_Parser\get_wp_files() could follow symlinks it encounters while recursing the directory structure.

All that would be necessary to enable this would be to instantiate the RecursiveDirectoryIterator with:

new \RecursiveDirectoryIterator( $directory, \FilesystemIterator::FOLLOW_SYMLINKS )

instead of the current:

new \RecursiveDirectoryIterator( $directory )
Dominant language
PHP
Stars
239
Forks
81
Avg merge
16h 29m
Merged PRs (30d)
8

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from WordPress/phpdoc-parser

All issues in WordPress/phpdoc-parser

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.