Hooks generator does not get all the PHP files to scan
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- php
- Domain
- documentation, tooling
Research direction
Start with the referenced generate-hook-docs.php script and review the detailed explanation in the linked google-listings-and-ads PR comment. Reproduce the generator against a directory with more than two levels of paths, then verify that all PHP files and their hooks are included in the generated document.
Written by the indexing model from the issue text.
Description
Context
At Ventures team we would like to generate a hooks document for our internal use and we found there is an awesome script in this repo that just do the things we want. Here's our PR woocommerce/google-listings-and-ads#1573, it basically copy most of the code from the script and then modify a bit to suit what we need.
The Problem
We found the script does not capture all the PHP files in the directory, the TLDR reason is the script cannot work in the case where there are more than two levels of paths. Please see the detailed explanation in our PR's comment: https://github.com/woocommerce/google-listings-and-ads/pull/1573#issuecomment-1173318631.
It also relates to #15.
Our solution may not fulfil the needs in this repo, also if there's any better ways to generate hooks documents (like using PHPDoc?) in your mind, we're happy to hear and learn about.
- Dominant language
- Twig
- Stars
- 17
- Forks
- 12
- Avg merge
- 3h 58m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
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 woocommerce/code-reference
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
woocommerce/code-reference#19 · 1 reaction ·
-
Add a hook generator Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
All issues in woocommerce/code-reference
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
palladius/rails8-app-on-gcp#145 ·
-
NeedsTriage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
error Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
textual definition
Difficulty 1/5 Under an hour Newbie friendliness 90/100
geneontology/go-ontology#32653 ·