Offer semantic services alongside AST

lib/ast-converter.js

@@ -73,5 +73,8 @@ module.exports = (ast, extra) => {
     estree.comments = convertComments(ast, extra.code);
   }
 
-  return estree;
+  const astMaps = convert.getASTMaps();
+  convert.resetASTMaps();
+
+  return { estree, astMaps };
 };

lib/convert.js

@@ -25,6 +25,18 @@ const SyntaxKind = nodeUtils.SyntaxKind;
 // Public
 //------------------------------------------------------------------------------
 
+let esTreeNodeToTSNodeMap = new WeakMap();
+let tsNodeToESTreeNodeMap = new WeakMap();
+
+function resetASTMaps() {
+  esTreeNodeToTSNodeMap = new WeakMap();
+  tsNodeToESTreeNodeMap = new WeakMap();
+}
+
+function getASTMaps() {
+  return { esTreeNodeToTSNodeMap, tsNodeToESTreeNodeMap };
+}
+
 /**
  * Converts a TypeScript node into an ESTree node
  * @param  {Object} config configuration options for the conversion
@@ -53,7 +65,7 @@ module.exports = function convert(config) {
    */
   let result = {
     type: '',
-    range: [node.getStart(), node.end],
+    range: [node.getStart(ast), node.end],
     loc: nodeUtils.getLoc(node, ast)
   };
 
@@ -120,7 +132,11 @@ module.exports = function convert(config) {
           typeArgumentsParent.kind === SyntaxKind.TypeReference)
       ) {
         const lastTypeArgument = typeArguments[typeArguments.length - 1];
-        const greaterThanToken = nodeUtils.findNextToken(lastTypeArgument, ast);
+        const greaterThanToken = nodeUtils.findNextToken(
+          lastTypeArgument,
+          ast,
+          ast
+        );
         end = greaterThanToken.end;
       }
     }
@@ -132,7 +148,7 @@ module.exports = function convert(config) {
         if (nodeUtils.isTypeKeyword(typeArgument.kind)) {
           return {
             type: AST_NODE_TYPES[`TS${SyntaxKind[typeArgument.kind]}`],
-            range: [typeArgument.getStart(), typeArgument.getEnd()],
+            range: [typeArgument.getStart(ast), typeArgument.getEnd()],
             loc: nodeUtils.getLoc(typeArgument, ast)
           };
         }
@@ -146,7 +162,7 @@ module.exports = function convert(config) {
         }
         return {
           type: AST_NODE_TYPES.TSTypeReference,
-          range: [typeArgument.getStart(), typeArgument.getEnd()],
+          range: [typeArgument.getStart(ast), typeArgument.getEnd()],
           loc: nodeUtils.getLoc(typeArgument, ast),
           typeName: convertChild(typeArgument.typeName || typeArgument),
           typeParameters: typeArgument.typeArguments
@@ -166,7 +182,11 @@ module.exports = function convert(config) {
     const firstTypeParameter = typeParameters[0];
     const lastTypeParameter = typeParameters[typeParameters.length - 1];
 
-    const greaterThanToken = nodeUtils.findNextToken(lastTypeParameter, ast);
+    const greaterThanToken = nodeUtils.findNextToken(
+      lastTypeParameter,
+      ast,
+      ast
+    );
 
     return {
       type: AST_NODE_TYPES.TSTypeParameterDeclaration,
@@ -199,7 +219,7 @@ module.exports = function convert(config) {
 
         return {
           type: AST_NODE_TYPES.TSTypeParameter,
-          range: [typeParameter.getStart(), typeParameter.getEnd()],
+          range: [typeParameter.getStart(ast), typeParameter.getEnd()],
           loc: nodeUtils.getLoc(typeParameter, ast),
           name,
           constraint,
@@ -266,7 +286,7 @@ module.exports = function convert(config) {
       const expression = convertChild(decorator.expression);
       return {
         type: AST_NODE_TYPES.Decorator,
-        range: [decorator.getStart(), decorator.end],
+        range: [decorator.getStart(ast), decorator.end],
         loc: nodeUtils.getLoc(decorator, ast),
         expression
       };
@@ -477,7 +497,11 @@ module.exports = function convert(config) {
       });
 
       result.range[1] = node.endOfFileToken.end;
-      result.loc = nodeUtils.getLocFor(node.getStart(), result.range[1], ast);
+      result.loc = nodeUtils.getLocFor(
+        node.getStart(ast),
+        result.range[1],
+        ast
+      );
       break;
 
     case SyntaxKind.Block:
@@ -934,11 +958,12 @@ module.exports = function convert(config) {
             return false;
           }
           return nodeUtils.getTextForTokenKind(token.kind) === '(';
-        }
+        },
+        ast
       );
 
       const methodLoc = ast.getLineAndCharacterOfPosition(
-          openingParen.getStart()
+          openingParen.getStart(ast)
         ),
         nodeIsMethod = node.kind === SyntaxKind.MethodDeclaration,
         method = {
@@ -1045,7 +1070,7 @@ module.exports = function convert(config) {
           node
         ),
         firstConstructorToken = constructorIsStatic
-          ? nodeUtils.findNextToken(node.getFirstToken(), ast)
+          ? nodeUtils.findNextToken(node.getFirstToken(), ast, ast)
           : node.getFirstToken(),
         constructorLoc = ast.getLineAndCharacterOfPosition(
           node.parameters.pos - 1
@@ -1069,10 +1094,10 @@ module.exports = function convert(config) {
         };
 
       const constructorIdentifierLocStart = ast.getLineAndCharacterOfPosition(
-          firstConstructorToken.getStart()
+          firstConstructorToken.getStart(ast)
         ),
         constructorIdentifierLocEnd = ast.getLineAndCharacterOfPosition(
-          firstConstructorToken.getEnd()
+          firstConstructorToken.getEnd(ast)
         ),
         constructorIsComputed =
           !!node.name && nodeUtils.isComputedProperty(node.name);
@@ -1084,7 +1109,10 @@ module.exports = function convert(config) {
           type: AST_NODE_TYPES.Literal,
           value: 'constructor',
           raw: node.name.getText(),
-          range: [firstConstructorToken.getStart(), firstConstructorToken.end],
+          range: [
+            firstConstructorToken.getStart(ast),
+            firstConstructorToken.end
+          ],
           loc: {
             start: {
               line: constructorIdentifierLocStart.line + 1,
@@ -1100,7 +1128,10 @@ module.exports = function convert(config) {
         constructorKey = {
           type: AST_NODE_TYPES.Identifier,
           name: 'constructor',
-          range: [firstConstructorToken.getStart(), firstConstructorToken.end],
+          range: [
+            firstConstructorToken.getStart(ast),
+            firstConstructorToken.end
+          ],
           loc: {
             start: {
               line: constructorIdentifierLocStart.line + 1,
@@ -1233,9 +1264,9 @@ module.exports = function convert(config) {
             type: AST_NODE_TYPES.AssignmentPattern,
             left: convertChild(node.name),
             right: convertChild(node.initializer),
-            range: [node.name.getStart(), node.initializer.end],
+            range: [node.name.getStart(ast), node.initializer.end],
             loc: nodeUtils.getLocFor(
-              node.name.getStart(),
+              node.name.getStart(ast),
               node.initializer.end,
               ast
             )
@@ -1292,7 +1323,7 @@ module.exports = function convert(config) {
           {
             type: AST_NODE_TYPES.TemplateElement,
             value: {
-              raw: ast.text.slice(node.getStart() + 1, node.end - 1),
+              raw: ast.text.slice(node.getStart(ast) + 1, node.end - 1),
               cooked: node.text
             },
             tail: true,
@@ -1335,7 +1366,10 @@ module.exports = function convert(config) {
       Object.assign(result, {
         type: AST_NODE_TYPES.TemplateElement,
         value: {
-          raw: ast.text.slice(node.getStart() + 1, node.end - (tail ? 1 : 2)),
+          raw: ast.text.slice(
+            node.getStart(ast) + 1,
+            node.end - (tail ? 1 : 2)
+          ),
           cooked: node.text
         },
         tail
@@ -1426,7 +1460,7 @@ module.exports = function convert(config) {
       if (node.modifiers) {
         return {
           type: AST_NODE_TYPES.TSParameterProperty,
-          range: [node.getStart(), node.end],
+          range: [node.getStart(ast), node.end],
           loc: nodeUtils.getLoc(node, ast),
           accessibility: nodeUtils.getTSNodeAccessibility(node) || undefined,
           readonly:
@@ -1459,7 +1493,7 @@ module.exports = function convert(config) {
           node.typeParameters[node.typeParameters.length - 1];
 
         if (!lastClassToken || lastTypeParameter.pos > lastClassToken.pos) {
-          lastClassToken = nodeUtils.findNextToken(lastTypeParameter, ast);
+          lastClassToken = nodeUtils.findNextToken(lastTypeParameter, ast, ast);
         }
         result.typeParameters = convertTSTypeParametersToTypeParametersDeclaration(
           node.typeParameters
@@ -1483,14 +1517,14 @@ module.exports = function convert(config) {
         const lastModifier = node.modifiers[node.modifiers.length - 1];
 
         if (!lastClassToken || lastModifier.pos > lastClassToken.pos) {
-          lastClassToken = nodeUtils.findNextToken(lastModifier, ast);
+          lastClassToken = nodeUtils.findNextToken(lastModifier, ast, ast);
         }
       } else if (!lastClassToken) {
         // no name
         lastClassToken = node.getFirstToken();
       }
 
-      const openBrace = nodeUtils.findNextToken(lastClassToken, ast);
+      const openBrace = nodeUtils.findNextToken(lastClassToken, ast, ast);
       const superClass = heritageClauses.find(
         clause => clause.token === SyntaxKind.ExtendsKeyword
       );
@@ -1523,8 +1557,8 @@ module.exports = function convert(config) {
           body: [],
 
           // TODO: Fix location info
-          range: [openBrace.getStart(), result.range[1]],
-          loc: nodeUtils.getLocFor(openBrace.getStart(), node.end, ast)
+          range: [openBrace.getStart(ast), result.range[1]],
+          loc: nodeUtils.getLocFor(openBrace.getStart(ast), node.end, ast)
         },
         superClass:
           superClass && superClass.types[0]
@@ -2142,7 +2176,7 @@ module.exports = function convert(config) {
         type: AST_NODE_TYPES.VariableDeclarator,
         id: convertChild(node.name),
         init: convertChild(node.type),
-        range: [node.name.getStart(), node.end]
+        range: [node.name.getStart(ast), node.end]
       };
 
       typeAliasDeclarator.loc = nodeUtils.getLocFor(
@@ -2278,6 +2312,7 @@ module.exports = function convert(config) {
         ) {
           interfaceLastClassToken = nodeUtils.findNextToken(
             interfaceLastTypeParameter,
+            ast,
             ast
           );
         }
@@ -2293,14 +2328,19 @@ module.exports = function convert(config) {
       );
       const interfaceOpenBrace = nodeUtils.findNextToken(
         interfaceLastClassToken,
+        ast,
         ast
       );
 
       const interfaceBody = {
         type: AST_NODE_TYPES.TSInterfaceBody,
         body: node.members.map(member => convertChild(member)),
-        range: [interfaceOpenBrace.getStart(), result.range[1]],
-        loc: nodeUtils.getLocFor(interfaceOpenBrace.getStart(), node.end, ast)
+        range: [interfaceOpenBrace.getStart(ast), result.range[1]],
+        loc: nodeUtils.getLocFor(
+          interfaceOpenBrace.getStart(ast),
+          node.end,
+          ast
+        )
       };
 
       Object.assign(result, {
@@ -2411,5 +2451,11 @@ module.exports = function convert(config) {
       deeplyCopy();
   }
 
+  tsNodeToESTreeNodeMap.set(node, result);
+  esTreeNodeToTSNodeMap.set(result, node);
+
   return result;
 };
+
+module.exports.getASTMaps = getASTMaps;
+module.exports.resetASTMaps = resetASTMaps;