Description
This issue is automatically created based on existing pull request: #29762: Include Constructor to be a part of CommandListInterface
API, extend inline documentation
Description (*)
In my personal opinion using CommandListInterface
is invalid way of adding new Commands to interface.
It is because Constructor is not a part of Interface (Service Contract), thus it is not "guaranteed" part of Interface.
Using CommandList
is against Magento rules, thus it's implementation is not guaranteed and can change in backwards-incompatible way.
I'm extending the CommandList
with @api
to ensure developers that this class won't change backwards-incompatible way and this way - they can either add new classes using:
Argument injection toCommandList
classPlugin ongetCommands
onCommandListInterface
.
I'd love to get your feedback there.
After discussion with @kandy I decided to add the __construct()
to the API.
Answering the main concerns: https://3v4l.org/8ug8i
As it affects you (community) I need your 👍🏻 or comments to pass the change:
Related Pull Requests
Fixed Issues (if relevant)
- Fixes magento/magento2#<issue_number>
Manual testing scenarios (*)
- ...
- ...
Questions or comments
Contribution checklist (*)
- Pull request has a meaningful description of its purposeAll commits are accompanied by meaningful commit messagesAll new or changed code is covered with unit/integration tests (if applicable)All automated tests passed successfully (all builds are green)
Thanks
- @jissereitsma for inspiration
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Activity
CommandListInterface
API, extend inline documentation #29762m2-assistant commentedon Nov 18, 2022
Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇
1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the labelIssue: Format is valid
will be added to the issue automatically. Please, edit issue description if needed, until labelIssue: Format is valid
appears.2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add
Issue: Clear Description
label to the issue by yourself.3. Add
Component: XXXXX
label(s) to the ticket, indicating the components it may be related to.4. Verify that the issue is reproducible on
2.4-develop
branchDetails
- Add the comment@magento give me 2.4-develop instance
to deploy test instance on Magento infrastructure.- If the issue is reproducible on
2.4-develop
branch, please, add the labelReproduced on 2.4.x
.- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
5. Add label
Issue: Confirmed
once verification is complete.6. Make sure that automatic system confirms that report has been added to the backlog.
engcom-Hotel commentedon Nov 18, 2022
Hello @lbajsarowicz,
We are marking this as a feature request for moving it further.
Thanks
CommandListInterface
API, extend inline documentation #3790111 remaining items