Fix: Location data for typeAnnotations

Author: JamesHenry

lib/convert.js

@@ -85,10 +85,12 @@ module.exports = function convert(config) {
      */
     function convertTypeAnnotation(child) {
         const annotation = convertChild(child);
+        const annotationStartCol = child.getFullStart() - 1;
+        const loc = nodeUtils.getLocFor(annotationStartCol, child.end, ast);
         return {
             type: AST_NODE_TYPES.TypeAnnotation,
-            loc: annotation.loc,
-            range: annotation.range,
+            loc,
+            range: [annotationStartCol, child.end],
             typeAnnotation: annotation
         };
     }
@@ -160,7 +162,7 @@ module.exports = function convert(config) {
 
                 const constraint = typeParameter.constraint
                     ? convert({ node: typeParameter.constraint, parent: typeParameter, ast, additionalOptions })
-                    : null;
+                    : undefined;
 
                 const defaultParameter = typeParameter.default
                     ? convert({ node: typeParameter.default, parent: typeParameter, ast, additionalOptions })
@@ -392,6 +394,19 @@ module.exports = function convert(config) {
         result.modifiers = remainingModifiers.map(convertChild);
     }
 
+    /**
+     * Uses the current TSNode's end location for its `type` to adjust the location data of the given
+     * ESTreeNode, which should be the parent of the final typeAnnotation node
+     * @param {ESTreeNode} typeAnnotationParent The node that will have its location data mutated
+     * @returns {void}
+     */
+    function fixTypeAnnotationParentLocation(typeAnnotationParent) {
+        const end = node.type.getEnd();
+        typeAnnotationParent.range[1] = end;
+        const loc = nodeUtils.getLocFor(typeAnnotationParent.range[0], typeAnnotationParent.range[1], ast);
+        typeAnnotationParent.loc = loc;
+    }
+
     /**
      * The core of the conversion logic:
      * Identify and convert each relevant TypeScript SyntaxKind
@@ -619,15 +634,7 @@ module.exports = function convert(config) {
 
             if (node.type) {
                 result.id.typeAnnotation = convertTypeAnnotation(node.type);
-                result.id.range[1] = node.type.getEnd();
-
-                const identifierEnd = node.name.getEnd();
-                const numCharsBetweenTypeAndIdentifier = node.type.getStart() - (node.type.getFullStart() - identifierEnd - ":".length) - identifierEnd;
-
-                result.id.typeAnnotation.range = [
-                    result.id.typeAnnotation.range[0] - numCharsBetweenTypeAndIdentifier,
-                    result.id.typeAnnotation.range[1]
-                ];
+                fixTypeAnnotationParentLocation(result.id);
             }
             break;
         }
@@ -806,7 +813,7 @@ module.exports = function convert(config) {
                 value: convertChild(node.initializer),
                 computed: nodeUtils.isComputedProperty(node.name),
                 static: nodeUtils.hasStaticModifierFlag(node),
-                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node)
+                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node) || undefined
             });
 
             if (node.type) {
@@ -1273,7 +1280,7 @@ module.exports = function convert(config) {
 
             if (node.type) {
                 parameter.typeAnnotation = convertTypeAnnotation(node.type);
-                parameter.range[1] = node.type.getEnd();
+                fixTypeAnnotationParentLocation(parameter);
             }
 
             if (node.questionToken) {
@@ -1286,9 +1293,9 @@ module.exports = function convert(config) {
                     range: [node.getStart(), node.end],
                     loc: nodeUtils.getLoc(node, ast),
                     accessibility: nodeUtils.getTSNodeAccessibility(node),
-                    readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node),
+                    readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node) || undefined,
                     static: nodeUtils.hasModifier(SyntaxKind.StaticKeyword, node),
-                    export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node),
+                    export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node) || undefined,
                     parameter: result
                 };
             }
@@ -1941,9 +1948,9 @@ module.exports = function convert(config) {
                 key: convertChild(node.name),
                 params: convertParameters(node.parameters),
                 typeAnnotation: (node.type) ? convertTypeAnnotation(node.type) : null,
-                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node),
+                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node) || undefined,
                 static: nodeUtils.hasModifier(SyntaxKind.StaticKeyword, node),
-                export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node)
+                export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node) || undefined
             });
 
             const accessibility = nodeUtils.getTSNodeAccessibility(node);
@@ -1961,14 +1968,14 @@ module.exports = function convert(config) {
         case SyntaxKind.PropertySignature: {
             Object.assign(result, {
                 type: AST_NODE_TYPES.TSPropertySignature,
-                optional: nodeUtils.isOptional(node),
+                optional: nodeUtils.isOptional(node) || undefined,
                 computed: nodeUtils.isComputedProperty(node.name),
                 key: convertChild(node.name),
-                typeAnnotation: (node.type) ? convertTypeAnnotation(node.type) : null,
-                initializer: convertChild(node.initializer),
-                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node),
-                static: nodeUtils.hasModifier(SyntaxKind.StaticKeyword, node),
-                export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node)
+                typeAnnotation: (node.type) ? convertTypeAnnotation(node.type) : undefined,
+                initializer: convertChild(node.initializer) || undefined,
+                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node) || undefined,
+                static: nodeUtils.hasModifier(SyntaxKind.StaticKeyword, node) || undefined,
+                export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node) || undefined
             });
 
             const accessibility = nodeUtils.getTSNodeAccessibility(node);
@@ -1984,9 +1991,9 @@ module.exports = function convert(config) {
                 type: AST_NODE_TYPES.TSIndexSignature,
                 index: convertChild(node.parameters[0]),
                 typeAnnotation: (node.type) ? convertTypeAnnotation(node.type) : null,
-                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node),
+                readonly: nodeUtils.hasModifier(SyntaxKind.ReadonlyKeyword, node) || undefined,
                 static: nodeUtils.hasModifier(SyntaxKind.StaticKeyword, node),
-                export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node)
+                export: nodeUtils.hasModifier(SyntaxKind.ExportKeyword, node) || undefined
             });
 
             const accessibility = nodeUtils.getTSNodeAccessibility(node);

package.json

@@ -19,7 +19,7 @@
   "license": "BSD-2-Clause",
   "devDependencies": {
     "babel-code-frame": "^6.22.0",
-    "babylon": "^7.0.0-beta.20",
+    "babylon": "^7.0.0-beta.21",
     "eslint": "3.19.0",
     "eslint-config-eslint": "4.0.0",
     "eslint-plugin-node": "4.2.2",