Add PHPCS linting for PHP blocks in feature files by swissspidy · Pull Request #340 · wp-cli/wp-cli-tests

swissspidy · 2026-07-23T12:28:31Z

Not sure yet if really worth it, will need some testing.

Summary by CodeRabbit

New Features
- Added validation and automatic formatting for PHP code embedded in feature files.
- Added tooling to extract embedded PHP for checks and synchronize formatting fixes back into feature files.
Bug Fixes
- Improved temporary-file cleanup, including when checks are interrupted.
- Preserved and reported code-quality check failures while allowing applicable checks to complete.
Style
- Standardized formatting in feature-file test scenarios.
Tests
- Added comprehensive coverage for PHP extraction, validation, formatting, and synchronization.

coderabbitai · 2026-07-23T12:28:39Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d2b71908-4123-49a3-be0f-0f4523a8ce20

📥 Commits

Reviewing files that changed from the base of the PR and between 2c962f3 and 9c79335.

📒 Files selected for processing (2)

tests/tests/TestExtractFeaturePhp.php
utils/extract-feature-php.php

📝 Walkthrough

Walkthrough

The change adds PHP extraction and synchronization for .feature files. PHPCS and PHPCBF now validate or format extracted blocks, preserve accumulated failures, and clean temporary files. PHPUnit tests cover extraction, updates, validation, and error handling.

Changes

Feature PHP checks

Layer / File(s)	Summary
Feature PHP extraction and synchronization `utils/extract-feature-php.php`	Adds a CLI utility that validates targets, extracts PHP blocks into padded temporary files, and synchronizes processed content back into `.feature` files.
Extraction utility validation `tests/tests/TestExtractFeaturePhp.php`	Adds tests for extraction, target validation, generated-file cleanup, indentation, PHP tags, padding, synchronization, and failure cases.
PHPCS and PHPCBF script integration `bin/run-phpcbf-cleanup`, `bin/run-phpcs-tests`, `features/*.feature`	Accumulates command statuses, conditionally processes PHP blocks in feature files, cleans temporary files, and applies minor syntax-formatting changes.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Developer
  participant run_phpcs_tests
  participant extract_feature_php
  participant PHPCS
  participant FeatureFiles
  Developer->>run_phpcs_tests: run checks
  run_phpcs_tests->>extract_feature_php: extract PHP blocks
  extract_feature_php->>FeatureFiles: read .feature files
  extract_feature_php-->>run_phpcs_tests: create temporary PHP files
  run_phpcs_tests->>PHPCS: check temporary PHP files
  PHPCS-->>run_phpcs_tests: return check status
  run_phpcs_tests-->>Developer: exit with accumulated status

Suggested reviewers: brianhenryie

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 36.36% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: adding PHPCS linting for PHP blocks in feature files.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch try/phpcs-in-feature-files

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 PHPStan (2.2.7)

PHPStan was skipped because the config uses disallowed bootstrapFiles, bootstrapFile, or includes directives.

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

_{Comment @coderabbitai help to get the list of available commands.}

codecov · 2026-07-23T12:29:55Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

…e sniffs

…der sniffs from feature PHP blocks

Fixes for the PHP block extraction and synchronization: * Place an added `<?php` tag on the docstring delimiter line, so that it is no longer overwritten by the first line of code and blocks without an opening tag are actually linted as PHP. * Only treat a docstring as PHP when it follows a step creating a PHP file or starts with `<?php`. Expectations such as `Then the wp-config.php file should contain:` are not necessarily valid PHP and must not be reformatted. * Determine the indentation to restore from the first line holding code, as a leading empty line would otherwise be used as indentation. * Remove only the padding added during extraction instead of all leading and trailing empty lines, preserving intentional ones. * Keep empty lines leading up to an opening tag, so that reported line numbers keep matching. * Only remove files from the target directory that a previous extraction created, and refuse target directories that hold the feature files themselves. * Only treat the first argument as an action when it is one, so that passing two directories does not swap source and target. * Report failures on STDERR and through the exit code. * Skip a block instead of writing it back when the extracted file no longer lines up with the feature file. Fixes for the scripts running the checks: * Propagate failures of the extraction, PHPCS, PHPCBF and synchronization steps, and skip synchronization when extraction failed. * Preserve the PHPCS exit status by writing the report to a file instead of piping it through `sed`. * Keep nested directories when normalizing reported feature file paths. Adds unit tests covering extraction and synchronization. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KVnFXuhCGs4NT2A7FmDo4e

swissspidy · 2026-08-06T14:41:31Z

@coderabbitai review

coderabbitai · 2026-08-06T14:41:38Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

swissspidy added 3 commits July 23, 2026 14:20

Add PHPCS linting for PHP blocks in feature files

6de99d4

Add PHPCBF support for feature files

1f954c8

Fix PHP code style violations in feature files

af59387

swissspidy added the scope:testing Related to testing label Jul 23, 2026

github-actions Bot added the state:unconfirmed label Jul 23, 2026

Preserve relative PHP code indentation during PHPCBF update

c8b2dd1

swissspidy mentioned this pull request Jul 23, 2026

Fix PHP code style violations in feature files wp-cli/entity-command#627

Merged

swissspidy added 2 commits July 23, 2026 16:08

Preserve empty lines inside feature PHP blocks during extraction

f7e89ee

Enforce standard tab indentation inside feature PHP snippets

9d3728c

swissspidy mentioned this pull request Jul 23, 2026

Fix PHP code style violations in feature files wp-cli/wp-cli#6357

Merged

swissspidy added 3 commits July 23, 2026 16:41

Exclude WordPress.NamingConventions.PrefixAllGlobals from feature fil…

d6304a3

…e sniffs

Exclude OO structure and global override rules from feature file sniffs

780a76b

Exclude YodaConditions, empty catch, unnamed namespaces, and file hea…

b32a615

…der sniffs from feature PHP blocks

swissspidy marked this pull request as ready for review August 4, 2026 08:42

swissspidy requested a review from a team as a code owner August 4, 2026 08:42

Copilot AI lite review requested due to automatic review settings August 4, 2026 08:42

Copilot started reviewing on behalf of swissspidy August 4, 2026 08:43 View session

This comment was marked as resolved.

Sign in to view

swissspidy added 2 commits August 6, 2026 14:34

Merge branch 'main' into try/phpcs-in-feature-files

979fa28

Address some code review feedback

2c962f3

This comment was marked as resolved.

Sign in to view

Address code review feedback

9c79335

swissspidy removed the state:unconfirmed label Aug 6, 2026

swissspidy added this to the 5.2.3 milestone Aug 6, 2026

Navigation Menu

Uh oh!

Add PHPCS linting for PHP blocks in feature files - #340

Add PHPCS linting for PHP blocks in feature files#340
swissspidy wants to merge 13 commits into
mainfrom
try/phpcs-in-feature-files

swissspidy commented Jul 23, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 23, 2026 •

edited

Loading

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

codecov Bot commented Jul 23, 2026

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

swissspidy commented Aug 6, 2026

Uh oh!

coderabbitai Bot commented Aug 6, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

swissspidy commented Jul 23, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

codecov Bot commented Jul 23, 2026

Codecov Report

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

swissspidy commented Aug 6, 2026

Uh oh!

coderabbitai Bot commented Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

swissspidy commented Jul 23, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 23, 2026 •

edited

Loading

coderabbitai Bot commented Aug 6, 2026 •

edited

Loading