Repository navigation
feat(deep): add sequential async traversal and stable path sorting - #254
Merged
Merged
Conversation
6 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add documented reusable operations for sequential tree work and sorting records by a numeric position within a path array. Async visitor failures now propagate; skipped subtrees do not skip later siblings. Sorting validates depth against each path rather than the number of records and checks all keys before mutating the input.
Original request
Move the async deep traversal and numeric path sorting helpers into
@cleverbrush/deepas a separate PR with documentation and unit tests.What changed
deepForEachAsync(input, visitor, context?, options?)and its typed child-selection/filtering options.deepSort(items, index, field)with explicit invalid-index/value errors and validation before mutation.Reasoning
These helpers operate on generic data and belong in the deep package. Keeping explicit traversal/mutation contracts avoids undocumented behavior, hanging promises and sorting mistakes in consumers.
Type of Change
Blog post
Skipped: internal data-processing infrastructure API; the package README and JSDoc document the feature.
Screenshots / preview evidence
Not applicable: no UI or demo behavior changes. Consumer editor and rendering verification belongs to its integration PR.
Validation
npm run lint,npm run build,npm run test: pass.npm run test:coverage: all published-package floors pass; both new helpers have 100% lines/statements/functions/branches.Checklist