Global Flags - Allow shadowing & make lowercase + misc #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As discussed on #2, it'd be appealing to make the global flags (which are currently all caps) lowercase. The reason they were made uppercase was to avoid collisions with script args users might want to declare. I hadn't made my mind up for whether we should just shadow global flags in that case, or stick to making them unlikely to be used (e.g. all caps), but then prevent shadowing, so that they're always available. Thinking more about this, we should lowercase global flags, and allow shadowing them with script args, if there's a conflict. This commit implements the shadowing behavior, but the global flags remain all caps - we'll change that in an separate commit. This commit also removes the --STDIN flag. A more common convention that you see in CLIs is to instead allow '-' as the first arg, indicating "read from stdin". Vim does this, visual studio code's cli 'code' does this, etc, so we'll follow that convention and simplify the logic for our stdin reading decision. A purpose of this flag though was to give the script a name, given that's usually taken from the script file's name, but with stdin, we can't. Without the flag, we really cannot. So right now, we leave the name empty, but I may add a global flag which is something like "--script-name" which basically tells rad what to use. Bit of an edge case, at this point though. The change in stdin logic makes implementing the shadowing rules easier. I've changed the rad runner code to basically try to speed-run reading the RSL code if given ASAP, so that we can look at its flags, know which global flags to shadow, and then initialize all our global (flag-dependent) state such as printing, debugging, etc.
Plus a slight adjustment on when the full flag name is shadowed. Before, if the global full flag was shadowed, we'd put the shorthand in as the full name, so both e.g. -d and --d were valid for e.g. "debug". However, that's a little weird and the --d is really not that helpful. If the full name is shadowed, but the shorthand is fine, let's just allow the shorthand. We also make a note of this shadowing logic in the docs.
If --help is invoked a script, the user is likely interested in usage specific to that script. Global flags are good to include, particularly if they're useful *when invoking a script*, but if we print *all* the global flags, then there's a lot of noise, and we risk overloading the user with too much information. Let's hide some flags, either because 1) they're not really relevant when seeking help on a particular script 2) the global flag is quite niche, and not worth always printing For this commit, we hide the below flags (justification according to the two above bullet points included): - rad-debug (2) - shell (2) - version (1) - rsl-tree (2) - mock-response (2) Not always printing all flags is potentially a little divisive, but this "too much info" problem risks only getting worse, as we add more global flags.
Often, I want to see the path of a script. And sometimes the code. Sometimes both! Rather than having to switch between doing 'which myscript' and 'myscript --src', let's just make --src print the location as well, in a clear header. We're careful to not wreck redirects of the source, by respecting IsTty and printing the header to stderr.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Makes several changes to global flags in rad, some to address #2. See individual commits for details.
Closes #2.