feat(cli): allow hiding scripts from the help list #56
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
Allows adding a 'hiddenFromHelp' property to a script object so that it does not show up in the help list.
Current coverage is 100% (diff: 100%)@@ master #56 diff @@
===================================
Files 11 11
Lines 242 246 +4
Methods 0 0
Messages 0 0
Branches 0 0
===================================
+ Hits 242 246 +4
Misses 0 0
Partials 0 0
|
| @@ -32,7 +44,7 @@ test('resolves default to the script if it is a string', t => { | |||
| t.is(result, 'string') | |||
| }) | |||
|
|
|||
| test('does not resolve a script object without a script or defualt', t => { | |||
| test('does not resolve a script object without a script or default', t => { | |||
Scripts should not be ignored from the help list simply because the 'hiddenFromHelp' key is present. They should only be hidden if it's present and truthy. This fixes that and the test that was supposed to ensure that. #41
|
LGTM |
|
@sxn, thanks so much for this feature! I've added you as a collaborator on the project. Accept that invitation and feel free to squash and merge this PR yourself :) Feel free to watch the repo and continue making contributions as you feel the need/desire :) Thanks again! |
|
Nice! Thanks, will do. :) |
|
Oh one sec! Could you add some docs in the README for this feature? |
|
Sure thing! |
|
LGTM |
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.
What: Allow scripts to be hidden from the help list.
Why: In order to allow having semi-private scripts - semi because they will still be runnable as long as you know they're there.
How: by changing the
src/resolve-script-object-to-string.js::resolveScriptObjectToScriptfunction so that if thehiddenFromHelpproperty is defined and truthy, undefined is returned.