Add JsonPatchStep

[DavidGregory084]

This adds an JsonPatchStep, for applying JSON patches to documents.

I've used zjsonpatch as the implementation library, but I think it could be adapted to use json-patch pretty easily if that is more suitable.

My example use case involves updating contributed configuration for a VS Code extension in a package.json file:

format("packageJson", JsonExtension::class.java) {
    target("package.json")

    val languageServerVersionPath =
        "/contributes/configuration/0/properties/mina.languageServer.version/default"
    val profilingAgentVersionPath =
        "/contributes/configuration/2/properties/mina.languageServer.profiling.agentVersion/default"

    jsonPatch(
        listOf(
            // Replace VS code default configuration for language server version
            mapOf(
                "op" to "replace",
                "path" to languageServerVersionPath,
                "value" to rootProject.project("mina-lang-server").version.toString()
            ),
            // Replace VS code default configuration for profiling agent version
            mapOf(
                "op" to "replace",
                "path" to profilingAgentVersionPath,
                "value" to libs.versions.pyroscopeAgent.get()
            )
        )
    )

    prettier()
}

Thanks to my employer @opencastsoftware for sponsoring this work!

[nedtwigg]

Thanks for this submission! At first glance, I don't understand when a user would prefer this over a regex replace. The regex replace seems simpler and just as capable. Maybe it will be more clear after you update the docs.

If it's useful for you and can be documented in a reasonably small hunk of text, then I'm happy to merge it.

[DavidGregory084]

So to motivate why you might want to use a JSON patch - I think it would be extremely difficult and error prone to write a regex to replace the “default” properties in this JSON to different values depending upon the enclosing property names. You’d need to write a pretty gnarly multiline regex full of lookbehind and lookahead assertions. I’m not saying it’s not possible but it certainly wouldn’t be the way I’d choose to do it if I had a choice.

[nedtwigg]

Ah, I just read the zjsonpatch docs. I was not aware that of the json patch standard. Neat idea! I'm all for it :). Add docs and we're ready to go.

[DavidGregory084]

Apologies @nedtwigg, it took me a little while to get back to this one but I've updated the READMEs and CHANGELOGs now, let me know what you think and if there's anything that I've missed!

[nedtwigg]

Thanks very much, this looks great! What do you think about renaming everything from applyJsonPatch to just jsonPatch? Once that is done I'll merge and release.

[DavidGregory084]

Sure, I've done that now @nedtwigg 👍

[nedtwigg]

Released in plugin-gradle 6.21.0 and plugin-maven 2.38.0.