v2 glob search feature removed?

[osfameron]

I'm parsing OpenAPI docs and want to look for .name or .description fields at any level using https://vale.sh/docs/views (which currently uses dase 2.8.1).

Because OpenAPI .yml files can include other files using $ref, the fields can be at any level.

In e.g. Yq I'd use something like recursive descent glob https://mikefarah.gitbook.io/yq/operators/recursive-descent-glob

It looks like dasel v1 had this feature with https://daseldocs.tomwright.me/v1/selectors/search

I don't see how to recreate that using the available v2 operators. Has this feature been removed?

[TomWright]

Great question - I don't think V2 supports this but it's good timing for me to add this into v3.

Is there a preferred syntax for this call? (You can see the v3 syntax at daseldocs.tomwright.me).

[osfameron]

A statement is made up of a sequence of accessors or function calls, chained together with a dot (.) and terminated with a semi-colon (;).

.. would be quite familiar? (e.g. XPath's // and yq's .., not to mention zsh **)

So e.g.

$root.name finds name at Root
$root..name finds anywhere under Root.

[osfameron]

The reason .. feels awkward to me is because I'd like to let users match based on any condition. ..x only allows you to search for fields that have a map key of x, whereas a functional approach allow you to match on any condition search($this.x == "foo").

To me ..x makes sense, however ..x.foo.bar = "baz" does not.

Isn't that the same with single key traversal? e.g. $root.x.bar = "baz" is similarly absurd?
There you'd write $root.x.filter(bar = "baz") wouldn't you?

So similarly ..x.foo.filter(bar = "baz")

I think that . is essentially syntactic sugar for some traversal function.
e.g.

foo.bar.baz is just traverse( traverse( traverse($root, "foo"), "bar"), "baz") but is significantly easier to type and reason about.

And similarly you could make .. syntactic sugar for your new search function.

[osfameron]

(I'll try to send a few sample inputs later, I may have to anonymise our OpenAPI specs)

[TomWright]

After sleeping on this I think I'm mixing up glob and search.
I'm coming at the problem from a generic "I want to find something in a tree" for which my search approach works well.

I think a separate .. operator can also make sense for use-cases where you want to simply find all attributes with a given name or index.

I'll try and do some work on this tonight, but some sanitised sample input/output data would help me write tests to ensure this feature matches expectations.

[osfameron]

How about these two?
AllowedCidr.yaml.txt
AnalyticsClusterId.yaml.txt

One with properties.*.description and the other with $root.description directly.

Re glob and search I think glob ..key would essentially map to .search(filter(typeOf($this="map") && has($key)

e.g. search is strictly more powerful than glob, which is implemented in terms of search.

[TomWright]

How does this look?

Search docs here: https://daseldocs.tomwright.me/functions/search
Recursive descent docs here: https://daseldocs.tomwright.me/syntax/recursive-descent

dasel/internal/cli/command_test.go

Lines 121 to 186 in fce641d

	t.Run("recursive descent", func(t *testing.T) {
	t.Run("wildcard", runTest(testCase{
	args: []string{"-i", "json", `..*`},
	in: []byte(`{
	"user": {
	"name": "Alice",
	"roles": ["admin", "editor"],
	"meta": {
	"active": true,
	"score": 42
	}
	},
	"tags": ["x", "y"],
	"count": 10
	}`),
	stdout: []byte(`[
	"Alice",
	"admin",
	"editor",
	true,
	42,
	"x",
	"y",
	10
	]
	`),
	stderr: nil,
	err: nil,
	}))
	t.Run("property", runTest(testCase{
	args: []string{"-i", "json", `..name`},
	in: []byte(`{
	"user": {
	"name": "Alice",
	"roles": ["admin", "editor"],
	"meta": {
	"active": true,
	"score": 42
	}
	},
	"tags": ["x", "y"],
	"count": 10
	}`),
	stdout: []byte(`[
	"Alice"
	]
	`),
	stderr: nil,
	err: nil,
	}))
	t.Run("index", runTest(testCase{
	args: []string{"-i", "json", `..[0]`},
	in: []byte(`{
	"user": {
	"name": "Alice",
	"roles": ["admin", "editor"],
	"meta": {
	"active": true,
	"score": 42
	}
	},
	"tags": ["x", "y"],
	"count": 10
	}`),