blackflux/object-scan

Traverse object hierarchies using matching and callbacks.

object-scan's Issues

Use Object.create(null) instead of {} where appropriate

Test for shallow input traverse for *.*

"Leaf" nodes only

Option to only return leaf nodes. Currently this possible using filterfn, however a simple flag would be preferred...

Compare to jsonPath / ObjectPath

Great great work and really impressive!

Would be interesting to see and outline on the project page, which pro's and cons exist in comparison to for example:

• ObjectPath
• JSONPath

For example in

• Functionality / focus
• Performance
• ...

But of course absolutely minor priority... ;)

Improve Regex generation (there might be weird edge cases when escaping is used)

Minimize traversal for "**"

Currently the traversal is redundant. We can do much better by traversing all non ** first but keeping track of all ** and then traversing all remaining paths using just pure **. Need to handle needle better in this case (prefer non **)

Design, implement, document needles in cb

Currently this is a bit confusing. Differentiation:

• non excluding needle
• excluding needle
• all leaf needles
• all non excluding needles not followed by an excluding needle

Also: How to keep the cb fn cheap or at least give the option

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

The push permission to the Git repository is required.

semantic-release cannot push the version tag to the branch master on remote Git repository with URL https://github.com/simlu/object-scan.git.

Please refer to the authentication configuration documentation to configure the Git credentials on your CI environment and make sure the repositoryUrl is configured with a valid Git URL.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Else if instead of if for ** checks (currently get hit unnecessarily)

https://github.com/simlu/object-scan/blob/master/src/index.js#L27

And other check below (2x)

Readme: add feature needle validation (wording?)

Support exclusion using "!" character

Will need sufficient amount of tests to ensure edge cases are handled correctly

Add Option to suppress redundant needle target

Add more keywords

Eg tree, traversal. What else?

Joi template validation on input params

Fix Matching for '' should be in below in if clause!

Merge callback and filter function into one?

Why are these separate really? Is there a good use case?

Refactor compilation to be iterative instead of recursive

https://github.com/blackflux/object-scan/blob/master/src/util/compiler.js#L58

Should ** match zero nestings as well?

Support for partial matching of keys

E.g. Matching "a" or "foo" in a key

Readme filterfn

Can be used as a callback function
Called in same order as matches appear in result

Improve needle output for '**' matches

The needles are correctly displayed, however the '**' injection is omitted.

Ideally we would display the needles with the '**' injection displayed as '*'.

Not sure how to efficiently do that. Have to think about it more.

See test example (lots of redundancy and hard to interpret)

Add missing functionality for glob compatibility

The ultimate goal is to get this library into a state where we can use it to power very efficient glob matching. The functionality is almost there. Missing:

• Arbitrary depth matching of specific patterns, e.g. *(pattern), @(pattern) etc. Have to better understand how pattern are used with file extensions, e.g. what does 'source/*(some|file).py' mean?
• Full regex support. Maybe we can just support that inside ()?

See here for more information: https://facelessuser.github.io/wcmatch/glob/#syntax

Once equivalent functionality is fully supported it should be possible to write a glob library powered by object-scan.

Return key / value (option) instead of list

Should make it possible to have function to return subset of object.

Maybe this should be a callback option instead? Or can we just use what is currently there (breakfn)?

Allow `?` syntax to match single character (similar to `*` syntax)

add "stop" function to stop scanning (key and value)

Potentially remove "escapePaths" option

Have to think about what the use case is and how it could be handled differently

Document and test function execution order

There are a lot of callbacks going on. Need to document the order they're executed in and write a test to ensure it stays that way.

Reorder / reword readme features

Changed default `joined=false`

In almost all spots it's desired to have joined=false and it's a huge performance penalty to have it set to true.

(Automated) performance testing

We could also compare to other (similar) implementation, ie object-glob

https://nodejs.org/en/docs/guides/simple-profiling/

Add demo page

value function should also receive key

Allow for `key.{some,other.key}` syntax

Allow for key.{some,other.key} syntax

• Need to carefully evaluate all steps: parse, compile and search
• Need to verify that object-rewrite still works correctly

Separate out / write more integration tests

Define input as json, write *.spec.json test files and generate tests dynamically. If output doesn't exist write it instead of failing test.

Can use either input json (string reference to input file) or in test defined json

Look at callbackfn tests for reference (log in output for breakfn and callbackfn)

Add parent/getParent

Handle self referencing (infinite recursion)

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

The push permission to the Git repository is required.

semantic-release cannot push the version tag to the branch master on remote Git repository with URL https://github.com/simlu/object-scan.git.

Please refer to the authentication configuration documentation to configure the Git credentials on your CI environment and make sure the repositoryUrl is configured with a valid Git URL.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Allow joined=false style needle input

Fix ** matching

Should match as empty, but not after nested?

There is probably a bug here!

See test example that has * as a 'matches' entey. It probably shouldn't have

Deficiency: Result not unique when "joined=false" is used (see sorted test)

Optimize getMeta / joined performance

• consider option to determine which fields need to be computed for which cb function (so they're not all computed all the time)
• consider caching of joined=true
• consider cb fn length when determining if to compute getMeta
• consider caching getMeta results smartly (look at nesting level deepness)

In strict mode: Raise error if the needle isn't declared optimally

Optimization

Now that meta computation gotten more expensive it should only be computed once. However computation should still only happen on demand.

Change test structure to contain settings

I. E.

settings.log -= [...]

Allow.setting to false.

Move options under settings key

Rename desc

From "wildcard matching" to "glob matching"

Execute filterFn before arrayCallbackFn?

Evaluate exclusion in compile step

When exclusion is used there should be a post processing step in the compile step that removes all previous and matching targets from the search tree. This has been hacked in for now here (for the recursive logic):

https://github.com/blackflux/object-scan/pull/876/files#diff-ea68f5d98be2a91004d43789469827c1R75

However this should be handled generically

Consider full support of jmespath

Definitely require a bit of rework. Also need to consider how it ties in with #279

Integration test for *\.*

Create mass random tests

• Auto generate data set and needles
• Randomly select parameters to generate data set and needles (different probabilities)
• Commit data and results
• Should prevent regression for weird edge cases

Tldr Use the power of mass random