Merge pull request #4 from GreatAuk/bump-dep

升级开发依赖包

Author: GreatAuk

package.json

@@ -39,10 +39,10 @@
     "@types/node": "^18.14.6",
     "@vitest/coverage-v8": "^3.2.4",
     "bumpp": "^9.0.0",
-    "oxlint": "^1.3.0",
+    "oxlint": "^1.32.0",
     "rimraf": "^4.4.0",
     "stale-dep": "^0.8.2",
-    "tsdown": "^0.12.9",
+    "tsdown": "^0.17.3",
     "tsx": "^3.12.3",
     "turbo": "^2.5.4",
     "typescript": "^5.8.3",

packages/tree/src/treeFilterNode.ts

@@ -16,6 +16,40 @@ interface Options<TreeNode> {
  * @param {Options} [options] - {
  * @returns A filtered tree
  * @linkcode https://github.com/GreatAuk/utopia-utils/blob/main/packages/tree/src/treeFilterNode.ts
+ * @example
+ * ```
+    const tree = [
+      {
+        id: 'root',
+        children: [
+          {
+            id: 'child1',
+            children: [
+              {
+                id: 'child1-1',
+              },
+            ],
+          },
+          {
+            id: 'child2',
+          },
+        ],
+      },
+    ]
+    const filteredTree = treeFilterNode(tree, node => node.id === 'child2')
+    console.log(filteredTree)
+    // output
+    // [
+    //   {
+    //     "children": [
+    //       {
+    //         "id": "child2",
+    //       },
+    //     ],
+    //     "id": "root",
+    //   },
+    // ]
+ * ```
  */
 export function treeFilterNode<TreeNode>(tree: TreeNode[] | TreeNode, predicate: (node: TreeNode) => boolean, options?: Options<TreeNode>): TreeNode[] {
   const { fieldNames, onEachTraverse } = options || {}

packages/tree/src/treeFindPath.ts

@@ -27,31 +27,31 @@ interface Options {
       },
     ]
 
-    const path = treeFindPath(tree, node => node.name === 'b')
-    console.log(path?.map(v => v.name)) // ['a', 'b']
+    const pathNodes = treeFindPath(tree, node => node.name === 'b')
+    console.log(pathNodes?.map(v => v.name)) // ['a', 'b']
  * ```
  */
 export function treeFindPath<TreeNode>(tree: TreeNode[] | TreeNode, predicate: (node: TreeNode) => boolean, options?: Options): TreeNode[] | null {
   const { fieldNames } = options || {}
   const { children: childrenField } = { ...DEFAULT_FIELD_NAMES, ...fieldNames }
 
-  const path: TreeNode[] = []
+  const pathNodes: TreeNode[] = []
   const queue = Array.isArray(tree) ? [...tree] : [tree]
   const visitedSet = new Set<TreeNode>()
 
   while (queue.length) {
     const node = queue[0]
     if (visitedSet.has(node)) {
-      path.pop()
+      pathNodes.pop()
       queue.shift()
     }
     else {
       visitedSet.add(node)
       // @ts-expect-error - dynamic field name
       node[childrenField] && queue.unshift(...node[childrenField])
-      path.push(node)
+      pathNodes.push(node)
       if (predicate(node))
-        return path
+        return pathNodes
     }
   }
   return null