hermes-transform 0.9.0 → 0.10.0

package/dist/transform/transform.js.flow

@@ -10,13 +10,12 @@
 
 'use strict';
 
-import type {ESNode} from 'hermes-estree';
 import type {Visitor} from '../traverse/traverse';
 import type {TransformContextAdditions} from './TransformContext';
 
-import * as prettier from 'prettier';
-import {getTransformedAST} from './getTransformedAST';
-import {SimpleTraverser} from '../traverse/SimpleTraverser';
+import {transformAST} from './transformAST';
+import {parse} from './parse';
+import {print} from './print';
 
 export type TransformVisitor = Visitor<TransformContextAdditions>;
 
@@ -25,74 +24,12 @@ export function transform(
   visitors: TransformVisitor,
   prettierOptions: {...} = {},
 ): string {
-  const {ast, astWasMutated, mutatedCode} = getTransformedAST(
-    originalCode,
-    visitors,
-  );
+  const parseResult = parse(originalCode);
 
+  const {ast, astWasMutated, mutatedCode} = transformAST(parseResult, visitors);
   if (!astWasMutated) {
     return originalCode;
   }
 
-  SimpleTraverser.traverse(ast, {
-    enter(node) {
-      // prettier fully expects the parent pointers are NOT set and
-      // certain cases can crash due to prettier infinite-looping
-      // whilst naively traversing the parent property
-      // https://github.com/prettier/prettier/issues/11793
-      // $FlowExpectedError[cannot-write]
-      delete node.parent;
-
-      // prettier currently relies on the AST being in the old-school, deprecated AST format for optional chaining
-      // so we have to apply their transform to our AST so it can actually format it.
-      if (node.type === 'ChainExpression') {
-        const newNode = transformChainExpression(node.expression);
-        // $FlowExpectedError[cannot-write]
-        delete node.expression;
-        // $FlowExpectedError[prop-missing]
-        // $FlowExpectedError[cannot-write]
-        Object.assign(node, newNode);
-      }
-    },
-    leave() {},
-  });
-
-  // we need to delete the comments prop or else prettier will do
-  // its own attachment pass after the mutation and duplicate the
-  // comments on each node, borking the output
-  // $FlowExpectedError[cannot-write]
-  delete ast.comments;
-
-  return prettier.format(
-    mutatedCode,
-    // $FlowExpectedError[incompatible-exact] - we don't want to create a dependency on the prettier types
-    {
-      ...prettierOptions,
-      parser() {
-        return ast;
-      },
-    },
-  );
-}
-
-// https://github.com/prettier/prettier/blob/d962466a828f8ef51435e3e8840178d90b7ec6cd/src/language-js/parse/postprocess/index.js#L161-L182
-function transformChainExpression(node: ESNode) {
-  switch (node.type) {
-    case 'CallExpression':
-      // $FlowExpectedError[cannot-write]
-      node.type = 'OptionalCallExpression';
-      // $FlowExpectedError[cannot-write]
-      node.callee = transformChainExpression(node.callee);
-      break;
-
-    case 'MemberExpression':
-      // $FlowExpectedError[cannot-write]
-      node.type = 'OptionalMemberExpression';
-      // $FlowExpectedError[cannot-write]
-      node.object = transformChainExpression(node.object);
-      break;
-    // No default
-  }
-
-  return node;
+  return print(ast, mutatedCode, prettierOptions);
 }

package/dist/transform/{getTransformedAST.js → transformAST.js}

@@ -12,9 +12,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getTransformedAST = getTransformedAST;
-
-var _hermesEslint = require("hermes-eslint");
+exports.transformAST = transformAST;
 
 var _detachedNode = require("../detachedNode");
 
@@ -24,8 +22,6 @@ var _MutationContext = require("./MutationContext");
 
 var _TransformContext = require("./TransformContext");
 
-var _comments = require("./comments/comments");
-
 var _AddComments = require("./mutations/AddComments");
 
 var _CloneCommentsTo = require("./mutations/CloneCommentsTo");
@@ -42,17 +38,12 @@ var _ReplaceNode = require("./mutations/ReplaceNode");
 
 var _ReplaceStatementWithMany = require("./mutations/ReplaceStatementWithMany");
 
-function getTransformedAST(code, visitors) {
-  const {
-    ast,
-    scopeManager
-  } = (0, _hermesEslint.parseForESLint)(code, {
-    sourceType: 'module'
-  }); // attach comments before mutation. this will ensure that as nodes are
-  // cloned / moved around - comments remain in the correct place with respect to the node
-
-  (0, _comments.attachComments)(ast.comments, ast, code); // traverse the AST and colllect the mutations
-
+function transformAST({
+  ast,
+  scopeManager,
+  code
+}, visitors) {
+  // traverse the AST and colllect the mutations
   const transformContext = (0, _TransformContext.getTransformContext)();
   (0, _traverse.traverseWithContext)(code, ast, scopeManager, () => transformContext, visitors); // apply the mutations to the AST
 
@@ -122,21 +113,6 @@ function getTransformedAST(code, visitors) {
     if (mutationRoot) {
       (0, _detachedNode.updateAllParentPointers)(mutationRoot);
     }
-  } // if the very first node in the program is replaced, it will take the docblock with it
-  // this is bad as it means we'll lose `@format`, ``, licence, etc.
-  // so this hack just makes sure that we keep the docblock
-  // note that we do this **BEFORE** the comment mutations in case someone intentionally
-  // wants to remove the docblock comment for some weird reason
-
-
-  if (ast.docblock != null && ast.body.length > 0) {
-    const firstNode = ast.body[0];
-    const docblockComment = ast.docblock.comment;
-    const leadingComments = (0, _comments.getLeadingCommentsForNode)(firstNode);
-
-    if (!leadingComments.includes(docblockComment)) {
-      (0, _comments.addCommentsToNode)(firstNode, [docblockComment], 'leading');
-    }
   } // remove the comments
   // this is done at the end because it requires a complete traversal of the AST
   // so that we can find relevant node's attachment array

package/dist/transform/{getTransformedAST.js.flow → transformAST.js.flow}

@@ -13,17 +13,12 @@
 import type {ESNode, Program} from 'hermes-estree';
 import type {TransformVisitor} from './transform';
 import type {RemoveCommentMutation} from './mutations/RemoveComment';
+import type {ParseResult} from './parse';
 
-import {parseForESLint} from 'hermes-eslint';
 import {updateAllParentPointers} from '../detachedNode';
 import {traverseWithContext} from '../traverse/traverse';
 import {MutationContext} from './MutationContext';
 import {getTransformContext} from './TransformContext';
-import {
-  addCommentsToNode,
-  attachComments,
-  getLeadingCommentsForNode,
-} from './comments/comments';
 import {performAddCommentsMutation} from './mutations/AddComments';
 import {performCloneCommentsToMutation} from './mutations/CloneCommentsTo';
 import {performInsertStatementMutation} from './mutations/InsertStatement';
@@ -33,22 +28,16 @@ import {performRemoveStatementMutation} from './mutations/RemoveStatement';
 import {performReplaceNodeMutation} from './mutations/ReplaceNode';
 import {performReplaceStatementWithManyMutation} from './mutations/ReplaceStatementWithMany';
 
-export function getTransformedAST(
-  code: string,
-  visitors: TransformVisitor,
-): {
+export type TransformASTResult = {
   ast: Program,
   astWasMutated: boolean,
   mutatedCode: string,
-} {
-  const {ast, scopeManager} = parseForESLint(code, {
-    sourceType: 'module',
-  });
-
-  // attach comments before mutation. this will ensure that as nodes are
-  // cloned / moved around - comments remain in the correct place with respect to the node
-  attachComments(ast.comments, ast, code);
+};
 
+export function transformAST(
+  {ast, scopeManager, code}: ParseResult,
+  visitors: TransformVisitor,
+): TransformASTResult {
   // traverse the AST and colllect the mutations
   const transformContext = getTransformContext();
   traverseWithContext(
@@ -124,20 +113,6 @@ export function getTransformedAST(
     }
   }
 
-  // if the very first node in the program is replaced, it will take the docblock with it
-  // this is bad as it means we'll lose `@format`, `@flow`, licence, etc.
-  // so this hack just makes sure that we keep the docblock
-  // note that we do this **BEFORE** the comment mutations in case someone intentionally
-  // wants to remove the docblock comment for some weird reason
-  if (ast.docblock != null && ast.body.length > 0) {
-    const firstNode = ast.body[0];
-    const docblockComment = ast.docblock.comment;
-    const leadingComments = getLeadingCommentsForNode(firstNode);
-    if (!leadingComments.includes(docblockComment)) {
-      addCommentsToNode(firstNode, [docblockComment], 'leading');
-    }
-  }
-
   // remove the comments
   // this is done at the end because it requires a complete traversal of the AST
   // so that we can find relevant node's attachment array

package/dist/traverse/traverse.js

@@ -12,7 +12,7 @@ var _NodeEventGenerator = require("./NodeEventGenerator");
 
 var _SafeEmitter = require("./SafeEmitter");
 
-var _SimpleTraverser = require("./SimpleTraverser");
+var _hermesParser = require("hermes-parser");
 
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
@@ -32,27 +32,9 @@ var _SimpleTraverser = require("./SimpleTraverser");
  */
 function traverseWithContext(code, ast, scopeManager, additionalContext, visitor) {
   const emitter = new _SafeEmitter.SafeEmitter();
-  const nodeQueue = [];
-  let currentNode = ast; // set parent pointers and build up the traversal queue
-
-  _SimpleTraverser.SimpleTraverser.traverse(ast, {
-    enter(node, parent) {
-      // $FlowExpectedError[cannot-write] - hermes doesn't set this
-      node.parent = parent;
-      nodeQueue.push({
-        isEntering: true,
-        node
-      });
-    },
-
-    leave(node) {
-      nodeQueue.push({
-        isEntering: false,
-        node
-      });
-    }
-
-  });
+  let currentNode = ast;
+  let shouldSkipTraversal = false;
+  let shouldStopTraversal = false;
 
   const getScope = (givenNode = currentNode) => {
     // On Program node, get the outermost scope to avoid return Node.js special function scope or ES modules scope.
@@ -112,7 +94,13 @@ function traverseWithContext(code, ast, scopeManager, additionalContext, visitor
 
       return null;
     },
-    getScope
+    getScope,
+    stopTraversal: () => {
+      shouldStopTraversal = true;
+    },
+    skipTraversal: () => {
+      shouldSkipTraversal = true;
+    }
   });
   const traversalContext = Object.freeze({ ...traversalContextBase,
     ...additionalContext(traversalContextBase)
@@ -130,19 +118,32 @@ function traverseWithContext(code, ast, scopeManager, additionalContext, visitor
     }
   });
   const eventGenerator = new _NodeEventGenerator.NodeEventGenerator(emitter);
-  nodeQueue.forEach(traversalInfo => {
-    currentNode = traversalInfo.node;
-
-    try {
-      if (traversalInfo.isEntering) {
-        eventGenerator.enterNode(currentNode);
-      } else {
-        eventGenerator.leaveNode(currentNode);
-      }
-    } catch (err) {
-      err.currentNode = currentNode;
-      throw err;
+
+  function checkTraversalFlags() {
+    if (shouldStopTraversal) {
+      // No need to reset the flag since we won't enter any more nodes.
+      throw _hermesParser.SimpleTraverser.Break;
+    }
+
+    if (shouldSkipTraversal) {
+      shouldSkipTraversal = false;
+      throw _hermesParser.SimpleTraverser.Skip;
+    }
+  }
+
+  _hermesParser.SimpleTraverser.traverse(ast, {
+    enter(node) {
+      currentNode = node;
+      eventGenerator.enterNode(node);
+      checkTraversalFlags();
+    },
+
+    leave(node) {
+      currentNode = node;
+      eventGenerator.leaveNode(node);
+      checkTraversalFlags();
     }
+
   });
 }
 

package/dist/traverse/traverse.js.flow

@@ -15,7 +15,7 @@ import type {EmitterListener} from './SafeEmitter';
 import {codeFrameColumns} from '@babel/code-frame';
 import {NodeEventGenerator} from './NodeEventGenerator';
 import {SafeEmitter} from './SafeEmitter';
-import {SimpleTraverser} from './SimpleTraverser';
+import {SimpleTraverser} from 'hermes-parser';
 
 export type TraversalContextBase = $ReadOnly<{
   /**
@@ -55,6 +55,17 @@ export type TraversalContextBase = $ReadOnly<{
    * (where 56:44 represents L56, Col44)
    */
   buildSimpleCodeFrame: (node: ESNode, message: string) => string,
+  /**
+   * Can be called at any point during the traversal to immediately stop traversal
+   * entirely.
+   */
+  stopTraversal: () => void,
+  /**
+   * Can be called within the traversal "enter" function to prevent the traverser
+   * from traversing the node any further, essentially culling the remainder of the
+   * AST branch from traversal.
+   */
+  skipTraversal: () => void,
 }>;
 export type TraversalContext<T> = $ReadOnly<{
   ...TraversalContextBase,
@@ -77,21 +88,10 @@ export function traverseWithContext<T = TraversalContextBase>(
   visitor: Visitor<T>,
 ): void {
   const emitter = new SafeEmitter();
-  const nodeQueue: Array<{isEntering: boolean, node: ESNode}> = [];
 
   let currentNode: ESNode = ast;
-
-  // set parent pointers and build up the traversal queue
-  SimpleTraverser.traverse(ast, {
-    enter(node, parent) {
-      // $FlowExpectedError[cannot-write] - hermes doesn't set this
-      node.parent = parent;
-      nodeQueue.push({isEntering: true, node});
-    },
-    leave(node) {
-      nodeQueue.push({isEntering: false, node});
-    },
-  });
+  let shouldSkipTraversal = false;
+  let shouldStopTraversal = false;
 
   const getScope = (givenNode: ESNode = currentNode) => {
     // On Program node, get the outermost scope to avoid return Node.js special function scope or ES modules scope.
@@ -155,6 +155,14 @@ export function traverseWithContext<T = TraversalContextBase>(
     },
 
     getScope,
+
+    stopTraversal: () => {
+      shouldStopTraversal = true;
+    },
+
+    skipTraversal: () => {
+      shouldSkipTraversal = true;
+    },
   });
 
   const traversalContext: TraversalContext<T> = Object.freeze({
@@ -176,19 +184,30 @@ export function traverseWithContext<T = TraversalContextBase>(
   });
 
   const eventGenerator = new NodeEventGenerator(emitter);
-  nodeQueue.forEach(traversalInfo => {
-    currentNode = traversalInfo.node;
-
-    try {
-      if (traversalInfo.isEntering) {
-        eventGenerator.enterNode(currentNode);
-      } else {
-        eventGenerator.leaveNode(currentNode);
-      }
-    } catch (err) {
-      err.currentNode = currentNode;
-      throw err;
+
+  function checkTraversalFlags(): void {
+    if (shouldStopTraversal) {
+      // No need to reset the flag since we won't enter any more nodes.
+      throw SimpleTraverser.Break;
+    }
+
+    if (shouldSkipTraversal) {
+      shouldSkipTraversal = false;
+      throw SimpleTraverser.Skip;
     }
+  }
+
+  SimpleTraverser.traverse(ast, {
+    enter(node) {
+      currentNode = node;
+      eventGenerator.enterNode(node);
+      checkTraversalFlags();
+    },
+    leave(node) {
+      currentNode = node;
+      eventGenerator.leaveNode(node);
+      checkTraversalFlags();
+    },
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hermes-transform",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Tools built on top of Hermes-ESTree to enable codebase transformation",
   "main": "dist/index.js",
   "license": "MIT",
@@ -12,11 +12,12 @@
     "@babel/code-frame": "^7.16.0",
     "esquery": "^1.4.0",
     "flow-enums-runtime": "^0.0.6",
-    "hermes-eslint": "0.9.0",
-    "hermes-estree": "0.9.0"
+    "hermes-eslint": "0.10.0",
+    "hermes-estree": "0.10.0",
+    "hermes-parser": "0.10.0"
   },
   "peerDependencies": {
-    "prettier": "^2.4.1"
+    "prettier": "^2.7.1"
   },
   "files": [
     "dist",

package/dist/getVisitorKeys.js

@@ -1,33 +0,0 @@
-/**
- * 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';
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getVisitorKeys = getVisitorKeys;
-exports.isNode = isNode;
-
-var _hermesEslint = require("hermes-eslint");
-
-function isNode(thing) {
-  return typeof thing === 'object' && thing != null && typeof thing.type === 'string';
-}
-
-function getVisitorKeys(node) {
-  const keys = _hermesEslint.VisitorKeys[node.type];
-
-  if (keys == null) {
-    throw new Error(`No visitor keys found for node type "${node.type}".`);
-  } // $FlowExpectedError[prop-missing]
-
-
-  return keys;
-}

package/dist/getVisitorKeys.js.flow

@@ -1,31 +0,0 @@
-/**
- * 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-local
- * @format
- */
-
-'use strict';
-
-import type {ESNode} from 'hermes-estree';
-
-import {VisitorKeys} from 'hermes-eslint';
-
-export function isNode(thing: mixed): boolean %checks {
-  return (
-    typeof thing === 'object' && thing != null && typeof thing.type === 'string'
-  );
-}
-
-export function getVisitorKeys<T: ESNode>(node: T): $ReadOnlyArray<$Keys<T>> {
-  const keys = VisitorKeys[node.type];
-  if (keys == null) {
-    throw new Error(`No visitor keys found for node type "${node.type}".`);
-  }
-
-  // $FlowExpectedError[prop-missing]
-  return keys;
-}

package/dist/transform/mutations/utils/arrayUtils.js

@@ -1,43 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.insertInArray = insertInArray;
-exports.removeFromArray = removeFromArray;
-exports.replaceInArray = replaceInArray;
-
-/**
- * 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
- */
-function assertArrayBounds(array, index) {
-  if (index < 0 || index >= array.length) {
-    throw new Error(`Invalid Mutation: Tried to mutate an elements array with an out of bounds index. Index: ${index}, Array Size: ${array.length}`);
-  }
-}
-
-function insertInArray(array, index, elements) {
-  if (index === array.length) {
-    // Support the insert at end of array case.
-    return array.concat(elements);
-  }
-
-  assertArrayBounds(array, index);
-  return array.slice(0, index).concat(elements).concat(array.slice(index));
-}
-
-function removeFromArray(array, index) {
-  assertArrayBounds(array, index);
-  return [...array.slice(0, index), ...array.slice(index + 1)];
-}
-
-function replaceInArray(array, index, elements) {
-  assertArrayBounds(array, index);
-  return array.slice(0, index).concat(elements).concat(array.slice(index + 1));
-}

package/dist/transform/mutations/utils/arrayUtils.js.flow

@@ -1,50 +0,0 @@
-/**
- * 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-local
- * @format
- */
-
-function assertArrayBounds<T>(array: $ReadOnlyArray<T>, index: number): void {
-  if (index < 0 || index >= array.length) {
-    throw new Error(
-      `Invalid Mutation: Tried to mutate an elements array with an out of bounds index. Index: ${index}, Array Size: ${array.length}`,
-    );
-  }
-}
-
-export function insertInArray<T>(
-  array: $ReadOnlyArray<T>,
-  index: number,
-  elements: $ReadOnlyArray<T>,
-): Array<T> {
-  if (index === array.length) {
-    // Support the insert at end of array case.
-    return array.concat(elements);
-  }
-  assertArrayBounds(array, index);
-  return array.slice(0, index).concat(elements).concat(array.slice(index));
-}
-
-export function removeFromArray<T>(
-  array: $ReadOnlyArray<T>,
-  index: number,
-): Array<T> {
-  assertArrayBounds(array, index);
-  return [...array.slice(0, index), ...array.slice(index + 1)];
-}
-
-export function replaceInArray<T>(
-  array: $ReadOnlyArray<T>,
-  index: number,
-  elements: $ReadOnlyArray<T>,
-): Array<T> {
-  assertArrayBounds(array, index);
-  return array
-    .slice(0, index)
-    .concat(elements)
-    .concat(array.slice(index + 1));
-}