feat(doc): display non-exported types referenced in exported types #20990
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
bartlomieju
approved these changes
Oct 26, 2023
Comment on lines
-73
to
-86
| // If the root module has external types, the module graph won't redirect it, | ||
| // so instead create a dummy file which exports everything from the actual file being documented. | ||
| let root_specifier = | ||
| resolve_path("./$deno$doc.ts", cli_options.initial_cwd()).unwrap(); | ||
| let root = File { | ||
| maybe_types: None, | ||
| media_type: MediaType::TypeScript, | ||
| source: format!("export * from \"{module_specifier}\";").into(), | ||
| specifier: root_specifier.clone(), | ||
| maybe_headers: None, | ||
| }; | ||
|
|
||
| // Save our fake file into file fetcher cache. | ||
| file_fetcher.insert_cached(root); |
There was a problem hiding this comment.
Sweet that this funky bit is gone!
There was a problem hiding this comment.
Yeah, deno_doc got smarter here: https://github.com/denoland/deno_doc/blob/eaed9ca50825c2f36ca0b3a5c26d1059af72decd/src/parser.rs#L241-L259
There was a problem hiding this comment.
That actually probably fixes some bugs too.
Comment on lines
1
to
12
| Defined in file:///V:/deno/cli/tests/testdata/doc/referenced_private_types.ts:5:0 | ||
|
|
||
| class MyClass | ||
|
|
||
| prop: MyInterface | ||
|
|
||
| Defined in file:///V:/deno/cli/tests/testdata/doc/referenced_private_types.ts:1:0 | ||
|
|
||
| private interface MyInterface | ||
|
|
||
| prop?: string | ||
|
|
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.
Upgrades to deno_doc 0.70 which includes the feature for showing non-exported types referenced in exported types as well as a much more advanced deno doc that uses a symbol graph.