Skip to content
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

Quickfix jsdoc in Typescript files #17250

Merged
merged 10 commits into from
Jul 18, 2017
Merged

Quickfix jsdoc in Typescript files #17250

merged 10 commits into from
Jul 18, 2017

Conversation

sandersn
Copy link
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!

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.
Copy link
Member

@weswigham weswigham left a 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.

@sandersn
Copy link
Member Author

Good idea. I added some documentation.

@sandersn sandersn merged commit 7d7a06d into master Jul 18, 2017
@sandersn sandersn deleted the quickfix-jsdoc-in-ts branch July 18, 2017 15:59
@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.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants