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

[Console] Renamed resolve command's -s option to -m (-s conflicts with core Symfony 2.x cmd option), machine readable added to remove command, and both commands output aligned #991

Merged
merged 1 commit into from
Sep 9, 2017

Conversation

robfrawley
Copy link
Collaborator

Q A
Branch? 1.0
Bug fix? yes
New feature? yes
BC breaks? yes
Deprecations? no
Tests pass? yes
Fixed tickets #988
License MIT
Doc PR

This pull request fixes #988 by renamed the resolve command's --as-script/-s option to --machine-readable/-m (shortcut -s conflicts with the Symfony 2.x core --shell/-s command option, and the long name --as-script was unclear as to its meaning), added the --machine-readable/-m option to remove command, and aligned the output of both resolve and remove commands.

The resolve command output had already been updated, but the remove command had not been; this has been remedied here. With both commands updated, shared functionality was refactored out into AbstractCacheCommand and tests were updated and expanded (which will hopefully ensure issues like #988 don't crop up again).

The most important user-facing changes are the rewrites of:

The BC break only exists since 1.9.0, when --as-script was added, meaning only for those who updated to 1.9.0 in the last day and only for those running Symfony 2.3 or `2.7.

@robfrawley robfrawley added Attn: BC Break This issue or PR results in a backwards-compatibility break and therefore requires a major release. Level: Bug 🐞 This item involves a legitimate regression (bug) to existing functionality. Level: Enhancement ✨ This item involves an enhancement to existing functionality. State: Confirmed This item has been confirmed by maintainers as legitimate. labels Sep 8, 2017
@robfrawley robfrawley added this to the 1.9.1 milestone Sep 8, 2017
@robfrawley robfrawley self-assigned this Sep 8, 2017
@robfrawley
Copy link
Collaborator Author

robfrawley commented Sep 8, 2017

Build failure unrelated to PR and caused by symfony/symfony#24105 (which introduced a bad directory check in the symfony/filesystem component's Filesystem::dumpFile() method(.

@robfrawley robfrawley force-pushed the feature-bugfix-console-commands branch 4 times, most recently from 52c9c61 to 4b37f14 Compare September 9, 2017 03:16
- change --as-script/-s option name/shortcut to --machine-readable/-m to fix collision with core
  symfony 2.x console options (the long name was changed to provide additional clarity)
- change option shortcut and name for "as-script/s" to "machine-readable/m" to fix collision with
  symfony-provided "shell/s" option from the 2.x series
- align output formatting and internal implementation of remove command with the improvements already
  introduced to the resolve command in 1.9.0
- update help content for both remove and resolve commands to align with updated output formatting
  and better describe all available functionality of the commands
- extracted common functionality between resolve and remove commands to a new shared abstract class
  to remove code duplication
- updated CHANGELOG.md and UPGRADE.md to note BC break and detail additional changes
- renamed test filter sets to more realistic names and added some additional ones too
- completely rewrote remove command tests and refactored resolve command tests to enable shared
  fixtures and methods between the two
- in test app, moved default web loader to descrete, new "web" named loader and made the "default"
  loader a chain loader that uses "web" as welll as many of the other ones
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Attn: BC Break This issue or PR results in a backwards-compatibility break and therefore requires a major release. Level: Bug 🐞 This item involves a legitimate regression (bug) to existing functionality. Level: Enhancement ✨ This item involves an enhancement to existing functionality. State: Confirmed This item has been confirmed by maintainers as legitimate.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant