-
Notifications
You must be signed in to change notification settings - Fork 11
Expand short flags to long for improved clarity #2738
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
base: main
Are you sure you want to change the base?
Conversation
4b23a59
to
30311a2
Compare
- sops flags, since it's security related - helm --all-namespaces since it increases blast radius - various others
30311a2
to
2cf34e9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
awesome work!
### Bash | ||
|
||
- See [Googles style guide](https://google.github.io/styleguide/shellguide.html). | ||
- Prefer long versions of flags to improve readability, i.e. `--long-flag` instead of `-f`| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Prefer long versions of flags to improve readability, i.e. `--long-flag` instead of `-f`| | |
- Prefer long versions of flags to improve readability, i.e. `--long-flag` instead of `-f` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice that you are improving readability of the scripts 🚀
Warning
This is a public repository, ensure not to disclose:
What kind of PR is this?
Required: Mark one of the following that is applicable:
Optional: Mark one or more of the following that are applicable:
Important
Breaking changes should be marked
kind/admin-change
orkind/dev-change
depending on typeCritical security fixes should be marked with
kind/security
What does this PR do / why do we need this PR?
This expands various short
-f
flags to--long-flag
in order to improve readabilty.Information to reviewers
There are many more short flags, but some don't have long variants, some don't have in every implementation (e.g. compare POSIX cp, BSD cp, GNU cp)
Especially shell built-ins rarely do (e.g.
[ -f ]
,local
,declare
etc)Checklist