[#31941] - [4] Rename and namespace Joomla Commands
- Closed
- 25 Feb 2021
- Medium
- Build: 4.0-dev
- # 31941
- Diff
- PhilETaylor:namepace-commands
User tests: Successful: Unsuccessful:
A decision is needed asap - as a release blocker - because if this is not merged before Joomla 4.0.0 is released, then its a b/c change and will not be worth doing in the future when Joomla 4.1 is released.
Summary of Changes
prefix all Joomla internal commands with joomla: to correctly namespace them from other commands.
Out of the box this doesn't seem to make much sense, however as the community add more and more commands, the name spacing and naming convention of commands can, and will, get messy. This has already played out in other projects with commands.
Testing Instructions
php cli/joomla.php list
note that database:import/export is not covered by this PR as that is a library of its own.
Actual result BEFORE applying this Pull Request
Expected result AFTER applying this Pull Request
And after installing extensions with other commands you can see why this is much neater and makes sense to do:
Documentation Changes Required
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Libraries |
Hmm I kinda get the aim of this. But at minimum the users and finder things are their own extensions so should be as top level as any other 3rd party extension.
Honestly I'm unsure on grouping session/site/extension commands together. I'm going to talk around the maintainers group for opinions.
I have tested this item
It works as described. Whether it is the right thing to do is up to others.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/31941.
i don't like it
too much verbose
my 0.02€
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/31941.
Symfony commands allow shorthand - the shortest string that is unique in each part between colons
However, as has been highlighted to me privately, Joomla doesn't fully implement Symfony commands and so this kind of shortcut doesn't work with the Joomla cli :-(
The CLI App interface isn't compatible with Joomla's (the default parameter in the CMSApplication->get() method so we adapted most of it)
As long as all add-ons namespace their commands (as akeeba has done) I'm not sure I see where the problem lies
Sooner or later it will clash, so better to namespace them yet.
I have tested this item
After applying the patch. It works as mentioned.
A small correction, in the testing instructions, please change the command php clli/joomla.php list to php cli/joomla.php list
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/31941.
I have tested this item
Run a couple of commands like php cli/joomla.php joomla:session:gc. All of them worked without an issue.
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/31941.
Ok I've talked in maintainers a little bit. I'm going to close this - I think we've roughly got the right breakdown already - where these are roughly broken down by our internal component names. We can probably group some things together like maybe update and core or similar but I think everything under one name is way too far.
| Status | Pending | ⇒ | Closed |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2021-02-25 14:13:44 |
| Closed_By | ⇒ | wilsonge | |
| Labels |
Added:
?
|
||
That, of course, is your decision as maintainers...
@wilsonge one for you to approve or reject before going to RC please.