fix: CLI command skips unrelated plugins#472
Merged
tgreyuk merged 1 commit intotypedoc2md:masterfrom Sep 25, 2023
Merged
Conversation
The generate-typedoc CLI command would run typedoc on every plugin instance defined on the site, not just for the current one. This would cause generation to fail with errors "Tried to set an option that was not declared", since the config for other plugins would not pass the validation for this plugin. This fix checks that the plugin name matches the current one before running generateTypedoc on it.
Author
|
Thank you @tgreyuk! Any chance we can get a release with this fix, so we can drop the fork and go back using the upstream version of the package..? |
Member
|
Sure - docusaurus-plugin-typedoc@0.20.2 |
Author
|
Awesome, thanks man!! |
spalladino
added a commit
to AztecProtocol/aztec-packages
that referenced
this pull request
Sep 27, 2023
We were using a fork of `docusaurus-plugin-typedoc` due to a bugfix. Now that [the fix was merged upstream](typedoc2md/typedoc-plugin-markdown#472), we can go back to the main version of the package.
AztecBot
pushed a commit
to AztecProtocol/docs
that referenced
this pull request
Sep 28, 2023
We were using a fork of `docusaurus-plugin-typedoc` due to a bugfix. Now that [the fix was merged upstream](typedoc2md/typedoc-plugin-markdown#472), we can go back to the main version of the package.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The generate-typedoc CLI command would run typedoc on every plugin instance defined on the site, not just for the current one. This would cause generation to fail with errors "Tried to set an option that was not declared", since the config for other plugins would not pass the validation for this plugin.
This fix checks that the plugin name matches the current one before running generateTypedoc on it.