Composer: add informational notes about the suggested dependencies #646
Conversation
This file contains 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
|
Would it not be a good idea to also add an explanation for the other suggestion, which is arguably even more unnecessary for running the sniffs...? |
jrfnl
force-pushed
the
feature/composer-add-explanation-to-suggest
branch
from
8b0e0db
to
f331e73
Compare
|
@MarkMaldaba Absolutely! Sorry, I was focused on the composer plugin as I was pulling the same change to several external standards I contribute to, so completely overlooked the second entry here. I've amended the commit to include a hint to end-users about the second dependency as well now. |
jrfnl
changed the title
jrfnl
force-pushed
the
feature/composer-add-explanation-to-suggest
branch
from
f331e73
to
a23f272
Compare
Just suggesting a package does not explain to a user why it would be interesting for them to install it and I've already had question about the suggestion. The `suggest` entry in the `composer.json` file has a value which is not actually intended for version constraints, but to add a hint to the user about why they should install the package. Up to now, the value in the PHPCompatibility `composer.json` was used for a version constraint. While this is still a good idea to mention in this case as the Composer plugin needs a certain version to be compatible with the same PHP versions PHPCompatibility supports and the `security-advisories` needs to be at the uncommon `dev-master`, adding the hint on why the package is suggested should help users even more. Ref: https://getcomposer.org/doc/04-schema.md#suggest
wimg
approved these changes
Jun 10, 2018
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.
Just suggesting a package does not explain to a user why it would be interesting for them to install it and I've already had question about the suggestion.
The
suggestentry in thecomposer.jsonfile has a value which is not actually intended for version constraints, but to add a hint to the user about why they should install the package.Up to now, the value in the PHPCompatibility
composer.jsonwas used for a version constraint. While this is still a good idea to mention in this case as the Composer plugin needs a certain version to be compatible with the same PHP versions PHPCompatibility supports and thesecurity-advisoriesneeds to be at the uncommondev-master, adding the hint on why the package is suggested should help users even more.Ref: https://getcomposer.org/doc/04-schema.md#suggest