Skip to content

PHPStan: Fix error preventing Bleeding Edge mode#3416

Merged
acicovic merged 2 commits intodevelopfrom
fix/error-preventing-phpstan-bleeding-edge-mode
Jun 9, 2025
Merged

PHPStan: Fix error preventing Bleeding Edge mode#3416
acicovic merged 2 commits intodevelopfrom
fix/error-preventing-phpstan-bleeding-edge-mode

Conversation

@acicovic
Copy link
Collaborator

@acicovic acicovic commented Jun 4, 2025

Description

While trying to enable Bleeding Edge mode for PHPStan, I stumbled upon this error:

     Internal error: Class Parsely\Tests\Unit\Utils\stdClass was not found while
     trying to analyse it - discovering symbols is probably not configured properly.
     while analysing file
     /Users/alex/Documents/Work/Dev/Web/wp-parsely/tests/Unit/Utils/UtilsTest.php

     ...

⚠️  Result is incomplete because of severe errors. ⚠️
   Fix these errors first and then re-run PHPStan
   to get all reported errors.

This PR fixes the issue so Bleeding Edge mode can be enabled and work as expected. Bleeding Edge can be enabled by adding the following to phpstan.neon:

includes:
	- phar://phpstan.phar/conf/bleedingEdge.neon

Motivation and context

Lay some groundwork for allowing to upgrade to PHPStan 2.x.

How has this been tested?

Verified that PHPStan Bleeding Edge mode runs correctly after the fix.

Summary by CodeRabbit

  • Tests
    • Updated type annotation in unit test documentation for utility functions. No changes to test behavior or functionality.

@acicovic acicovic added this to the 3.19.4 milestone Jun 4, 2025
@acicovic acicovic self-assigned this Jun 4, 2025
@acicovic acicovic added the Maintenance & Fixes Ticket/PR related to codebase maintenance tasks label Jun 4, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 4, 2025

📝 Walkthrough

Walkthrough

A unit test file was updated to modify a PHPStan type annotation in a PHPDoc comment, changing the type hint for the obj key from stdClass to \stdClass to fully qualify the class name. No other code or functional changes were made.

Changes

File(s) Change Summary
tests/Unit/Utils/UtilsTest.php Updated PHPStan type annotation for the obj key to use \stdClass.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14dd609 and 8edaaa6.

📒 Files selected for processing (1)
  • tests/Unit/Utils/UtilsTest.php (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{html,php}`: "Perform a detailed review of the provided code with following key aspects in mind: - Review the HTML and PHP code to ensure it is well-structured and adheres ...

**/*.{html,php}: "Perform a detailed review of the provided code with following key aspects in mind:

  • Review the HTML and PHP code to ensure it is well-structured and adheres to best practices.
  • Ensure the code follows WordPress coding standards and is well-documented.
  • Confirm the code is secure and free from vulnerabilities.
  • Optimize the code for performance, removing any unnecessary elements.
  • Validate comments for accuracy, currency, and adherence to WordPress coding standards.
  • Ensure each line comment concludes with a period.
  • Verify code compatibility with the latest version of WordPress, avoiding deprecated functions or features."
  • tests/Unit/Utils/UtilsTest.php
🔇 Additional comments (1)
tests/Unit/Utils/UtilsTest.php (1)

44-44: Fully qualify stdClass in PHPDoc.

Qualifying stdClass with a leading backslash ensures PHPStan can resolve the global class in Bleeding Edge mode.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@acicovic acicovic marked this pull request as ready for review June 4, 2025 07:32
@acicovic acicovic requested a review from a team as a code owner June 4, 2025 07:32
@acicovic acicovic merged commit 4057b3b into develop Jun 9, 2025
41 checks passed
@acicovic acicovic deleted the fix/error-preventing-phpstan-bleeding-edge-mode branch June 9, 2025 07:44
github-actions bot added a commit that referenced this pull request Jun 9, 2025
@acicovic acicovic modified the milestones: 3.19.4, 3.20.0 Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintenance & Fixes Ticket/PR related to codebase maintenance tasks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants