feat: Documentation.toJson() can handle nested submodules #1190
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
rix0rrr
reviewed
Nov 2, 2023
|
|
||
| return submodules[0]; | ||
| if (found.length > 1) { | ||
| throw new Error(`Found multiple submodules with name: ${submodule} in assembly ${assembly.name}@${assembly.version}`); |
There was a problem hiding this comment.
I'm pretty sure this can never happen, but okay.
rix0rrr
reviewed
Nov 2, 2023
src/docgen/view/documentation.ts
Outdated
| @@ -315,19 +315,25 @@ export class Documentation { | |||
| * Lookup a submodule by a submodule name. | |||
There was a problem hiding this comment.
Maybe update the docs to indicate what we now support?
rix0rrr
approved these changes
Nov 3, 2023
comcalvi
added a commit
that referenced
this pull request
Nov 15, 2023
)" This reverts commit 9036833.
mergify bot
pushed a commit
that referenced
this pull request
Nov 15, 2023
) Reverts #1190. Reverting https://github.com/cdklabs/construct-hub/pull/1350/files wasn't sufficient to unblock constructhub, we're still getting the same errors messages (which originate from jsii-docgen). Reverting this should unblock the pipeline.
rix0rrr
pushed a commit
that referenced
this pull request
Nov 21, 2023
Allow users to create documentation for nested modules. Suppose a project has the following submodule structure:
```
my-project
└── foo
└── bar
```
where `foo` and `bar` are submodules. To generate documentation for the `bar` module, call `documentation.toJson('foo.bar')`.
rix0rrr
added a commit
that referenced
this pull request
Nov 21, 2023
(This is a re-roll of #1190). `jsii-docgen` used to assume that submodules only went one level deep, i.e. that there could not be submodules within submodules. Break that assumption by doing the following: - Use `assembly.allSubmodules` everywhere `assembly.submodules` used to be used. - Address submodules by FQN instead of by `name` (which only holds the last name component). - As an exception: `documentation.toJson()` accepts both FQN as well as root-relative name for backwards compatibility.
mergify bot
pushed a commit
that referenced
this pull request
Nov 21, 2023
(This is a re-roll of #1190). `jsii-docgen` used to assume that submodules only went one level deep, i.e. that there could not be submodules within submodules. Break that assumption by doing the following: - Use `assembly.allSubmodules` everywhere `assembly.submodules` used to be used. - Address submodules by FQN instead of by `name` (which only holds the last name component). - As an exception: `documentation.toJson()` accepts both FQN as well as root-relative name for backwards compatibility.
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.
Allow users to create documentation for nested modules. Suppose a project has the following submodule structure:
where
fooandbarare submodules. To generate documentation for thebarmodule, calldocumentation.toJson('foo.bar').