GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Quickfix jsdoc in Typescript files by sandersn · Pull Request #17250 · microsoft/TypeScript

Conversation

@sandersn

@sandersn Nathan Shively-Sanders (sandersn) commented Jul 17, 2017

Copy link
Copy Markdown
Member

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:

  1. Because this error is not issued in Javascript files, it is not applicable to (for example) flow files that have the .js extension. Those files will continue to get the "types can only be used .ts files" error.
  2. Because the codefix uses getTypeFromTypeNode and typeToString, you will only get T | null from ?T for strictNullChecks: true. This is technically correct, but loses the intent of the JSDoc.
  3. The codefix has a special case for ?T since it is valid flow syntax as well as valid JSDoc/Closure syntax. The special case converts ?T to T | null | undefined. Because of other flow and typescript differences, this is not likely to be a successful Flow → Typescript converter!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Nathan Shively-Sanders (sandersn) added 8 commits July 14, 2017 16:27
@sandersn
Add simple jsdoc code fix changes
a3a6862
@sandersn
Add codefix for jsdoc types in Typescript
efdba54
It only handles a few simple types right now, but the skeleton is there.
@sandersn
Merge branch 'parse-jsdoc-with-ts-type-parser' into quickfix-jsdoc-in-ts
e98ac8d
@sandersn
Transform trees rather than produce strings
dba552d
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.)
@sandersn
Codefix for Array.<number> -> Array<number>
3776b0b
@sandersn
Codefix for ?! pre/postfix JSDoc types
f9e5576
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.
@sandersn
Update jsdoc codefix tests; test function(...) syntax
cbe7b4d
@sandersn
JSDoc codefix:getTypeFromTypeNode >>> typeToString
b13de05
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.
@msftclas Microsoft Contribution License Agreements (msftclas) added the cla-not-required label Jul 17, 2017
@sandersn
Nathan Shively-Sanders (sandersn) requested a review from Wesley Wigham (weswigham) July 17, 2017 21:33
@sandersn
Make sure not to truncate the stringified type from typeToString
73cfa64
weswigham
Wesley Wigham (weswigham) approved these changes Jul 18, 2017
View reviewed changes

@weswigham Wesley Wigham (weswigham) left a comment

Copy link
Copy Markdown
Member

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@sandersn
Add jsdoc to getNullableType now that it's public
65e8da1
@sandersn

Nathan Shively-Sanders (sandersn) commented Jul 18, 2017

Copy link
Copy Markdown
Member Author

Good idea. I added some documentation.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@sandersn
Nathan Shively-Sanders (sandersn) merged commit 7d7a06d into master Jul 18, 2017
@sandersn
Nathan Shively-Sanders (sandersn) deleted the quickfix-jsdoc-in-ts branch July 18, 2017 15:59
@microsoft Microsoft (microsoft) locked and limited conversation to collaborators Jun 14, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@weswigham Wesley Wigham (weswigham) weswigham approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@sandersn @weswigham @msftclas
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 are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.