feat(docs): add --dryRun option
#454
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
We're going to consistently return strings here instead of the total raw dump of the doc objects. it's not very intuitive nor readable, and by being able to consistently return strings that we can format, it'll set up the dry run functionality quite nicely.
kanadgupta
changed the title
--dryRun option
kanadgupta
commented
Feb 27, 2022
| @@ -160,6 +181,6 @@ module.exports = class DocsCommand { | |||
| }) | |||
| ); | |||
|
|
|||
| return updatedDocs; | |||
| return chalk.green(updatedDocs.join('\n')); | |||
There was a problem hiding this comment.
The command output has changed which is why I'm including this in the v7 milestone, but I can be convinced otherwise.
erunion
approved these changes
Feb 28, 2022
|
Added some docs here: e6b946a |
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
Realized while working on the docs syncing workflow in #439 that this would be a super easy win and extremely useful to have.
--dryRunoption todocscommand--dryRuntestsdocscommand successfully, the output an enormous, mostly unreadable JS array of objects (example). Since this tool now supports debugging, this isn't really necessary and isn't particularly user-friendly. So this PR reformats thedocscommand outputs so it always returns formatted success messages doc objects🧬 QA & Testing
If tests pass, we should be good to go! You can also try this out yourself on any project by checking out this branch and running the following command:
This won't make any changes in your project and instead will return a command output that looks like this: