refactor(typescript-estree): add type guards for typescript-estree

[armano2]

This PR aims to add proper types to conversion done by typescript-estree

this PR is currently blocked by #2933, #3081

changes from #3081 has been merged to this branch

---

detected issues with AST so far

LeftHandSideExpression can be a AwaitExpression #3083

const a = ++(await x)

IntrinsicKeyword is not defined in AST #3081

type Uppercase<S extends string> = intrinsic;

PrivateIdentifier is not defined in AST #2933

class x {
 #y
}

TryStatement finalizer can be null #3083

try {} catch {}

RegExpLiteral value can be null if regexp is invalid or unsupported by env #3083

good example in this case can be any proposal that has not been accepted yet
eg. https://github.com/tc39/proposal-regexp-match-indices

const x = /a+(?<Z>z)?/d

JSXOpeningElement attributes can be a JSXSpreadAttribute #3083

const foo = <x {...spread}></x>

TSModuleDeclaration body can be TSModuleDeclaration #3083

// TSModuleDeclaration without body
module "x";
// TSModuleDeclaration -> TSModuleBlock
module x {
}
// TSModuleDeclaration -> TSModuleDeclaration **
module x.x {
}

---

issues that need additional investigation

Type '(PropertyComputedName | PropertyNonComputedName | TSEmptyBodyFunctionExpression | TSAbstractMethodDefinitionComputedName | ... 4 more ... | SpreadElement)[]' is not assignable to type 'ObjectLiteralElementLike[]'.
  Type 'PropertyComputedName | PropertyNonComputedName | TSEmptyBodyFunctionExpression | TSAbstractMethodDefinitionComputedName | ... 4 more ... | SpreadElement' is not assignable to type 'ObjectLiteralElementLike'.
    Type 'TSEmptyBodyFunctionExpression' is not assignable to type 'ObjectLiteralElementLike'.
      Type 'TSEmptyBodyFunctionExpression' is missing the following properties from type 'MethodDefinitionNonComputedName': key, computed, value, static, kind

Type '(PropertyComputedName | PropertyNonComputedName | RestElement | AssignmentPattern)[]' is not assignable to type '(PropertyComputedName | PropertyNonComputedName | RestElement)[]'.
  Type 'PropertyComputedName | PropertyNonComputedName | RestElement | AssignmentPattern' is not assignable to type 'PropertyComputedName | PropertyNonComputedName | RestElement'.
    Type 'AssignmentPattern' is not assignable to type 'PropertyComputedName | PropertyNonComputedName | RestElement'.
      Property 'argument' is missing in type 'AssignmentPattern' but required in type 'RestElement'.

[typescript-eslint]

Thanks for the PR, @armano2!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[codecov]

Codecov Report

Merging #3078 (8433bbe) into master (509a117) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #3078   +/-   ##
=======================================
  Coverage   92.83%   92.83%           
=======================================
  Files         314      314           
  Lines       10672    10675    +3     
  Branches     3027     3027           
=======================================
+ Hits         9907     9910    +3     
  Misses        348      348           
  Partials      417      417           

Flag	Coverage Δ
unittest	92.83% <100.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...pt-estree/src/ts-estree/estree-to-ts-node-types.ts	100.00% <ø> (ø)
packages/typescript-estree/src/convert.ts	98.37% <100.00%> (+<0.01%)	⬆️
packages/eslint-plugin/src/rules/no-unused-vars.ts	96.66% <0.00%> (-0.03%)	⬇️
packages/visitor-keys/src/visitor-keys.ts	100.00% <0.00%> (ø)
.../src/rules/sort-type-union-intersection-members.ts	92.53% <0.00%> (ø)

[bradzacher]

I don't think this works the way you think it will - typescript will not parameterise the passed type of node, meaning this type will be the same as TSESTreeToTSNodeGuard<TSNodeConvertable, P>

[armano2]

yea i know that this type is not going to work, and it seem that there is no easy way around it, for now i just wanted to validate if we are missing anything in ast, best aproach i can think of is

  private convertJSXTagName<T extends ts.JsxTagNameExpression>(
    node: T,
    parent: ts.Node,
  ): T extends ts.JsxTagNamePropertyAccess
    ? TSESTree.JSXMemberExpression
    : T extends ts.ThisExpression | ts.Identifier
    ? TSESTree.JSXIdentifier
    : TSESTree.JSXMemberExpression | TSESTree.JSXIdentifier;

  private convertJSXTagName(
    node: ts.JsxTagNameExpression,
    parent: ts.Node,
  ): TSESTree.JSXMemberExpression | TSESTree.JSXIdentifier {

different function but same issue

[armano2]

https://www.typescriptlang.org/play?ts=4.1.5#code/JYOwLgpgTgZghgYwgAgEJwM4QHIHsAmKA3gLABQylykGYAjAFzK1SgDm5AvueaJLIhR5CdZBAAekEPgxpMOAsXJVkAa1D4mdZVRi5cTFuy48yfaPCTJhEAExjJEabPRYbyUhSrrpTWzsoAIzgoQzBWEA4ybjJyAHo45ABaFNS09IzMrNMYAFcQBDBgXBBqCFpRAAoQRSYbUQAfa0VbAEomMABPAAcIXBhkGsIHKRlmkWQAfmQAcjoZ5A6evoGhlAlR2Rt7aZnbBaYQXIAbY48A5GAB6sUAOh98ZABeF+Q6VvOvFUo1271cZ6zeYXFQJZAAATAGCSEl6hRhUCguCgIKov2CUEBcxmqMoUAgYFyUFK2IunDExywl2uvwez1ebU+3zRdwxWP2uOQYMh0NhEHh0CRKK+31+-3ZOJFKnxhOJsw5Ipi0oJRNKR1OJliZDBWV1et1OXyhWKpRoYFsAB4ACojJxjerIJrbAB8yBuhCYVvayBtGztW0Uol280WPttznGdim8oOgxOZ08KiubtpGnpTzeH0TzMGd3FGdJUqo3KhMPEcLACKFnPRISxwKLeJVcsLKnJEEpKGT7og9zTLwzjOzzNrmILCpzXMSPLLFaryJref0Es5MtVMbJFzXcvVx018US+qPx9MhAQxxCKDyBSKJUuGHqPaYcBAnW9a3vke0ZDPF-xyGvY072AB8WifZAXzfQ5FE-bZTHIQDb1NcpzWtcN7UDR1I1sV1wK9T10IDCZg1jX1HAjbZoz2WNdyZKhuxAx81laLNF0IP5lwLBtJxLXly35StBQXRtc3YtkuMlSdtxJbiqHbTtqTdRiwOY1iRNHFcRN42cBPnYVJzFTiNxE6TjLbLdmzVeNNSAA