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.

[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
	}`),

[osfameron]

Sorry, I looked at this when you posted, got frightened of the Go code, and ran away...

But the docs look perfect. I'll try to play with it soon (will ask the Vale maint also, but I'm sure I can figure out a Go toolchain if I spend a little time with it...)

[TomWright]

No problem, this is implemented as documented on the master branch.

If using from the CLI you can install go and use go install github.com/tomwright/dasel/v3/cmd/dasel@master for the time being.

[osfameron]

Thanks, I'm idly trying to hook it into Vale at https://github.com/errata-ai/vale/blob/v3/internal/core/view.go#L84

I figured out how to upgrade the dependency, but of course the dasel.Select call has changed with the new version, so it'll require me to actually learn (a little) Go 😂
(Or flutter eyelashes at the Vale maint...)

[TomWright]

The API that go apps can use to integrate is here: https://github.com/TomWright/dasel/blob/master/api.go

[osfameron]

Hey Tom, I had a quick chat with the Vale maint the other week, and he intended to upgrade to v3 Dasel once it was released/stable.

Do you have a roadmap for when you plan to do this? If it requires e.g. testing and documentation work, can I help contribute?

[TomWright]

Hey there,

There's a couple of things:

• Proper toml implementation is blocked: UnmarshalTOML isn't called when expected pelletier/go-toml#994
• Testing with existing usecases. I don't use dasel day-to-day so I have limited before/after examples I can create and test against.
• INI implementation. This isn't required but I would like to have this included in the first v3 release.

And of course my day job. This is a fairly large change and I want to quickly support people who have issues, but with my day job it's hard to find the time to do that.

I'm strongly considering releasing v3 as it is, since it won't block access to v2 via package managers or direct installation. Let me come back to this at the weekend to see if I have any rough edges to tidy up before releasing.

[TomWright]

I've just realised the yaml package dasel uses has been archived on github and is no longer maintained: https://github.com/go-yaml/yaml

I don't want to release until this is also resolved in-case any breakage occurs.