CARVIEW |
Select Language
HTTP/2 200
date: Fri, 18 Jul 2025 22:51:01 GMT
content-type: text/html; charset=utf-8
cache-control: no-cache
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
referrer-policy: no-referrer-when-downgrade
server-timing: pull_request_layout-fragment;desc="pull_request_layout fragment";dur=305.352477,conversation_content-fragment;desc="conversation_content fragment";dur=436.810567,conversation_sidebar-fragment;desc="conversation_sidebar fragment";dur=263.472774,nginx;desc="NGINX";dur=1.509653,glb;desc="GLB";dur=99.037614
strict-transport-security: max-age=31536000; includeSubdomains; preload
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-content-type-options: nosniff
x-frame-options: deny
x-voltron-version: fd8fbbc
x-xss-protection: 0
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=jOGaK%2BZMHAqovKv4Ao7pNGJvvGcLMQehE8XybxfcFR%2Fq9HcXhNr7dyrzJBFQN%2BT9gY96TRrO2JTpfPeIhRXI%2BsBXojQ2aV70htFWenx6SFKonO1voqnJA9Q%2FKuU7L5KtOup9i5T0wWqW%2B%2BX9g1EOJg%2BMbkEQAeQD59%2F6wsk06T301oT9pcptDEGYt85cARsMXVr4eLiFIwmHRVW8fRbwtGlgZFlySku%2FL0JrCoRw2523u3fbTgdj2UKxMfifg3KshMy9jSF1p3szEWIcZUeTcQ%3D%3D--JN4gAfFQwD%2FbfX%2F0--g%2BrOERID5yfkly5vs8h%2FJw%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.2005025583.1752879061; Path=/; Domain=github.com; Expires=Sat, 18 Jul 2026 22:51:01 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Sat, 18 Jul 2026 22:51:01 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: DB4E:11AC52:1E8FFB:292F0B:687ACFD5
Quickfix jsdoc in Typescript files by sandersn · Pull Request #17250 · microsoft/TypeScript · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 12.9k
Quickfix jsdoc in Typescript files #17250
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
It only handles a few simple types right now, but the skeleton is there.
1. Still pretty janky. 2. Type Reference code doesn't work yet. 3. Other transforms just aren't done. 4. Always replaces, even when there isn't any transformation of JSDoc types. (This probably isn't an issue since we wouldn't issue an error unless there were some JSDoc to change.)
For ?, provide two code fixes, one for jsdoc/closure semantics (`?t -> t | null)` and one for flow semantics (`?t -> t | null | undefined`). The current way of doing this is the hackiest thing you can imagine, but it was easier than lifting everything into the list monad for a code fix that I might not actually keep.
Instead of trying to walk the type structure in the codefix, I changed to call getTypeFromTypeNode in the checker and then calling typeToString. Together, these two functions normalise out JSDoc. Note that you only get `T | null` for `?T` if you have --strict on. This is technically correct -- adding a null union does nothing without strict -- but it would still serve as documentation.
weswigham
approved these changes
Jul 18, 2017
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks super clean, actually. Maybe add some doc comments to getNullableType
since it will become part of our API.
Good idea. I added some documentation. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
You can’t perform that action at this time.
Add a codefix for the "JSDoc types can only be used inside documentation comments" error in .ts files. The codefix offers to convert the JSDoc-syntax type into the equivalent Typescript-syntax type.
Notes:
getTypeFromTypeNode
andtypeToString
, you will only getT | null
from?T
forstrictNullChecks: true
. This is technically correct, but loses the intent of the JSDoc.?T
since it is valid flow syntax as well as valid JSDoc/Closure syntax. The special case converts?T
toT | null | undefined
. Because of other flow and typescript differences, this is not likely to be a successful Flow → Typescript converter!