fix: Fix loading options twice in bootstrap to keep 'extends'. #1273
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
|
This will break wrappers around TypeDoc. Both the Grunt and Gulp wrappers around TypeDoc use the option passing in bootstrap to let users specify config files or options directly. A better solution would be to clone the options object before mutating it. |
|
@Gerrit0 Thanks for the tip. Please review the new changes. |
Gerrit0
requested changes
Apr 20, 2020
| @@ -21,6 +21,11 @@ export function addTypeDocOptions(options: Options) { | |||
| type: ParameterType.Array | |||
| }); | |||
|
|
|||
| options.addDeclaration({ | |||
There was a problem hiding this comment.
This implies that users can specify --extends on the command line, or in typedocOptions in tsconfig.json, which isn't true.
There was a problem hiding this comment.
Best to just remove it, I still need to update the website docs to mention this, but it shouldn't show up in --help.
| logger.error(`The file ${file} is not an object.`); | ||
| return; | ||
| } | ||
|
|
||
| // clone option object to avoid of property changes in re-calling this file | ||
| const data: object = cloneDeep(fileContent); |
|
Thanks! Should have a release out this weekend. |
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.
Fix #1272
Every time we open the option files and after reading the value of extends in each one, this property is removed from that file, so the next time the value of extends is no longer available to us (according to this code logics).
Therefore, reading the options file more than once will cause #1272 issue.