@swagger-api/apidom-ast 1.0.0-alpha.1 → 1.0.0-alpha.10

package/CHANGELOG.md

@@ -3,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-alpha.10](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.9...v1.0.0-alpha.10) (2024-10-21)
+
+**Note:** Version bump only for package @swagger-api/apidom-ast
+
+# [1.0.0-alpha.9](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.8...v1.0.0-alpha.9) (2024-08-14)
+
+**Note:** Version bump only for package @swagger-api/apidom-ast
+
+# [1.0.0-alpha.8](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.7...v1.0.0-alpha.8) (2024-08-08)
+
+**Note:** Version bump only for package @swagger-api/apidom-ast
+
+# [1.0.0-alpha.7](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.6...v1.0.0-alpha.7) (2024-08-05)
+
+**Note:** Version bump only for package @swagger-api/apidom-ast
+
+# [1.0.0-alpha.6](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.5...v1.0.0-alpha.6) (2024-07-09)
+
+**Note:** Version bump only for package @swagger-api/apidom-ast
+
+# [1.0.0-alpha.5](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.4...v1.0.0-alpha.5) (2024-05-29)
+
+**Note:** Version bump only for package @swagger-api/apidom-ast
+
+# [1.0.0-alpha.3](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.2...v1.0.0-alpha.3) (2024-05-21)
+
+### Bug Fixes
+
+- **ast:** fix visitor merging when performing node replacements ([#4124](https://github.com/swagger-api/apidom/issues/4124)) ([c89cbad](https://github.com/swagger-api/apidom/commit/c89cbadb00a0dadb08daf39f5be949bff67457f8)), closes [#4120](https://github.com/swagger-api/apidom/issues/4120)
+
+# [1.0.0-alpha.2](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.1...v1.0.0-alpha.2) (2024-05-20)
+
+### Features
+
+- **ast:** add support for mutable node replacements ([#4121](https://github.com/swagger-api/apidom/issues/4121)) ([b37ecd2](https://github.com/swagger-api/apidom/commit/b37ecd2dba83aaa3813bb539ae64e98b290f0292)), closes [#4120](https://github.com/swagger-api/apidom/issues/4120)
+
 # [1.0.0-alpha.1](https://github.com/swagger-api/apidom/compare/v1.0.0-alpha.0...v1.0.0-alpha.1) (2024-05-15)
 
 **Note:** Version bump only for package @swagger-api/apidom-ast

package/cjs/traversal/visitor.cjs

@@ -57,7 +57,7 @@ const cloneNode = node => Object.create(Object.getPrototypeOf(node), Object.getO
  * parallel. Each visitor will be visited for each node before moving on.
  *
  * If a prior visitor edits a node, no following visitors will see that node.
- * `exposeEdits=true` can be used to exoise the edited node from the previous visitors.
+ * `exposeEdits=true` can be used to expose the edited node from the previous visitors.
  */
 exports.cloneNode = cloneNode;
 const mergeAll = (visitors, {
@@ -71,14 +71,21 @@ const mergeAll = (visitors, {
   const skipSymbol = Symbol('skip');
   const skipping = new Array(visitors.length).fill(skipSymbol);
   return {
-    enter(node, ...rest) {
+    enter(node, key, parent, path, ancestors, link) {
       let currentNode = node;
       let hasChanged = false;
+      const linkProxy = {
+        ...link,
+        replaceWith(newNode, replacer) {
+          link.replaceWith(newNode, replacer);
+          currentNode = newNode;
+        }
+      };
       for (let i = 0; i < visitors.length; i += 1) {
         if (skipping[i] === skipSymbol) {
           const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), false);
           if (typeof visitFn === 'function') {
-            const result = visitFn.call(visitors[i], currentNode, ...rest);
+            const result = visitFn.call(visitors[i], currentNode, key, parent, path, ancestors, linkProxy);
 
             // check if the visitor is async
             if (typeof (result == null ? void 0 : result.then) === 'function') {
@@ -88,7 +95,7 @@ const mergeAll = (visitors, {
               });
             }
             if (result === skipVisitingNodeSymbol) {
-              skipping[i] = node;
+              skipping[i] = currentNode;
             } else if (result === breakSymbol) {
               skipping[i] = breakSymbol;
             } else if (result === deleteNodeSymbol) {
@@ -106,12 +113,20 @@ const mergeAll = (visitors, {
       }
       return hasChanged ? currentNode : undefined;
     },
-    leave(node, ...rest) {
+    leave(node, key, parent, path, ancestors, link) {
+      let currentNode = node;
+      const linkProxy = {
+        ...link,
+        replaceWith(newNode, replacer) {
+          link.replaceWith(newNode, replacer);
+          currentNode = newNode;
+        }
+      };
       for (let i = 0; i < visitors.length; i += 1) {
         if (skipping[i] === skipSymbol) {
-          const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(node), true);
+          const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), true);
           if (typeof visitFn === 'function') {
-            const result = visitFn.call(visitors[i], node, ...rest);
+            const result = visitFn.call(visitors[i], currentNode, key, parent, path, ancestors, linkProxy);
 
             // check if the visitor is async
             if (typeof (result == null ? void 0 : result.then) === 'function') {
@@ -126,7 +141,7 @@ const mergeAll = (visitors, {
               return result;
             }
           }
-        } else if (skipping[i] === node) {
+        } else if (skipping[i] === currentNode) {
           skipping[i] = skipSymbol;
         }
       }
@@ -146,17 +161,24 @@ const mergeAllAsync = (visitors, {
   const skipSymbol = Symbol('skip');
   const skipping = new Array(visitors.length).fill(skipSymbol);
   return {
-    async enter(node, ...rest) {
+    async enter(node, key, parent, path, ancestors, link) {
       let currentNode = node;
       let hasChanged = false;
+      const linkProxy = {
+        ...link,
+        replaceWith(newNode, replacer) {
+          link.replaceWith(newNode, replacer);
+          currentNode = newNode;
+        }
+      };
       for (let i = 0; i < visitors.length; i += 1) {
         if (skipping[i] === skipSymbol) {
           const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), false);
           if (typeof visitFn === 'function') {
             // eslint-disable-next-line no-await-in-loop
-            const result = await visitFn.call(visitors[i], currentNode, ...rest);
+            const result = await visitFn.call(visitors[i], currentNode, key, parent, path, ancestors, linkProxy);
             if (result === skipVisitingNodeSymbol) {
-              skipping[i] = node;
+              skipping[i] = currentNode;
             } else if (result === breakSymbol) {
               skipping[i] = breakSymbol;
             } else if (result === deleteNodeSymbol) {
@@ -174,20 +196,28 @@ const mergeAllAsync = (visitors, {
       }
       return hasChanged ? currentNode : undefined;
     },
-    async leave(node, ...rest) {
+    async leave(node, key, parent, path, ancestors, link) {
+      let currentNode = node;
+      const linkProxy = {
+        ...link,
+        replaceWith(newNode, replacer) {
+          link.replaceWith(newNode, replacer);
+          currentNode = newNode;
+        }
+      };
       for (let i = 0; i < visitors.length; i += 1) {
         if (skipping[i] === skipSymbol) {
-          const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(node), true);
+          const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), true);
           if (typeof visitFn === 'function') {
             // eslint-disable-next-line no-await-in-loop
-            const result = await visitFn.call(visitors[i], node, ...rest);
+            const result = await visitFn.call(visitors[i], currentNode, key, parent, path, ancestors, linkProxy);
             if (result === breakSymbol) {
               skipping[i] = breakSymbol;
             } else if (result !== undefined && result !== skipVisitingNodeSymbol) {
               return result;
             }
           }
-        } else if (skipping[i] === node) {
+        } else if (skipping[i] === currentNode) {
           skipping[i] = skipSymbol;
         }
       }
@@ -383,8 +413,22 @@ visitor, {
         for (const [stateKey, stateValue] of Object.entries(state)) {
           visitor[stateKey] = stateValue;
         }
+        const link = {
+          // eslint-disable-next-line @typescript-eslint/no-loop-func
+          replaceWith(newNode, replacer) {
+            if (typeof replacer === 'function') {
+              replacer(newNode, node, key, parent, path, ancestors);
+            } else if (parent) {
+              parent[key] = newNode;
+            }
+            if (!isLeaving) {
+              node = newNode;
+            }
+          }
+        };
+
         // retrieve result
-        result = visitFn.call(visitor, node, key, parent, path, ancestors);
+        result = visitFn.call(visitor, node, key, parent, path, ancestors, link);
       }
 
       // check if the visitor is async
@@ -542,9 +586,22 @@ visitor, {
         for (const [stateKey, stateValue] of Object.entries(state)) {
           visitor[stateKey] = stateValue;
         }
+        const link = {
+          // eslint-disable-next-line @typescript-eslint/no-loop-func
+          replaceWith(newNode, replacer) {
+            if (typeof replacer === 'function') {
+              replacer(newNode, node, key, parent, path, ancestors);
+            } else if (parent) {
+              parent[key] = newNode;
+            }
+            if (!isLeaving) {
+              node = newNode;
+            }
+          }
+        };
 
         // retrieve result
-        result = await visitFn.call(visitor, node, key, parent, path, ancestors); // eslint-disable-line no-await-in-loop
+        result = await visitFn.call(visitor, node, key, parent, path, ancestors, link); // eslint-disable-line no-await-in-loop
       }
       if (result === breakSymbol) {
         break;