hermes-parser 0.5.0 → 0.8.0

package/dist/HermesToESTreeAdapter.js

@@ -1,216 +1,453 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
+exports.default = void 0;
+
+var _HermesASTAdapter = _interopRequireDefault(require("./HermesASTAdapter"));
+
+var _getModuleDocblock = require("./getModuleDocblock");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * 
+ * @format
+ */
+
+/*
+This class does some very "javascripty" things in the name of
+performance which are ultimately impossible to soundly type.
+
+So instead of adding strict types and a large number of suppression
+comments, instead it is left untyped and subclasses are strictly
+typed via a separate flow declaration file.
+*/
+class HermesToESTreeAdapter extends _HermesASTAdapter.default {
+  constructor(options, code) {
+    super(options);
+    this.code = void 0;
+    this.code = code;
+  }
 
-var _HermesASTAdapter2 = _interopRequireDefault(require("./HermesASTAdapter"));
+  fixSourceLocation(node) {
+    var _this$sourceFilename;
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+    const loc = node.loc;
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+    if (loc == null) {
+      return;
+    }
 
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+    node.loc = {
+      source: (_this$sourceFilename = this.sourceFilename) != null ? _this$sourceFilename : null,
+      start: loc.start,
+      end: loc.end
+    };
+    node.range = [loc.rangeStart, loc.rangeEnd];
+    delete node.start;
+    delete node.end;
+  }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+  mapNode(node) {
+    this.fixSourceLocation(node);
 
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+    switch (node.type) {
+      case 'Program':
+        return this.mapProgram(node);
 
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+      case 'NullLiteral':
+        return this.mapNullLiteral(node);
 
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+      case 'BooleanLiteral':
+      case 'StringLiteral':
+      case 'NumericLiteral':
+      case 'JSXStringLiteral':
+        return this.mapSimpleLiteral(node);
 
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+      case 'BigIntLiteral':
+        return this.mapBigIntLiteral(node);
 
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+      case 'RegExpLiteral':
+        return this.mapRegExpLiteral(node);
 
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+      case 'Empty':
+        return this.mapEmpty(node);
 
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+      case 'TemplateElement':
+        return this.mapTemplateElement(node);
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+      case 'BigIntLiteralTypeAnnotation':
+        return this.mapBigIntLiteralTypeAnnotation(node);
 
-var HermesToESTreeAdapter = /*#__PURE__*/function (_HermesASTAdapter) {
-  _inherits(HermesToESTreeAdapter, _HermesASTAdapter);
+      case 'GenericTypeAnnotation':
+        return this.mapGenericTypeAnnotation(node);
 
-  var _super = _createSuper(HermesToESTreeAdapter);
+      case 'ImportDeclaration':
+        return this.mapImportDeclaration(node);
 
-  function HermesToESTreeAdapter(options, code) {
-    var _this;
+      case 'ImportSpecifier':
+        return this.mapImportSpecifier(node);
 
-    _classCallCheck(this, HermesToESTreeAdapter);
+      case 'ExportDefaultDeclaration':
+        return this.mapExportDefaultDeclaration(node);
 
-    _this = _super.call(this, options);
+      case 'ExportNamedDeclaration':
+        return this.mapExportNamedDeclaration(node);
 
-    _defineProperty(_assertThisInitialized(_this), "code", void 0);
+      case 'ExportAllDeclaration':
+        return this.mapExportAllDeclaration(node);
 
-    _this.code = code;
-    return _this;
-  }
+      case 'Property':
+        return this.mapProperty(node);
 
-  _createClass(HermesToESTreeAdapter, [{
-    key: "fixSourceLocation",
-    value: function fixSourceLocation(node) {
-      var _this$sourceFilename;
+      case 'FunctionDeclaration':
+      case 'FunctionExpression':
+      case 'ArrowFunctionExpression':
+        return this.mapFunction(node);
 
-      var loc = node.loc;
+      case 'PrivateName':
+        return this.mapPrivateName(node);
 
-      if (loc == null) {
-        return;
-      }
+      case 'ClassProperty':
+      case 'ClassPrivateProperty':
+        return this.mapClassProperty(node);
 
-      node.loc = {
-        source: (_this$sourceFilename = this.sourceFilename) !== null && _this$sourceFilename !== void 0 ? _this$sourceFilename : null,
-        start: loc.start,
-        end: loc.end
-      };
-      node.range = [loc.rangeStart, loc.rangeEnd];
+      case 'MemberExpression':
+      case 'OptionalMemberExpression':
+      case 'CallExpression':
+      case 'OptionalCallExpression':
+        return this.mapChainExpression(node);
+
+      default:
+        return this.mapNodeDefault(node);
     }
-  }, {
-    key: "mapNode",
-    value: function mapNode(node) {
-      this.fixSourceLocation(node);
+  }
 
-      switch (node.type) {
-        case 'Program':
-          return this.mapProgram(node);
+  mapProgram(node) {
+    node = this.mapNodeDefault(node);
+    node.sourceType = this.getSourceType();
+    node.docblock = (0, _getModuleDocblock.getModuleDocblock)(node);
+    return node;
+  }
 
-        case 'NullLiteral':
-          return this.mapNullLiteral(node);
+  mapSimpleLiteral(node) {
+    return {
+      type: 'Literal',
+      loc: node.loc,
+      range: node.range,
+      value: node.value,
+      raw: this.code.slice(node.range[0], node.range[1]),
+      literalType: (() => {
+        switch (node.type) {
+          case 'NullLiteral':
+            return 'null';
+
+          case 'BooleanLiteral':
+            return 'boolean';
+
+          case 'StringLiteral':
+          case 'JSXStringLiteral':
+            return 'string';
+
+          case 'NumericLiteral':
+            return 'numeric';
+
+          case 'BigIntLiteral':
+            return 'bigint';
+
+          case 'RegExpLiteral':
+            return 'regexp';
+        }
 
-        case 'BooleanLiteral':
-        case 'StringLiteral':
-        case 'NumericLiteral':
-          return this.mapSimpleLiteral(node);
+        return null;
+      })()
+    };
+  }
 
-        case 'RegExpLiteral':
-          return this.mapRegExpLiteral(node);
+  mapBigIntLiteral(node) {
+    const newNode = this.mapSimpleLiteral(node);
+    const bigint = node.bigint // estree spec is to not have a trailing `n` on this property
+    // https://github.com/estree/estree/blob/db962bb417a97effcfe9892f87fbb93c81a68584/es2020.md#bigintliteral
+    .replace(/n$/, '') // `BigInt` doesn't accept numeric separator and `bigint` property should not include numeric separator
+    .replace(/_/, '');
+    return { ...newNode,
+      // coerce the string to a bigint value if supported by the environment
+      value: typeof BigInt === 'function' ? BigInt(bigint) : null,
+      bigint
+    };
+  }
 
-        case 'Empty':
-          return this.mapEmpty(node);
+  mapNullLiteral(node) {
+    return { ...this.mapSimpleLiteral(node),
+      value: null
+    };
+  }
 
-        case 'TemplateElement':
-          return this.mapTemplateElement(node);
+  mapRegExpLiteral(node) {
+    const {
+      pattern,
+      flags
+    } = node; // Create RegExp value if possible. This can fail when the flags are invalid.
 
-        case 'GenericTypeAnnotation':
-          return this.mapGenericTypeAnnotation(node);
+    let value;
 
-        case 'ImportDeclaration':
-          return this.mapImportDeclaration(node);
+    try {
+      value = new RegExp(pattern, flags);
+    } catch (e) {
+      value = null;
+    }
 
-        case 'ImportSpecifier':
-          return this.mapImportSpecifier(node);
+    return { ...this.mapSimpleLiteral(node),
+      value,
+      regex: {
+        pattern,
+        flags
+      }
+    };
+  }
 
-        case 'ExportDefaultDeclaration':
-          return this.mapExportDefaultDeclaration(node);
+  mapBigIntLiteralTypeAnnotation(node) {
+    node.value = null;
+    return node;
+  }
 
-        case 'ExportNamedDeclaration':
-          return this.mapExportNamedDeclaration(node);
+  mapTemplateElement(node) {
+    return {
+      type: 'TemplateElement',
+      loc: node.loc,
+      range: node.range,
+      tail: node.tail,
+      value: {
+        cooked: node.cooked,
+        raw: node.raw
+      }
+    };
+  }
 
-        case 'ExportAllDeclaration':
-          return this.mapExportAllDeclaration(node);
+  mapGenericTypeAnnotation(node) {
+    // Convert simple `this` generic type to ThisTypeAnnotation
+    if (node.typeParameters == null && node.id.type === 'Identifier' && node.id.name === 'this') {
+      return {
+        type: 'ThisTypeAnnotation',
+        loc: node.loc,
+        range: node.range
+      };
+    }
 
-        case 'PrivateName':
-        case 'ClassPrivateProperty':
-          return this.mapPrivateProperty(node);
+    return this.mapNodeDefault(node);
+  }
 
-        default:
-          return this.mapNodeDefault(node);
-      }
-    }
-  }, {
-    key: "mapProgram",
-    value: function mapProgram(node) {
-      node = this.mapNodeDefault(node);
-      node.sourceType = this.getSourceType();
-      return node;
+  mapProperty(nodeUnprocessed) {
+    const node = this.mapNodeDefault(nodeUnprocessed);
+
+    if (node.value.type === 'FunctionExpression') {
+      node.value.loc.start = node.key.loc.end;
+      node.value.range[0] = node.key.range[1];
     }
-  }, {
-    key: "mapSimpleLiteral",
-    value: function mapSimpleLiteral(node) {
-      node.type = 'Literal';
-      node.raw = this.code.slice(node.range[0], node.range[1]);
-      return node;
+
+    return node;
+  }
+
+  mapComment(node) {
+    if (node.type === 'CommentBlock') {
+      node.type = 'Block';
+    } else if (node.type === 'CommentLine') {
+      node.type = 'Line';
     }
-  }, {
-    key: "mapNullLiteral",
-    value: function mapNullLiteral(node) {
-      node.type = 'Literal';
-      node.value = null;
-      node.raw = this.code.slice(node.range[0], node.range[1]);
-      return node;
+
+    return node;
+  }
+
+  mapFunction(nodeUnprocessed) {
+    const node = this.mapNodeDefault(nodeUnprocessed);
+
+    switch (node.type) {
+      case 'FunctionDeclaration':
+      case 'FunctionExpression':
+        node.expression = false;
+        return node;
+
+      case 'ArrowFunctionExpression':
+        node.expression = node.body.type !== 'BlockStatement';
+        return node;
     }
-  }, {
-    key: "mapRegExpLiteral",
-    value: function mapRegExpLiteral(node) {
-      var pattern = node.pattern,
-          flags = node.flags; // Create RegExp value if possible. This can fail when the flags are invalid.
-
-      var value;
-
-      try {
-        value = new RegExp(pattern, flags);
-      } catch (e) {
-        value = null;
+
+    return node;
+  }
+
+  mapChainExpression(nodeUnprocessed) {
+    /*
+    NOTE - In the below comments `MemberExpression` and `CallExpression`
+           are completely interchangable. For terseness we just reference
+           one each time.
+    */
+
+    /*
+    Hermes uses the old babel-style AST:
+    ```
+    (one?.two).three?.four;
+    ^^^^^^^^^^^^^^^^^^^^^^ OptionalMemberExpression
+    ^^^^^^^^^^^^^^^^ MemberExpression
+     ^^^^^^^^ OptionalMemberExpression
+    ```
+     We need to convert it to the ESTree representation:
+    ```
+    (one?.two).three?.four;
+    ^^^^^^^^^^^^^^^^^^^^^^ ChainExpression
+    ^^^^^^^^^^^^^^^^^^^^^^ MemberExpression[optional = true]
+    ^^^^^^^^^^^^^^^^ MemberExpression[optional = false]
+     ^^^^^^^^ ChainExpression
+     ^^^^^^^^ MemberExpression[optional = true]
+    ```
+     We do this by converting the AST and its children (depth first), and then unwrapping
+    the resulting AST as appropriate.
+     Put another way:
+    1) traverse to the leaf
+    2) if the current node is an `OptionalMemberExpression`:
+      a) if the `.object` is a `ChainExpression`:
+        i)   unwrap the child (`node.object = child.expression`)
+      b) convert this node to a `MemberExpression[optional = true]`
+      c) wrap this node (`node = ChainExpression[expression = node]`)
+    3) if the current node is a `MembedExpression`:
+      a) convert this node to a `MemberExpression[optional = true]`
+    */
+    const node = this.mapNodeDefault(nodeUnprocessed);
+
+    const {
+      child,
+      childKey,
+      isOptional
+    } = (() => {
+      const isOptional = node.optional === true;
+
+      if (node.type.endsWith('MemberExpression')) {
+        return {
+          child: node.object,
+          childKey: 'object',
+          isOptional
+        };
+      } else if (node.type.endsWith('CallExpression')) {
+        return {
+          child: node.callee,
+          childKey: 'callee',
+          isOptional
+        };
+      } else {
+        return {
+          child: node.expression,
+          childKey: 'expression',
+          isOptional: false
+        };
       }
+    })();
+
+    const isChildUnwrappable = child.type === 'ChainExpression' && // (x?.y).z is semantically different to `x?.y.z`.
+    // In the un-parenthesised case `.z` is only executed if and only if `x?.y` returns a non-nullish value.
+    // In the parenthesised case, `.z` is **always** executed, regardless of the return of `x?.y`.
+    // As such the AST is different between the two cases.
+    //
+    // In the hermes AST - any member part of a non-short-circuited optional chain is represented with `OptionalMemberExpression`
+    // so if we see a `MemberExpression`, then we know we've hit a parenthesis boundary.
+    node.type !== 'MemberExpression' && node.type !== 'CallExpression';
+
+    if (node.type.startsWith('Optional')) {
+      node.type = node.type.replace('Optional', '');
+      node.optional = isOptional;
+    } else {
+      node.optional = false;
+    }
 
-      return {
-        type: 'Literal',
-        loc: node.loc,
-        range: node.range,
-        value: value,
-        raw: this.code.slice(node.range[0], node.range[1]),
-        regex: {
-          pattern: pattern,
-          flags: flags
-        }
-      };
+    if (!isChildUnwrappable && !isOptional) {
+      return node;
     }
-  }, {
-    key: "mapTemplateElement",
-    value: function mapTemplateElement(node) {
-      return {
-        type: 'TemplateElement',
-        loc: node.loc,
-        range: node.range,
-        tail: node.tail,
-        value: {
-          cooked: node.cooked,
-          raw: node.raw
-        }
-      };
+
+    if (isChildUnwrappable) {
+      const newChild = child.expression;
+      node[childKey] = newChild;
     }
-  }, {
-    key: "mapGenericTypeAnnotation",
-    value: function mapGenericTypeAnnotation(node) {
-      // Convert simple `this` generic type to ThisTypeAnnotation
-      if (node.typeParameters === null && node.id.type === 'Identifier' && node.id.name === 'this') {
+
+    return {
+      type: 'ChainExpression',
+      expression: node,
+      loc: node.loc,
+      range: node.range
+    };
+  }
+
+  mapClassProperty(nodeUnprocessed) {
+    const node = this.mapNodeDefault(nodeUnprocessed);
+
+    const key = (() => {
+      if (node.type === 'ClassPrivateProperty') {
+        const key = this.mapNodeDefault(node.key);
         return {
-          type: 'ThisTypeAnnotation',
-          loc: node.loc,
-          range: node.range
+          type: 'PrivateIdentifier',
+          name: key.name,
+          range: key.range,
+          loc: key.loc
         };
       }
 
-      return this.mapNodeDefault(node);
-    }
-  }, {
-    key: "mapComment",
-    value: function mapComment(node) {
-      if (node.type === 'CommentBlock') {
-        node.type = 'Block';
-      } else if (node.type === 'CommentLine') {
-        node.type = 'Line';
+      return node.key;
+    })();
+
+    return { ...node,
+      computed: node.type === 'ClassPrivateProperty' ? false : node.computed,
+      key,
+      type: 'PropertyDefinition'
+    };
+  }
+
+  mapPrivateName(node) {
+    return {
+      type: 'PrivateIdentifier',
+      name: node.id.name,
+      // estree the location refers to the entire string including the hash token
+      range: node.range,
+      loc: node.loc
+    };
+  }
+
+  mapExportNamedDeclaration(nodeUnprocessed) {
+    const node = super.mapExportNamedDeclaration(nodeUnprocessed);
+    const namespaceSpecifier = node.specifiers.find(spec => spec.type === 'ExportNamespaceSpecifier');
+
+    if (namespaceSpecifier != null) {
+      var _node$exportKind;
+
+      if (node.specifiers.length !== 1) {
+        // this should already a hermes parser error - but let's be absolutely sure we're aligned with the spec
+        throw new Error('Cannot use an export all with any other specifiers');
       }
 
-      return node;
+      return {
+        type: 'ExportAllDeclaration',
+        source: node.source,
+        exportKind: (_node$exportKind = node.exportKind) != null ? _node$exportKind : 'value',
+        exported: namespaceSpecifier.exported,
+        range: node.range,
+        loc: node.loc
+      };
     }
-  }]);
 
-  return HermesToESTreeAdapter;
-}(_HermesASTAdapter2["default"]);
+    return node;
+  }
+
+  mapExportAllDeclaration(nodeUnprocessed) {
+    var _node$exported;
+
+    const node = super.mapExportAllDeclaration(nodeUnprocessed);
+    node.exported = (_node$exported = node.exported) != null ? _node$exported : null;
+    return node;
+  }
+
+}
 
-exports["default"] = HermesToESTreeAdapter;
+exports.default = HermesToESTreeAdapter;