Add an `exclude_directory_from_parse` config · phan/phan#849

(1 comment) (0 reactions) (0 assignees)PHP (5,455 stars) (373 forks)batch import

enhancementhelp wantedusability

Description

exclude_file_regex is an inefficient way to exclude directories, and regexes are inconvenient to set up for users.

Add exclude_directory_from_parse, which accepts a case-sensitive path and normalizes it. The parse phase should check if the directory which is about to be iterated over is listed in that config.

Warn if one of the folders didn't exclude anything

exclude_file_regex currently acts on the list of files, after the files in an (effectively excluded) directory are listed, which is inefficient

I hope to be able to change that to also act on directories while iterating

Contributor guide

Tech stack: None
Domain: toolingperformance
Issue type: feature
Difficulty: 3
Estimated time: 1-2 days
Activity status: stale
Clarity: clear
Prerequisites: PHPPhan codebase basics
Newbie friendliness: 65
Research direction: Examine the current implementation of `exclude file regex` in the configuration parsing and file iteration logic. Look for where directories are iterated during the parse phase, likely in a file iterator or recursive directory traversal. Then implement a new config option `exclude directory from parse` that accepts a path, normalizes it (e.g., using `realpath`), and checks if the directory about to be iterated is in that list. Modify the parse phase to skip directories in the exclude list. Add a warning if a listed directory did not match any actual directory during iteration. Consider also updating `exclude file regex` to act on directories during iteration for efficiency.