feat(docs): consolidate single commands
#642
Merged
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
kanadgupta
added
enhancement
also adding JSDocs
|
@garrett-wade FYI! |
erunion
reviewed
Oct 27, 2022
| return expect(changelogs.run({ key })).rejects.toThrow( | ||
| 'No folder provided. Usage `rdme changelogs <folder> [options]`.' | ||
| it('should error if no path provided', () => { | ||
| return expect(changelogs.run({ key })).rejects.toStrictEqual( |
There was a problem hiding this comment.
Why not do .toThrow here anymore?
There was a problem hiding this comment.
.toThrow is technically a partial match on err.message, .toStrictEqual(<full error object>) is a stricter check
| this.args = [ | ||
| this.getKeyArg(), | ||
| this.getVersionArg(), | ||
| { | ||
| name: 'folder', | ||
| name: 'filePath', |
There was a problem hiding this comment.
Does this accept a path to a file or a path to a folder?
There was a problem hiding this comment.
Both! This variable isn't user-facing since it's the default arg (i.e. it won't show up in the help commands or anything), but I wasn't sure what to call it.
erunion
approved these changes
Oct 27, 2022
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.
🧰 Changes
This removes our
:singlecommands and extends the functionality of thechangelogs,custompages, anddocscommands to intelligently determine whether the input is a directory vs. a single file.The following commands have been removed in favor of their standard counterparts:
changelogs:singlecustompages:singledocs:single🧬 QA & Testing
I've left the test suites separated out so single file tests vs. directory tests are in separate files. Do they pass?