Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renaming Arguments #70

Closed
volaka opened this issue Aug 19, 2021 · 3 comments
Closed

Renaming Arguments #70

volaka opened this issue Aug 19, 2021 · 3 comments

Comments

@volaka
Copy link

volaka commented Aug 19, 2021

Hi,

Thanks for the great work!

I might be wrong but I didn't see any shortened args in the help docs. (e.g. -kubernetes-version -> -v, -verbose -> -V)

Do you think it is worth being added?

@yannh
Copy link
Owner

yannh commented Aug 19, 2021

Renaming is hard and would break dramatically for everyone who is using the long form in their scripts... I am on the same page as https://superuser.com/questions/174564/why-are-there-short-and-long-alternatives-for-command-line-options and believe long parameters are better since they re most explicit, at least when used in scripts: is -v the kubernetes version of the kubeconform version?

So while I get that it is different than Kubeval, I would err on keeping it this way.

@volaka
Copy link
Author

volaka commented Aug 21, 2021

My bad in using "renaming". I meant to say adding short-hand args for long-named ones. for example for -kubernetes-version we can also add -v option, so it won't break any pipelines but adds functionality

@yannh
Copy link
Owner

yannh commented Aug 28, 2021

@volaka I'll use my maintainer privilege here and keep it this way 😬 -v is ambiguous (it could be the version of kubeconform) and I think the benefit of having this alias does not outweigh the added complexity. I know Kubeconform differs a bit from Kubeval here - but kubeconform uses a different library for parameter parsing that makes this a tiny bit more difficult.

If there was ever a goal to unite both projects (see instrumenta/kubeval#268 ) it might be worth making both CLIs compatibles, but it's a little bit of work, and there is little benefit otherwise.

@yannh yannh closed this as completed Aug 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants