hermes-parser 0.4.6 → 0.6.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Facebook, Inc. and its affiliates.
+Copyright (c) Meta Platforms, Inc. and affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/HermesAST.js.flow

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ *
+ * @flow strict
+ * @format
+ */
+
+// flowlint unclear-type:off
+
+export interface HermesPosition {
+  /** >= 1 */
+  +line: number;
+  /** >= 0 */
+  +column: number;
+}
+export type HermesSourceLocation = {
+  start?: HermesPosition,
+  end?: HermesPosition,
+  rangeStart?: number,
+  rangeEnd?: number,
+};
+export type HermesNode = {
+  type: string,
+  [string]: any,
+};
+export type HermesToken = {
+  type:
+    | 'Boolean'
+    | 'Identifier'
+    | 'Keyword'
+    | 'Null'
+    | 'Numeric'
+    | 'BigInt'
+    | 'Punctuator'
+    | 'String'
+    | 'RegularExpression'
+    | 'Template'
+    | 'JSXText',
+  loc: HermesSourceLocation,
+  value: ?string,
+};
+export type HermesComment = {
+  type: 'CommentLine' | 'CommentBlock' | 'InterpreterDirective',
+  loc: HermesSourceLocation,
+  value: ?string,
+};
+export type HermesProgram = {
+  type: 'Program',
+  loc: HermesSourceLocation,
+  body: Array<?HermesNode>,
+  comments: Array<HermesComment>,
+  tokens?: Array<HermesToken>,
+  interpreter?: ?HermesComment,
+};

package/dist/HermesASTAdapter.js

@@ -1,33 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _visitorKeys = require("./generated/visitor-keys");
+
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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
  */
-'use strict';
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+/*
+This class does some very "javascripty" things in the name of
+performance which are ultimately impossible to soundly type.
 
-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); } }
+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.
+*/
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
-
-var _require = require('./HermesParserVisitorKeys'),
-    HERMES_AST_VISITOR_KEYS = _require.HERMES_AST_VISITOR_KEYS,
-    NODE_CHILD = _require.NODE_CHILD,
-    NODE_LIST_CHILD = _require.NODE_LIST_CHILD;
 /**
  * The base class for transforming the Hermes AST to the desired output format.
  * Extended by concrete adapters which output an ESTree or Babel AST.
  */
-
-
-var HermesASTAdapter = /*#__PURE__*/function () {
-  function HermesASTAdapter(options, code) {
-    _classCallCheck(this, HermesASTAdapter);
-
+class HermesASTAdapter {
+  constructor(options) {
+    this.sourceFilename = void 0;
+    this.sourceType = void 0;
     this.sourceFilename = options.sourceFilename;
     this.sourceType = options.sourceType;
   }
@@ -37,162 +43,144 @@ var HermesASTAdapter = /*#__PURE__*/function () {
    */
 
 
-  _createClass(HermesASTAdapter, [{
-    key: "transform",
-    value: function transform(program) {
-      // Comments are not traversed via visitor keys
-      var comments = program.comments;
+  transform(program) {
+    // Comments are not traversed via visitor keys
+    const comments = program.comments;
 
-      for (var i = 0; i < comments.length; i++) {
-        var comment = comments[i];
-        this.fixSourceLocation(comment);
-        comments[i] = this.mapComment(comment);
-      } // The first comment may be an interpreter directive and is stored directly on the program node
+    for (let i = 0; i < comments.length; i++) {
+      const comment = comments[i];
+      this.fixSourceLocation(comment);
+      comments[i] = this.mapComment(comment);
+    } // The first comment may be an interpreter directive and is stored directly on the program node
 
 
-      program.interpreter = comments.length > 0 && comments[0].type === 'InterpreterDirective' ? comments.shift() : null; // Tokens are not traversed via visitor keys
+    program.interpreter = comments.length > 0 && comments[0].type === 'InterpreterDirective' ? comments.shift() : null; // Tokens are not traversed via visitor keys
 
-      var tokens = program.tokens;
+    const tokens = program.tokens;
 
-      if (tokens) {
-        for (var _i = 0; _i < tokens.length; _i++) {
-          this.fixSourceLocation(tokens[_i]);
-        }
+    if (tokens) {
+      for (let i = 0; i < tokens.length; i++) {
+        this.fixSourceLocation(tokens[i]);
       }
-
-      return this.mapNode(program);
     }
-    /**
-     * Transform a Hermes AST node to the output AST format.
-     *
-     * This may modify the input node in-place and return that same node, or a completely
-     * new node may be constructed and returned. Overriden in child classes.
-     */
-
-  }, {
-    key: "mapNode",
-    value: function mapNode(node) {
-      this.fixSourceLocation(node);
-      return this.mapNodeDefault(node);
-    }
-  }, {
-    key: "mapNodeDefault",
-    value: function mapNodeDefault(node) {
-      var visitorKeys = HERMES_AST_VISITOR_KEYS[node.type];
 
-      for (var key in visitorKeys) {
-        var childType = visitorKeys[key];
+    return this.mapNode(program);
+  }
+  /**
+   * Transform a Hermes AST node to the output AST format.
+   *
+   * This may modify the input node in-place and return that same node, or a completely
+   * new node may be constructed and returned. Overriden in child classes.
+   */
 
-        if (childType === NODE_CHILD) {
-          var child = node[key];
 
-          if (child != null) {
-            node[key] = this.mapNode(child);
-          }
-        } else if (childType === NODE_LIST_CHILD) {
-          var children = node[key];
+  mapNode(_node) {
+    throw new Error('Implemented in subclasses');
+  }
 
-          for (var i = 0; i < children.length; i++) {
-            var _child = children[i];
+  mapNodeDefault(node) {
+    const visitorKeys = _visitorKeys.HERMES_AST_VISITOR_KEYS[node.type];
 
-            if (_child != null) {
-              children[i] = this.mapNode(_child);
-            }
-          }
+    for (const key in visitorKeys) {
+      const childType = visitorKeys[key];
+
+      if (childType === _visitorKeys.NODE_CHILD) {
+        const child = node[key];
+
+        if (child != null) {
+          node[key] = this.mapNode(child);
         }
-      }
+      } else if (childType === _visitorKeys.NODE_LIST_CHILD) {
+        const children = node[key];
 
-      return node;
-    }
-    /**
-     * Update the source location for this node depending on the output AST format.
-     * This can modify the input node in-place. Overriden in child classes.
-     */
-
-  }, {
-    key: "fixSourceLocation",
-    value: function fixSourceLocation(node) {
-      throw new Error('Implemented in subclasses');
-    }
-  }, {
-    key: "getSourceType",
-    value: function getSourceType() {
-      var _this$sourceType;
+        for (let i = 0; i < children.length; i++) {
+          const child = children[i];
 
-      return (_this$sourceType = this.sourceType) !== null && _this$sourceType !== void 0 ? _this$sourceType : 'script';
-    }
-  }, {
-    key: "setModuleSourceType",
-    value: function setModuleSourceType() {
-      if (this.sourceType == null) {
-        this.sourceType = 'module';
+          if (child != null) {
+            children[i] = this.mapNode(child);
+          }
+        }
       }
     }
-  }, {
-    key: "mapComment",
-    value: function mapComment(node) {
-      return node;
-    }
-  }, {
-    key: "mapEmpty",
-    value: function mapEmpty(node) {
-      return null;
-    }
-  }, {
-    key: "mapImportDeclaration",
-    value: function mapImportDeclaration(node) {
-      if (node.importKind === 'value') {
-        this.setModuleSourceType();
-      }
 
-      return this.mapNodeDefault(node);
-    }
-  }, {
-    key: "mapImportSpecifier",
-    value: function mapImportSpecifier(node) {
-      if (node.importKind === 'value') {
-        node.importKind = null;
-      }
+    return node;
+  }
+  /**
+   * Update the source location for this node depending on the output AST format.
+   * This can modify the input node in-place. Overriden in child classes.
+   */
+
+
+  fixSourceLocation(_node) {
+    throw new Error('Implemented in subclasses');
+  }
+
+  getSourceType() {
+    var _this$sourceType;
 
-      return this.mapNodeDefault(node);
+    return (_this$sourceType = this.sourceType) != null ? _this$sourceType : 'script';
+  }
+
+  setModuleSourceType() {
+    if (this.sourceType == null) {
+      this.sourceType = 'module';
     }
-  }, {
-    key: "mapExportDefaultDeclaration",
-    value: function mapExportDefaultDeclaration(node) {
+  }
+
+  mapComment(node) {
+    return node;
+  }
+
+  mapEmpty(_node) {
+    // $FlowExpectedError
+    return null;
+  }
+
+  mapImportDeclaration(node) {
+    if (node.importKind === 'value') {
       this.setModuleSourceType();
-      return this.mapNodeDefault(node);
     }
-  }, {
-    key: "mapExportNamedDeclaration",
-    value: function mapExportNamedDeclaration(node) {
-      if (node.exportKind === 'value') {
-        this.setModuleSourceType();
-      }
 
-      return this.mapNodeDefault(node);
-    }
-  }, {
-    key: "mapExportAllDeclaration",
-    value: function mapExportAllDeclaration(node) {
-      if (node.exportKind === 'value') {
-        this.setModuleSourceType();
-      }
+    return this.mapNodeDefault(node);
+  }
 
-      return this.mapNodeDefault(node);
+  mapImportSpecifier(node) {
+    if (node.importKind === 'value') {
+      node.importKind = null;
     }
-  }, {
-    key: "mapPrivateProperty",
-    value: function mapPrivateProperty(node) {
-      throw new SyntaxError(this.formatError(node, 'Private properties are not supported'));
+
+    return this.mapNodeDefault(node);
+  }
+
+  mapExportDefaultDeclaration(node) {
+    this.setModuleSourceType();
+    return this.mapNodeDefault(node);
+  }
+
+  mapExportNamedDeclaration(node) {
+    if (node.exportKind === 'value') {
+      this.setModuleSourceType();
     }
-  }, {
-    key: "formatError",
-    value: function formatError(node, message) {
-      return "".concat(message, " (").concat(node.loc.start.line, ":").concat(node.loc.start.column, ")");
+
+    return this.mapNodeDefault(node);
+  }
+
+  mapExportAllDeclaration(node) {
+    if (node.exportKind === 'value') {
+      this.setModuleSourceType();
     }
-  }]);
 
-  return HermesASTAdapter;
-}();
+    return this.mapNodeDefault(node);
+  }
+
+  mapPrivateProperty(node) {
+    throw new SyntaxError(this.formatError(node, 'Private properties are not supported'));
+  }
+
+  formatError(node, message) {
+    return `${message} (${node.loc.start.line}:${node.loc.start.column})`;
+  }
+
+}
 
-module.exports = HermesASTAdapter;
+exports.default = HermesASTAdapter;

package/dist/HermesASTAdapter.js.flow

@@ -0,0 +1,178 @@
+/**
+ * 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.
+ *
+ * @flow
+ * @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.
+*/
+
+import type {HermesNode} from './HermesAST';
+import type {ParserOptions} from './ParserOptions';
+
+import {
+  HERMES_AST_VISITOR_KEYS,
+  NODE_CHILD,
+  NODE_LIST_CHILD,
+} from './generated/visitor-keys';
+
+/**
+ * The base class for transforming the Hermes AST to the desired output format.
+ * Extended by concrete adapters which output an ESTree or Babel AST.
+ */
+export default class HermesASTAdapter {
+  sourceFilename: ParserOptions['sourceFilename'];
+  sourceType: ParserOptions['sourceType'];
+
+  constructor(options: ParserOptions) {
+    this.sourceFilename = options.sourceFilename;
+    this.sourceType = options.sourceType;
+  }
+
+  /**
+   * Transform the input Hermes AST to the desired output format.
+   * This modifies the input AST in place instead of constructing a new AST.
+   */
+  transform(program: HermesNode): ?HermesNode {
+    // Comments are not traversed via visitor keys
+    const comments = program.comments;
+    for (let i = 0; i < comments.length; i++) {
+      const comment = comments[i];
+      this.fixSourceLocation(comment);
+      comments[i] = this.mapComment(comment);
+    }
+
+    // The first comment may be an interpreter directive and is stored directly on the program node
+    program.interpreter =
+      comments.length > 0 && comments[0].type === 'InterpreterDirective'
+        ? comments.shift()
+        : null;
+
+    // Tokens are not traversed via visitor keys
+    const tokens = program.tokens;
+    if (tokens) {
+      for (let i = 0; i < tokens.length; i++) {
+        this.fixSourceLocation(tokens[i]);
+      }
+    }
+
+    return this.mapNode(program);
+  }
+
+  /**
+   * Transform a Hermes AST node to the output AST format.
+   *
+   * This may modify the input node in-place and return that same node, or a completely
+   * new node may be constructed and returned. Overriden in child classes.
+   */
+  mapNode(_node: HermesNode): HermesNode {
+    throw new Error('Implemented in subclasses');
+  }
+
+  mapNodeDefault(node: HermesNode): HermesNode {
+    const visitorKeys = HERMES_AST_VISITOR_KEYS[node.type];
+    for (const key in visitorKeys) {
+      const childType = visitorKeys[key];
+      if (childType === NODE_CHILD) {
+        const child = node[key];
+        if (child != null) {
+          node[key] = this.mapNode(child);
+        }
+      } else if (childType === NODE_LIST_CHILD) {
+        const children = node[key];
+        for (let i = 0; i < children.length; i++) {
+          const child = children[i];
+          if (child != null) {
+            children[i] = this.mapNode(child);
+          }
+        }
+      }
+    }
+
+    return node;
+  }
+
+  /**
+   * Update the source location for this node depending on the output AST format.
+   * This can modify the input node in-place. Overriden in child classes.
+   */
+  fixSourceLocation(_node: HermesNode): void {
+    throw new Error('Implemented in subclasses');
+  }
+
+  getSourceType(): ParserOptions['sourceType'] {
+    return this.sourceType ?? 'script';
+  }
+
+  setModuleSourceType(): void {
+    if (this.sourceType == null) {
+      this.sourceType = 'module';
+    }
+  }
+
+  mapComment(node: HermesNode): HermesNode {
+    return node;
+  }
+
+  mapEmpty(_node: HermesNode): HermesNode {
+    // $FlowExpectedError
+    return null;
+  }
+
+  mapImportDeclaration(node: HermesNode): HermesNode {
+    if (node.importKind === 'value') {
+      this.setModuleSourceType();
+    }
+
+    return this.mapNodeDefault(node);
+  }
+
+  mapImportSpecifier(node: HermesNode): HermesNode {
+    if (node.importKind === 'value') {
+      node.importKind = null;
+    }
+
+    return this.mapNodeDefault(node);
+  }
+
+  mapExportDefaultDeclaration(node: HermesNode): HermesNode {
+    this.setModuleSourceType();
+    return this.mapNodeDefault(node);
+  }
+
+  mapExportNamedDeclaration(node: HermesNode): HermesNode {
+    if (node.exportKind === 'value') {
+      this.setModuleSourceType();
+    }
+
+    return this.mapNodeDefault(node);
+  }
+
+  mapExportAllDeclaration(node: HermesNode): HermesNode {
+    if (node.exportKind === 'value') {
+      this.setModuleSourceType();
+    }
+
+    return this.mapNodeDefault(node);
+  }
+
+  mapPrivateProperty(node: HermesNode): HermesNode {
+    throw new SyntaxError(
+      this.formatError(node, 'Private properties are not supported'),
+    );
+  }
+
+  formatError(node: HermesNode, message: string): string {
+    return `${message} (${node.loc.start.line}:${node.loc.start.column})`;
+  }
+}

package/dist/HermesParser.js

@@ -1,36 +1,53 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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
  */
 'use strict';
 
-var HermesParserDeserializer = require('./HermesParserDeserializer');
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parse = parse;
 
-var HermesParserWASM = require('./HermesParserWASM');
+var _HermesParserDeserializer = _interopRequireDefault(require("./HermesParserDeserializer"));
+
+var _HermesParserWASM = _interopRequireDefault(require("./HermesParserWASM"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const hermesParse = _HermesParserWASM.default.cwrap('hermesParse', 'number', ['number', 'number', 'number', 'number', 'number']);
+
+const hermesParseResult_free = _HermesParserWASM.default.cwrap('hermesParseResult_free', 'void', ['number']);
+
+const hermesParseResult_getError = _HermesParserWASM.default.cwrap('hermesParseResult_getError', 'string', ['number']);
+
+const hermesParseResult_getErrorLine = _HermesParserWASM.default.cwrap('hermesParseResult_getErrorLine', 'number', ['number']);
+
+const hermesParseResult_getErrorColumn = _HermesParserWASM.default.cwrap('hermesParseResult_getErrorColumn', 'number', ['number']);
+
+const hermesParseResult_getProgramBuffer = _HermesParserWASM.default.cwrap('hermesParseResult_getProgramBuffer', 'number', ['number']);
+
+const hermesParseResult_getPositionBuffer = _HermesParserWASM.default.cwrap('hermesParseResult_getPositionBuffer', 'number', ['number']);
+
+const hermesParseResult_getPositionBufferSize = _HermesParserWASM.default.cwrap('hermesParseResult_getPositionBufferSize', 'number', ['number']); // Copy a string into the WASM heap and null-terminate
 
-var hermesParse = HermesParserWASM.cwrap('hermesParse', 'number', ['number', 'number', 'number', 'number', 'number']);
-var hermesParseResult_free = HermesParserWASM.cwrap('hermesParseResult_free', 'void', ['number']);
-var hermesParseResult_getError = HermesParserWASM.cwrap('hermesParseResult_getError', 'string', ['number']);
-var hermesParseResult_getErrorLine = HermesParserWASM.cwrap('hermesParseResult_getErrorLine', 'number', ['number']);
-var hermesParseResult_getErrorColumn = HermesParserWASM.cwrap('hermesParseResult_getErrorColumn', 'number', ['number']);
-var hermesParseResult_getProgramBuffer = HermesParserWASM.cwrap('hermesParseResult_getProgramBuffer', 'number', ['number']);
-var hermesParseResult_getPositionBuffer = HermesParserWASM.cwrap('hermesParseResult_getPositionBuffer', 'number', ['number']);
-var hermesParseResult_getPositionBufferSize = HermesParserWASM.cwrap('hermesParseResult_getPositionBufferSize', 'number', ['number']); // Copy a string into the WASM heap and null-terminate
 
 function copyToHeap(buffer, addr) {
-  HermesParserWASM.HEAP8.set(buffer, addr);
-  HermesParserWASM.HEAP8[addr + buffer.length] = 0;
+  _HermesParserWASM.default.HEAP8.set(buffer, addr);
+
+  _HermesParserWASM.default.HEAP8[addr + buffer.length] = 0;
 }
 
 function parse(source, options) {
   // Allocate space on heap for source text
-  var sourceBuffer = Buffer.from(source, 'utf8');
+  const sourceBuffer = Buffer.from(source, 'utf8');
 
-  var sourceAddr = HermesParserWASM._malloc(sourceBuffer.length + 1);
+  const sourceAddr = _HermesParserWASM.default._malloc(sourceBuffer.length + 1);
 
   if (!sourceAddr) {
     throw new Error('Parser out of memory');
@@ -39,14 +56,15 @@ function parse(source, options) {
   try {
     // Copy source text onto WASM heap
     copyToHeap(sourceBuffer, sourceAddr);
-    var parseResult = hermesParse(sourceAddr, sourceBuffer.length + 1, options.flow === 'detect', options.tokens, options.allowReturnOutsideFunction);
+    const parseResult = hermesParse(sourceAddr, sourceBuffer.length + 1, options.flow === 'detect', options.tokens, options.allowReturnOutsideFunction);
 
     try {
       // Extract and throw error from parse result if parsing failed
-      var err = hermesParseResult_getError(parseResult);
+      const err = hermesParseResult_getError(parseResult);
 
       if (err) {
-        var syntaxError = new SyntaxError(err);
+        const syntaxError = new SyntaxError(err); // $FlowExpectedError[prop-missing]
+
         syntaxError.loc = {
           line: hermesParseResult_getErrorLine(parseResult),
           column: hermesParseResult_getErrorColumn(parseResult)
@@ -54,16 +72,12 @@ function parse(source, options) {
         throw syntaxError;
       }
 
-      var deserializer = new HermesParserDeserializer(hermesParseResult_getProgramBuffer(parseResult), hermesParseResult_getPositionBuffer(parseResult), hermesParseResult_getPositionBufferSize(parseResult), HermesParserWASM, options);
+      const deserializer = new _HermesParserDeserializer.default(hermesParseResult_getProgramBuffer(parseResult), hermesParseResult_getPositionBuffer(parseResult), hermesParseResult_getPositionBufferSize(parseResult), _HermesParserWASM.default, options);
       return deserializer.deserialize();
     } finally {
       hermesParseResult_free(parseResult);
     }
   } finally {
-    HermesParserWASM._free(sourceAddr);
+    _HermesParserWASM.default._free(sourceAddr);
   }
-}
-
-module.exports = {
-  parse: parse
-};
+}