Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added parsing of PHPDoc blocks based on AST and PHPDoc parser by phpstan. #41306

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

zinigor
Copy link
Member

@zinigor zinigor commented Jan 24, 2025

Proposed changes:

  • Makes the doc parser that hasn't previously been used switch to PHP's AST extension with help from phpstan/phpdoc-parser.
  • Adds detection of apply_filters calls using AST and PHPDoc parsing using phpdoc-parser.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

  • Checkout this branch.
  • Run jetpack docs
  • Observe the phpdoc.json file generated in the folder where you're running the command from.

@github-actions github-actions bot added [Status] In Progress [Tools] Development CLI The tools/cli to assist during JP development. labels Jan 24, 2025
Copy link
Contributor

github-actions bot commented Jan 24, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 24, 2025
@zinigor zinigor requested a review from a team January 24, 2025 17:42
@zinigor zinigor added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] In Progress labels Jan 24, 2025
@zinigor zinigor marked this pull request as ready for review January 24, 2025 17:43
continue;
}

$paramTags = $phpDocNode->getParamTagValues();
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@since and @module tags will have to be added separately.

@zinigor zinigor removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jan 24, 2025
Copy link
Contributor

@tbradsha tbradsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can confirm it generates both a phpdoc.json and a markdown.json. I'm not familiar enough with AST parsing to be confident as to whether it's doing what it should at a low level, though.

I'll note that there are two deprecation notices from the scribu library, and several instances of this:

Warning: DOMDocument::loadHTML(): Tag summary invalid in Entity, line: 376 in /some/path/jetpack/tools/cli/helpers/doc-parser/runner.php on line 72

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] In Progress [Tools] Development CLI The tools/cli to assist during JP development. [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants