add logic to ensure that the hooks inside of the woocommerce/src/ are parsed #29
Conversation
… being parsed and add some steps to run this site locally
piinthecloud
requested review from
jorgeatorres,
bacoords and
a team
and removed request for
bacoords
There was a problem hiding this comment.
Hey @piinthecloud!
Thanks for the PR 💯. It works beautifully and I can confirm that the missing hooks are now present in the docs.
As for the local script, I left some small suggestions. Nothing's really a blocker, though. Please let me know what you think! Thanks again!
| # Copy only the directories we want for documentation | ||
| cp -r "$WOOCOMMERCE_DIR"/includes woocommerce/ 2>/dev/null || true | ||
| cp -r "$WOOCOMMERCE_DIR"/src woocommerce/ 2>/dev/null || true | ||
| cp -r "$WOOCOMMERCE_DIR"/templates woocommerce/ 2>/dev/null || true |
There was a problem hiding this comment.
Is there a reason you prefer this to the symbolic link you tried first?
If the symlink-based approach worked correctly, that'd be faster and less error prone than copying directories as we wouldn't need to keep this script in sync with paths inside the plugin. Everything could be handled from the phpcs.xml file as today.
There was a problem hiding this comment.
When the files were symlinked, not all the files were being parsed. So the site would build, but there would large gaps of content missing, for examples Namespaces were completely empty. cp is slower, but it's the only way I could get it to build out the whole site.
There was a problem hiding this comment.
@piinthecloud I tested the new, non-symlinked approach and it's working for me 👍
run-local.sh
Outdated
| # Run PHPDocumentor directly with the local source | ||
| ./vendor/bin/phpdoc run \ | ||
| --template="data/templates/woocommerce" \ | ||
| --sourcecode \ | ||
| --defaultpackagename="WooCommerce" | ||
|
|
||
| # Generate hook documentation AFTER PHPDocumentor completes | ||
| echo "🔧 Generating hook documentation..." | ||
| php generate-hook-docs.php |
There was a problem hiding this comment.
To avoid duplication, I'd suggest we call the ./deploy.sh script here instead.
For example:
./deploy.sh --no-download --build-only --source-version 0.0.0
This will also take care of deleting the build/ directory if needed.
Note the 0.0.0 version. deploy.sh shouldn't require --source-version when --build-only and --no-download are used but we can probably fix that later. For now the 0.0.0 does the trick.
There was a problem hiding this comment.
Nice, didn't know i could run that. That also obviates the need for lines 74-77
|
@jorgeatorres any additional concerns? |
This PR enhances the WooCommerce Code Reference Generator to support local development workflows by and improving the recursive file scanning to detect hooks in woocommerce/src and deeper subdirectories.
Expanded file parsing
Added
woocommerce/srcto parsed files: The logic ingenerate-hook-docs.phphas been updated to know also look insidewoocommerce/srcto detect hooks and filters in use.Fixed
generate-hook-docs.phprecursion: During testing, I detected that thegetFiles()function wasn't going deep enough into the directories to appropriately retrieve all hook references. I simplified the logic on line 113 to directly merge the files from each subdirectory directly into the$filesarray.Hook and filter detection: Increased from 1,732 to 2,580 hooks.
Local development
To facilitate development, I've added the
run-local.shwhich lets you easily set up a local server with a local copy of the docs.Tweaks
Updated the .gitignore to ensure linked
/woocommercefiles never get committed.