fix(cli): docusaurus --help should print plugin commands using extendCli()
#10685
+561
−275
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
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Size Change: +337 B (0%) Total Size: 11.2 MB ℹ️ View Unchanged
|
2 tasks
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: +327 B (0%) Total Size: 11.7 MB ℹ️ View Unchanged
|
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.
Motivation
Fix #10681
docusaurus --helpshould also print cli commands from plugins implementing theextendClilifecycle. This behavior broke with the refactor of #10368.This also refactors the CLI code so that we can unit test this behavior and avoid regressing again. Commander doesn't make it super easy since a lot of
process.exit,console.errorandprocess.stdout.writehappens internally, but I found a way to snapshot all that.This also implements a workaround for #8903 and PaloAltoNetworks/docusaurus-openapi-docs#490 with 2 escape hatch env variables for loading third-party CLI extensions from a different siteDir / config:
DOCUSAURUS_CLI_SITE_DIRDOCUSAURUS_CLI_CONFIGThese env variables will remain private/internal/workarounds for now, until we get more feedback and eventually find a better way to solve this problem.
Test Plan
Unit tests 🥳
Test links
https://deploy-preview-10685--docusaurus-2.netlify.app/