Fix: Correct option parameter parsing in ConsoleStrategy#26
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug in the ConsoleStrategy's signature parser where option parameters were incorrectly parsed. The parser was only trimming a single leading dash instead of both dashes from option names, causing invalid WP-CLI synopsis entries with three dashes and emitting warnings.
Changes:
- Updated line 112 in
ConsoleStrategy::parseSignature()to trim both leading dashes (--) instead of just one (-)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem:
The signature parser was only trimming a single leading dash from option parameters instead of both dashes, causing parameter names like
--countto become-count. This resulted in WP-CLI generating invalid synopsis entries with three dashes (e.g.,---count) and emitting warnings.Solution:
Changed line 112 in
ConsoleStrategy::parseSignature()to trim both leading dashes (--) instead of just one (-). This ensures option parameter names are correctly extracted from signature strings.Testing:
{--flag},{--option=default},{--option=:Description}Files changed:
lib/Strategies/ConsoleStrategy.php(line 112)Related:
The bug was discovered while implementing test data generators using PHPNomad Console integration. The fix ensures that option parameters in command signatures are correctly parsed and registered with WP-CLI.
This fix is backwards compatible and doesn't change any API contracts - it simply corrects the internal parsing logic to match the documented signature format from
PHPNomad\Console\Interfaces\Command::getSignature().