hermes-transform 0.8.0 → 0.10.0

package/ESLINT_LICENCE

@@ -0,0 +1,19 @@
+Copyright OpenJS Foundation and other contributors, <www.openjsf.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/PRETTIER_LICENCE

@@ -0,0 +1,7 @@
+Copyright © James Long and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/detachedNode.js

@@ -3,15 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.asDetachedNode = void 0;
 exports.deepCloneNode = deepCloneNode;
 exports.detachedProps = detachedProps;
+exports.getOriginalNode = getOriginalNode;
+exports.isDetachedNode = isDetachedNode;
 exports.setParentPointersInDirectChildren = setParentPointersInDirectChildren;
 exports.shallowCloneNode = shallowCloneNode;
 exports.updateAllParentPointers = updateAllParentPointers;
 
-var _getVisitorKeys = require("./getVisitorKeys");
-
-var _SimpleTraverser = require("./traverse/SimpleTraverser");
+var _hermesParser = require("hermes-parser");
 
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
@@ -22,41 +23,115 @@ var _SimpleTraverser = require("./traverse/SimpleTraverser");
  * 
  * @format
  */
-// used by the node type function codegen
-function detachedProps(parent, props) {
-  // $FlowExpectedError[incompatible-return]
-  return { ...props,
+const DETACHED_MARKER = Symbol.for('hermes-transform - Detached AST Node');
+const ORIGINAL_NODE = Symbol.for('hermes-transform - Original Node');
+
+function isDetachedNode(node) {
+  // $FlowExpectedError[invalid-in-lhs] flow doesn't support symbols as keys
+  return DETACHED_MARKER in node;
+}
+
+function getOriginalNode(node) {
+  // $FlowExpectedError[prop-missing]
+  return node[ORIGINAL_NODE];
+}
+
+const asDetachedNode = (node, {
+  useDeepClone
+} = {
+  useDeepClone: false
+}) => {
+  if (node == null) {
+    return null;
+  }
+
+  if (isDetachedNode(node)) {
+    return node;
+  }
+
+  return useDeepClone ? deepCloneNode(node, {}) : shallowCloneNode(node, {});
+}; // used by the node type function codegen
+
+
+exports.asDetachedNode = asDetachedNode;
+
+function detachedProps(parent, props, config = {}) {
+  // $FlowExpectedError[incompatible-type]
+  const detachedNode = { ...props,
+    ...((config == null ? void 0 : config.preserveLocation) !== true ? {
+      // if this is [0,0] AND the file has a docblock then prettier will insert newlines between
+      // certain detached nodes. Because of "intended" formatting behaviour (https://github.com/prettier/prettier/issues/12078)
+      // this can cause us to output weirdly formatted code that should have been collapsed.
+      //
+      // prettier works backwards from the position you give it to find newlines or non whitespace
+      // tokens and uses this to determine if newlines should be inserted between nodes.
+      // By placing the range at [1, 1] we can ensure a token is always found before a newline
+      // and therefore no newlines will be placed between nodes.
+      //
+      // NOTE: we will still run into the bug if there is weird code like a docblock with whitespace
+      //       characters before it. However we assume this isn't going to happen because any file
+      //       already formatted by prettier will have that whitespace removed.
+      // We considered a more complex solution involving traversing the AST and manually updating
+      // detached node ranges after mutations are applied - however this is a lot heavier and will
+      // probably never be needed.
+      range: [1, 1],
+      loc: {
+        start: {
+          line: 1,
+          column: 0
+        },
+        end: {
+          line: 1,
+          column: 0
+        }
+      }
+    } : {}),
     // if not provided, then we purposely don't set this here
     // and will rely on the tooling to update it as appropriate.
     // nothing should be reading from this before it's set anyway.
-    parent: parent,
-    range: [0, 0],
-    loc: {
-      start: {
-        line: 1,
-        column: 0
-      },
-      end: {
-        line: 1,
-        column: 0
-      }
-    }
-  };
+    parent: parent
+  }; // mark the node as detached
+
+  Object.defineProperty(detachedNode, DETACHED_MARKER, {
+    configurable: false,
+    enumerable: false,
+    value: true,
+    writable: false
+  });
+
+  if (config.originalNode) {
+    Object.defineProperty(detachedNode, ORIGINAL_NODE, {
+      configurable: false,
+      enumerable: false,
+      value: config.originalNode,
+      writable: false
+    });
+  }
+
+  return detachedNode;
 }
 /**
  * Shallowly clones the node, but not its children.
  */
 
 
-function shallowCloneNode(node, newProps = {}) {
-  return detachedProps(null, Object.assign({}, node, newProps));
+function shallowCloneNode(node, newProps, config = {}) {
+  var _config$preserveLocat, _config$originalNode;
+
+  return detachedProps(null, // $FlowFixMe[cannot-spread-interface]
+  { ...node,
+    ...newProps
+  }, {
+    preserveLocation: (_config$preserveLocat = config.preserveLocation) != null ? _config$preserveLocat : true,
+    originalNode: (_config$originalNode = config.originalNode) != null ? _config$originalNode : node
+  });
 }
 /**
  * Deeply clones node and its entire tree.
  */
 
 
-function deepCloneNode(node, newProps = {}) {
+function deepCloneNode(node, newProps) {
   const clone = Object.assign(JSON.parse(JSON.stringify(node, (key, value) => {
     // null out parent pointers
     if (key === 'parent') {
@@ -75,16 +150,7 @@ function deepCloneNode(node, newProps = {}) {
 
 
 function setParentPointersInDirectChildren(node) {
-  for (const key of (0, _getVisitorKeys.getVisitorKeys)(node)) {
-    if ((0, _getVisitorKeys.isNode)( // $FlowExpectedError[prop-missing]
-    node[key])) {
-      node[key].parent = node;
-    } else if (Array.isArray(node[key])) {
-      for (const child of node[key]) {
-        child.parent = node;
-      }
-    }
-  }
+  _hermesParser.astNodeMutationHelpers.setParentPointersInDirectChildren(node);
 }
 /**
  * Traverses the entire subtree to ensure the parent pointers are set correctly
@@ -92,13 +158,5 @@ function setParentPointersInDirectChildren(node) {
 
 
 function updateAllParentPointers(node) {
-  _SimpleTraverser.SimpleTraverser.traverse(node, {
-    enter(node, parent) {
-      // $FlowExpectedError[cannot-write]
-      node.parent = parent;
-    },
-
-    leave() {}
-
-  });
+  _hermesParser.astNodeMutationHelpers.updateAllParentPointers(node);
 }

package/dist/detachedNode.js.flow

@@ -10,35 +10,118 @@
 
 import type {BaseNode, ESNode} from 'hermes-estree';
 
-import {getVisitorKeys, isNode} from './getVisitorKeys';
-import {SimpleTraverser} from './traverse/SimpleTraverser';
+import {astNodeMutationHelpers} from 'hermes-parser';
 
 export opaque type DetachedNode<+T> = T;
+export type MaybeDetachedNode<+T> = T | DetachedNode<T>;
+
+type DetachConfig = $ReadOnly<{
+  preserveLocation?: boolean,
+  originalNode?: ESNode,
+}>;
+
+const DETACHED_MARKER = Symbol.for('hermes-transform - Detached AST Node');
+const ORIGINAL_NODE = Symbol.for('hermes-transform - Original Node');
+
+export function isDetachedNode(node: MaybeDetachedNode<ESNode>): boolean {
+  // $FlowExpectedError[invalid-in-lhs] flow doesn't support symbols as keys
+  return DETACHED_MARKER in node;
+}
+export function getOriginalNode(node: MaybeDetachedNode<ESNode>): ?ESNode {
+  // $FlowExpectedError[prop-missing]
+  return node[ORIGINAL_NODE];
+}
+
+export const asDetachedNode: {
+  <T: ESNode>(
+    node: MaybeDetachedNode<T>,
+    config?: {useDeepClone: boolean},
+  ): DetachedNode<T>,
+  <T: ?ESNode>(
+    node: ?MaybeDetachedNode<T>,
+    config?: {useDeepClone: boolean},
+  ): ?DetachedNode<T>,
+} = <T: ESNode>(
+  node: ?MaybeDetachedNode<T>,
+  {useDeepClone}: {useDeepClone: boolean} = {useDeepClone: false},
+): // $FlowExpectedError[incompatible-type]
+?DetachedNode<T> => {
+  if (node == null) {
+    return null;
+  }
+
+  if (isDetachedNode(node)) {
+    return node;
+  }
+
+  return useDeepClone
+    ? deepCloneNode<T>(node, {})
+    : shallowCloneNode<T>(node, {});
+};
 
 // used by the node type function codegen
 export function detachedProps<T: BaseNode>(
   parent: ?ESNode,
-  props: {...},
+  props: $ReadOnly<$Partial<{...}>>,
+  config: DetachConfig = {},
 ): DetachedNode<T> {
-  // $FlowExpectedError[incompatible-return]
-  return {
+  // $FlowExpectedError[incompatible-type]
+  const detachedNode: DetachedNode<T> = {
     ...props,
+    ...(config?.preserveLocation !== true
+      ? {
+          // if this is [0,0] AND the file has a docblock then prettier will insert newlines between
+          // certain detached nodes. Because of "intended" formatting behaviour (https://github.com/prettier/prettier/issues/12078)
+          // this can cause us to output weirdly formatted code that should have been collapsed.
+          //
+          // prettier works backwards from the position you give it to find newlines or non whitespace
+          // tokens and uses this to determine if newlines should be inserted between nodes.
+          // By placing the range at [1, 1] we can ensure a token is always found before a newline
+          // and therefore no newlines will be placed between nodes.
+          //
+          // NOTE: we will still run into the bug if there is weird code like a docblock with whitespace
+          //       characters before it. However we assume this isn't going to happen because any file
+          //       already formatted by prettier will have that whitespace removed.
+          // We considered a more complex solution involving traversing the AST and manually updating
+          // detached node ranges after mutations are applied - however this is a lot heavier and will
+          // probably never be needed.
+          range: [1, 1],
+          loc: {
+            start: {
+              line: 1,
+              column: 0,
+            },
+            end: {
+              line: 1,
+              column: 0,
+            },
+          },
+        }
+      : {}),
     // if not provided, then we purposely don't set this here
     // and will rely on the tooling to update it as appropriate.
     // nothing should be reading from this before it's set anyway.
     parent: (parent: $FlowFixMe),
-    range: [0, 0],
-    loc: {
-      start: {
-        line: 1,
-        column: 0,
-      },
-      end: {
-        line: 1,
-        column: 0,
-      },
-    },
   };
+
+  // mark the node as detached
+  Object.defineProperty(detachedNode, DETACHED_MARKER, {
+    configurable: false,
+    enumerable: false,
+    value: true,
+    writable: false,
+  });
+
+  if (config.originalNode) {
+    Object.defineProperty(detachedNode, ORIGINAL_NODE, {
+      configurable: false,
+      enumerable: false,
+      value: config.originalNode,
+      writable: false,
+    });
+  }
+
+  return detachedNode;
 }
 
 /**
@@ -46,9 +129,18 @@ export function detachedProps<T: BaseNode>(
  */
 export function shallowCloneNode<T: ESNode>(
   node: T,
-  newProps: $Partial<{...}> = {},
+  newProps: $ReadOnly<$Partial<{...}>>,
+  config?: DetachConfig = {},
 ): DetachedNode<T> {
-  return detachedProps(null, (Object.assign({}, node, newProps): $FlowFixMe));
+  return detachedProps(
+    null,
+    // $FlowFixMe[cannot-spread-interface]
+    {...node, ...newProps},
+    {
+      preserveLocation: config.preserveLocation ?? true,
+      originalNode: config.originalNode ?? node,
+    },
+  );
 }
 
 /**
@@ -56,7 +148,7 @@ export function shallowCloneNode<T: ESNode>(
  */
 export function deepCloneNode<T: ESNode>(
   node: T,
-  newProps: $Partial<{...}> = {},
+  newProps: $ReadOnly<$Partial<{...}>>,
 ): DetachedNode<T> {
   const clone: DetachedNode<T> = Object.assign(
     JSON.parse(
@@ -83,31 +175,14 @@ export function deepCloneNode<T: ESNode>(
 export function setParentPointersInDirectChildren(
   node: DetachedNode<ESNode>,
 ): void {
-  for (const key of getVisitorKeys(node)) {
-    if (
-      isNode(
-        // $FlowExpectedError[prop-missing]
-        node[key],
-      )
-    ) {
-      node[key].parent = node;
-    } else if (Array.isArray(node[key])) {
-      for (const child of node[key]) {
-        child.parent = node;
-      }
-    }
-  }
+  astNodeMutationHelpers.setParentPointersInDirectChildren(node);
 }
 
 /**
  * Traverses the entire subtree to ensure the parent pointers are set correctly
  */
-export function updateAllParentPointers(node: ESNode | DetachedNode<ESNode>) {
-  SimpleTraverser.traverse(node, {
-    enter(node, parent) {
-      // $FlowExpectedError[cannot-write]
-      node.parent = parent;
-    },
-    leave() {},
-  });
+export function updateAllParentPointers(
+  node: ESNode | DetachedNode<ESNode>,
+): void {
+  astNodeMutationHelpers.updateAllParentPointers(node);
 }

package/dist/generated/TransformCloneSignatures.js.flow

@@ -6,6 +6,13 @@
  *
  * @flow strict-local
  * @format
+ * @generated
+ */
+
+/*
+ * !!! GENERATED FILE !!!
+ *
+ * Any manual changes to this file will be overwritten. To regenerate run `yarn build`.
  */
 
 // lint directives to let us do some basic validation of generated files
@@ -25,6 +32,7 @@ import type {
   AwaitExpression,
   BigIntLiteral,
   BigIntLiteralTypeAnnotation,
+  BigIntTypeAnnotation,
   BinaryExpression,
   BlockStatement,
   BooleanLiteral,
@@ -183,6 +191,7 @@ import type {
   AwaitExpressionProps,
   BigIntLiteralProps,
   BigIntLiteralTypeAnnotationProps,
+  BigIntTypeAnnotationProps,
   BinaryExpressionProps,
   BlockStatementProps,
   BooleanLiteralProps,
@@ -412,6 +421,14 @@ type BigIntLiteralTypeAnnotationCloneSignature = ((
     node: ?BigIntLiteralTypeAnnotation,
     newProps: $Partial<BigIntLiteralTypeAnnotationProps>,
   ) => DetachedNode<BigIntLiteralTypeAnnotation> | null);
+type BigIntTypeAnnotationCloneSignature = ((
+  node: BigIntTypeAnnotation,
+  newProps: $Partial<BigIntTypeAnnotationProps>,
+) => DetachedNode<BigIntTypeAnnotation>) &
+  ((
+    node: ?BigIntTypeAnnotation,
+    newProps: $Partial<BigIntTypeAnnotationProps>,
+  ) => DetachedNode<BigIntTypeAnnotation> | null);
 type BinaryExpressionCloneSignature = ((
   node: BinaryExpression,
   newProps: $Partial<BinaryExpressionProps>,
@@ -1590,6 +1607,7 @@ export type TransformCloneSignatures = AnyTypeAnnotationCloneSignature &
   AwaitExpressionCloneSignature &
   BigIntLiteralCloneSignature &
   BigIntLiteralTypeAnnotationCloneSignature &
+  BigIntTypeAnnotationCloneSignature &
   BinaryExpressionCloneSignature &
   BlockStatementCloneSignature &
   BooleanLiteralCloneSignature &