[UI] - CLI TYPE - Handle pluralization (aliases) about gto HOT 4 CLOSED

Ok, so I've created a TYPE_ALLOWED setting in #87. I think it's a way to deal with these, and we could add something on top like asking Did you mean "model"? if user entered "models". But don't think it's needed right now. I'll close the issue and we'll address this in future if that would be needed. Thanks for posting the feedback @omesser!

from gto.

Thanks!

1. I've implemented gto audit registrations as you suggested, everything works now. I've also supported shortcuts and aliases, like:

class ALIASES:
    REGISTER = ["reg", "registration", "registrations", "register"]
    PROMOTE = ["prom", "promote", "promotion", "promotions"]

Do you think it's fine to support them? I mean, people will rely on them and if we decide to remove some of them in future, it can break user's workflow. On other hand in k8s you also have this kind of shortcuts and they are very helpful.

2. In fact, model and models may be different things. Maybe I have a model (models/my-model) and models (models/). So not sure we need to assume it's a 100% typo. (This example also touches interleaved paths, but we can discuss it here #59).

I have few options in mind here:
A. Make a spell-check and warn you when you do that, so you can spot in and fix it before you commit this.
B. Allow to specify a whitelist of allowed values. Then if you make a typo, gto will throw an error.
C. Same as A, but if we think this may be a typo, we throw an error and ask you to use --force flag.

WDYT?

from gto.

"Do you think it's fine to support them? I mean, people will rely on them and if we decide to remove some of them in future"

I believe it's a better experience to support the aliases. But we can still be consistent with the syntax in the docs (meaning always using "registrations" everywhere, and mention the aliases only once).
We will need to, indeed, not remove those in the future - or at least manage deprecations properly.
Another, "safer" route, is to explicitly mention in the docs that we only commit to a specific form of the arg = "registration", and not aliases like "reg" "registrations". I think both are valid approaches, but I think the aliases route has proved itself so convenient in some cases that it should be regarded as a production feature (just my personal 2 cents)

from gto.

"In fact, model and models may be different things...."

This is why i originally wrote that this is debatable, but I think pluralization of types shouldn't be so close to a possible typo (like model and models).
Type should always be singular, if we ever want to deal with a set of models as a distinct type, the new type can be called model-set (or list? depends) - then you both accommodate for a collection of items but prevent easily made typos

from gto.