fix(html): preserve ? on optional tuple elements#796
Open
fibibot wants to merge 1 commit into
Open
Conversation
`render_type_def` rendered `TsTypeDefKind::Optional` (the kind produced
for the trailing-`?` form in tuple element types like `[T, U?]`) by
returning the inner type's HTML and dropping the `?`. The text-mode
`Display` already emits `{ty}?` — mirror that for HTML so the
generated docs match the source signature.
Snapshots refreshed: `html_test__symbol_group.snap` and the
`html_doc_files_multiple` family now correctly capture the `?`.
Fixes denoland/deno#29669.
|
|
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
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.
Summary
Reported in denoland/deno#29669. `render_type_def` in `src/html/types.rs` handled `TsTypeDefKind::Optional` (the kind produced for the trailing-`?` form in tuple element types like `[T, U?]`) by returning the inner type's HTML and dropping the `?`:
```rust
TsTypeDefKind::Optional(inner) => render_type_def(ctx, inner),
```
So this source:
```ts
export function a(x: [number, number?]): number {
return x[0] + (x?.[1] ?? 0);
}
```
rendered as `[number, number]` in HTML even though terminal/JSON output (which goes through `Display` and emits `{ty}?`) was correct. Mirror the `Display` behaviour for HTML.
Test plan