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

Closes #7119 #7132

Draft
wants to merge 8 commits into
base: develop
Choose a base branch
from
Draft

Closes #7119 #7132

wants to merge 8 commits into from

Conversation

Khadreal
Copy link
Contributor

@Khadreal Khadreal commented Nov 22, 2024

Description

Fixes #7119
Nothing impacts users.

Type of change

  • Enhancement (non-breaking change which improves an existing functionality).

Detailed scenario

n/a

Technical description

Documentation

This pull request introduces several changes to enhance PHPStan integration and adds a new custom rule for validating @param tags in docblocks. The most important changes include adding a new script to reset the PHPStan baseline, updating the PHPStan configuration files, and implementing a custom PHPStan rule.

Enhancements to PHPStan integration:

  • composer.json: Added a new script run-stan-reset-baseline to reset the PHPStan baseline.
  • phpstan-baseline.neon: Added baseline configurations to ignore specific errors in certain files.
  • phpstan.neon.dist: Updated the parameters section to include a new directory and added the custom rule WP_Rocket\Tests\phpstan\Rules\ApplyFiltersTypedDynamicFunctionReturnTypeExtension. [1] [2]

Implementation of a custom PHPStan rule:

Mandatory Checklist

Code validation

  • I validated all the Acceptance Criteria. If possible, provide screenshots or videos.
  • I triggered all changed lines of code at least once without new errors/warnings/notices.
  • I implemented built-in tests to cover the new/changed code.

Code style

  • I wrote a self-explanatory code about what it does.
  • I protected entry points against unexpected inputs.
  • I did not introduce unnecessary complexity.

Copy link

codacy-production bot commented Nov 22, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -0.10%) (target: 50.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (df52190) 38228 16731 43.77%
Head commit (fb69320) 38228 (+0) 16731 (+0) 43.77% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#7132) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@Miraeld Miraeld self-assigned this Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PHPStan - Ensure Docblock presence for wpm_apply_filters_typed()
2 participants