Closed rsenden closed 1 year ago
I agree on the naming and thought the aliases were a bit clunky- I think we agree on "app", "release" and "microservice"?
lookup-items
is a weird one because it is just a dumping ground for types that appear across various FoD operations. Its not really a user-level entity as you don't need to know it exists if using the UI. In theory we shouldn't need to expose it as the individual commands should be able to refer to its types/vales as individual options as some do. However we don't have complete API coverage and allow users to do simple fod rest
call in which case they might want to refer to its values - and hence why its probably good to keep it the same as exposed via the API?
Agree on app
, release
and microservice
.
As for lookup-items
, are you saying that this is only useful for the fcli fod rest call
command, not any of the other fcli fod <entity>
commands? In that case, what about moving this functionality to fcli fod rest lookup <name>
or something similar?
When removing command aliases, please make sure that these aliases are no longer being referenced in the resource bundles, both for these commands themselves, as in the descriptions of other commands/options. For example, the fcli fod app update
command description refers to the app-rel
and app-ms
aliases:
Also, please make sure that any option names referencing those entities only use the new, single entity name. For example, the fcli fod user update
has an --add-apps / --add-applications
option; we should probably only have --add-apps
(same of course for --remove-applications
, ...)
Also, please make sure class names are consistent with entity names. For example, if we have release
as the entity name, then the corresponding classes should be named FoDReleaseCommands
and FoDRelease*Command
.
Some FoD commands have aliases for which it is questionable whether they provide any benefit or will ever be used. In particular:
app
/application
: We should either remove theapplication
alias, or add the same alias to the SSCapp
command for consistencyrelease
/app-rel
: I don't see anyone usingapp-rel
as its meaning is unclear if you don't know what command this is an alias for;release
is much more clear and natural, so I'd suggest removing theapp-rel
aliasmicroservice
/app-ms
: Same as above. If we want to have something shorter formicroservice
, maybe justms
will dolookup
/lookup-items
: Any way we can come up with a name that more properly describes this 'entity'?lookup-items
is in plural formlookup-items
) should be used as the command name; alternative/shorter names should be aliases