feat(51086): satisfies support in JSDoc - #51753
Merged
Nathan Shively-Sanders (sandersn) merged 26 commits intoJan 17, 2023
Merged
Conversation
TypeScript Bot (typescript-bot)
added
the
For Uncommitted Bug
Member
|
TypeScript Bot (@typescript-bot) pack this |
Contributor
|
Heya Daniel Rosenwasser (@DanielRosenwasser), I've started to run the abridged perf test suite on this PR at 59b288f. You can monitor the build here. Update: The results are in! |
Contributor
|
Heya Daniel Rosenwasser (@DanielRosenwasser), I've started to run the tarball bundle task on this PR at 59b288f. You can monitor the build here. |
Contributor
|
Hey Daniel Rosenwasser (@DanielRosenwasser), I've packed this into an installable tgz. You can install it for testing by referencing it in your and then running There is also a playground for this build and an npm module you can use via |
Contributor
|
Daniel Rosenwasser (@DanielRosenwasser) Here they are:Comparison Report - main..51753
System
Hosts
Scenarios
Developer Information: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Member
|
TypeScript Bot (@typescript-bot) pack this |
Contributor
|
Heya Daniel Rosenwasser (@DanielRosenwasser), I've started to run the tarball bundle task on this PR at 7d823ae. You can monitor the build here. |
Contributor
|
Hey Daniel Rosenwasser (@DanielRosenwasser), I've packed this into an installable tgz. You can install it for testing by referencing it in your and then running There is also a playground for this build and an npm module you can use via |
Contributor
Author
|
Daniel Rosenwasser (@DanielRosenwasser) Could you take a look at these changes? I want to be sure about
|
Member
|
I think the specific use case we had in mind was a /** @satisfies {{ f: (x: string) => string }} */
let obj1 = { f: s => s.toLowerCase() }; // should work
/** @satisfies {{ f: (x: string) => string }} */
let obj2 = { g: "oops" }; // should errorsimilar to how an |
Contributor
|
Daniel Rosenwasser (@DanielRosenwasser) Here they are:
CompilerComparison Report - main..51753
System
Hosts
Scenarios
TSServerComparison Report - main..51753
System
Hosts
Scenarios
StartupComparison Report - main..51753
System
Hosts
Scenarios
Developer Information: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Nathan Shively-Sanders (sandersn)
requested changes
Jan 12, 2023
Nathan Shively-Sanders (sandersn)
left a comment
Nathan Shively-Sanders (sandersn)
left a comment
Member
There was a problem hiding this comment.
I'm not sure it's necessary to fix the ParenthesizedExpression bug -- it's still an existing bug with @type afaik -- but we should have tests for it.
Oleksandr Tarasiuk (a-tarasyuk)
force-pushed
the
feat/51086
branch
2 times, most recently
from
January 13, 2023 17:14
660fa79 to
e19d791
Compare
…ializer expression. rename utilities.
Oleksandr Tarasiuk (a-tarasyuk)
force-pushed
the
feat/51086
branch
from
January 13, 2023 17:16
e19d791 to
62b9c22
Compare
Member
|
TypeScript Bot (@typescript-bot) pack this |
Contributor
|
Heya Daniel Rosenwasser (@DanielRosenwasser), I've started to run the tarball bundle task on this PR at 98f7db6. You can monitor the build here. |
Contributor
|
Hey Daniel Rosenwasser (@DanielRosenwasser), I've packed this into an installable tgz. You can install it for testing by referencing it in your and then running There is also a playground for this build and an npm module you can use via |
Nathan Shively-Sanders (sandersn)
approved these changes
Jan 14, 2023
Member
|
So we tried
Those are the two things I would want to get fixed with this PR. Something minor that we noticed was that there are mismatches between what TypeScript does in annotation/assertion/satisfies positions, along with what the corresponding JSDoc equivalents are. // TS file
let a: string = 123;
// ~
let b = 123 as string;
// ~~~~~~~~~~~~~
let c = 123 satisfies string;
// ~~~~~~// JS file
/** @satisfies {string} */
let a = 123;
// ~
let b = /** @type {string} */ (123);
// ~~~~~~
/** @satisfies {string} */
// ~~~~~~
let c = 123;
let d = /** @satisfies {string} */ (123);
// ~~~~~~These are not consistent, but to be honest, I don't want you to change what you have in this PR because it would end up dragging it on and it's a separate concern from the feature itself. I'd rather file a separate follow-up issue instead. |
Nathan Shively-Sanders (sandersn)
approved these changes
Jan 17, 2023
5 tasks
1 task
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
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.
Fixes #51086