Move some phpstan exceptions to problematic files only

[Crabcyborg]

This helps to improve our coverage in other files that do not have these issues.

[coderabbitai]

Walkthrough

The pull request modifies the phpstan.neon configuration file, specifically updating the ignoreErrors section. The changes involve removing some existing error patterns related to protected method calls, undefined variables, and compact() function usage. Simultaneously, new error patterns are introduced with more specific path-based scoping, effectively adjusting the PHPStan static analysis error reporting strategy for certain PHP files and directories.

Changes

File	Change Summary
phpstan.neon	- Removed error patterns for protected method calls, undefined variables, and compact() function - Added new error patterns with specific path scoping for views, controllers, and CSS directories

Possibly related PRs

• Reduce file scope of some phpstan exceptions #1972: Modifies phpstan.neon configuration by adding and removing error patterns, indicating a similar effort to refine PHPStan error reporting

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

phpstan.neon (2)

133-136: Consider documenting required variables for views.

While the configuration is appropriately scoped to view files, consider adding PHPDoc blocks in the view files to document the expected variables. This would make the code more maintainable and help prevent errors.

Example documentation format:

/**
 * Required variables for this view:
 * @var string $title
 * @var array $options
 * @var int $form_id
 */

---

117-136: Overall improvement in PHPStan configuration.

The changes successfully move from global error suppression to file-specific configurations, which is a positive step toward better code quality. However, consider:

1. Removing the css/* path from undefined variables configuration
2. Planning to address the technical debt in controller files
3. Adding variable documentation in view files

This more granular approach will help identify and fix issues in files that don't actually need these exceptions.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3c8e1fd and 8c9395c.

📒 Files selected for processing (1)

• phpstan.neon (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: Run PHP Syntax inspection (8.3)
• GitHub Check: PHP 8 tests in WP trunk
• GitHub Check: PHP 7.4 tests in WP trunk
• GitHub Check: PHP 8 tests in WP trunk
• GitHub Check: Cypress
• GitHub Check: Cypress
• GitHub Check: PHP 8 tests in WP trunk
• GitHub Check: PHP 7.4 tests in WP trunk
• GitHub Check: Cypress

🔇 Additional comments (2)

phpstan.neon (2)

127-132: Well-scoped configuration for protected method access.

Good job on narrowing down the protected method access exceptions to specific view files instead of applying them globally. This improves code safety while maintaining necessary functionality.

---

117-126: Review inclusion of CSS directory and consider refactoring controllers.

A few concerns about the paths configuration:

1. The css/* path inclusion seems unnecessary as CSS files shouldn't contain PHP code.
2. Including controller files suggests potential technical debt that should be addressed rather than suppressed.

Let's verify if there are any PHP files in the CSS directory and check the variable usage in the specified controllers: