convert JSDoc typedef to type, issue 50644

[brendaHuang]

Fixes #50644

This PR converts JSDoc typedef to type. It converts two common use cases of @typedef as listed in the JSDoc documentation and other variations, such as nested object types and using @typedef to define primitive types.

Of the five test files, one one addresses the union type, and one primitive type.
The other three addresses object types (index signatures), including nested object types and object types that have comments attached to the properties.

[typescript-bot]

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

[brendaHuang]

@microsoft-github-policy-service agree company="LinkedIn"

[brendaHuang]

@microsoft-github-policy-service agree company="LinkedIn"

[brendaHuang]

@andrewbranch Would you take a look at this PR? Thanks.

[jakebailey]

This is a first past skim review; I think I'd need to think of some edge cases here. Probably @andrewbranch and @sandersn know more.

[jakebailey]

It's too late now, but if you can avoid it, I'd appreciate merges from main and additional commits (instead of force pushing) as it's hard to follow what changed in the PR and what comments have been addressed. We squash on PR merge so no need to keep the PR clean. (See our contributing guide: https://github.com/microsoft/TypeScript/blob/main/CONTRIBUTING.md#force-pushing)

[brendaHuang]

It's too late now, but if you can avoid it, I'd appreciate merges from main and additional commits (instead of force pushing) as it's hard to follow what changed in the PR and what comments have been addressed. We squash on PR merge so no need to keep the PR clean. (See our contributing guide: https://github.com/microsoft/TypeScript/blob/main/CONTRIBUTING.md#force-pushing)

Okay. Will do.

[brendaHuang]

@jakebailey @andrewbranch After I rebased yesterday, the newly added tests failed, which passed before.

As I ran the debugger, the type alias declaration was successfully created. Then node.modifiers is passed into Line 1280 of src/compiler/visitorPublic.ts, then assignPositionsToNodeArray() of src/services/textChanges.ts, then eventually failed at Line 178 in the getPos() function of src/services/textChanges.ts. The value of node.modifiers is [pos: -1, end: -1, hasTrailingComma: false, transformFlags: 0].

Please see screenshots attached. Thank you very much for your help!

[jakebailey]

I checked, and it's because you're passing in an empty array for modifiers to createTypeAliasDeclaration. I would recheck all of your create functions to see if you could actually just pass in undefined instead.

[brendaHuang]

@jakebailey Thank you very much! The tests now passed. Please review again.

[brendaHuang]

@jakebailey @andrewbranch Would you take another look at this PR? Thanks.

[jakebailey]

Seems reasonable, I think? Still not an expert, but it seems about as concise as I can imagine.

[brendaHuang]

@andrewbranch Would you take a look? Thank you very much.

[andrewbranch]

Nice work, thanks @brendaHuang!