base on JSON diff and patch [](https://goreportcard.com/report/josephburnett/jd) # JSON diff and patch `jd` is a commandline utility and Go library for diffing and patching JSON and YAML values. It supports a native `jd` format (similar to unified format) as well as JSON Merge Patch ([RFC 7386](https://datatracker.ietf.org/doc/html/rfc7386)) and a subset of JSON Patch ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)). Try it out at http://play.jd-tool.io/.  ## Installation To get the `jd` commandline utility: * run `brew install jd`, or * run `go install github.com/josephburnett/jd@latest`, or * visit https://github.com/josephburnett/jd/releases/latest and download the pre-built binary for your architecture/os, or * run in a Docker image `jd(){ docker run --rm -i -v $PWD:$PWD -w $PWD josephburnett/jd "$@"; }`. To use the `jd` web UI: * visit http://play.jd-tool.io/, or * run `jd -port 8080` and visit http://localhost:8080. ## Command line usage ``` Usage: jd [OPTION]... FILE1 [FILE2] Diff and patch JSON files. Prints the diff of FILE1 and FILE2 to STDOUT. When FILE2 is omitted the second input is read from STDIN. When patching (-p) FILE1 is a diff. Options: -color Print color diff. -p Apply patch FILE1 to FILE2 or STDIN. -o=FILE3 Write to FILE3 instead of STDOUT. -set Treat arrays as sets. -mset Treat arrays as multisets (bags). -setkeys Keys to identify set objects -yaml Read and write YAML instead of JSON. -port=N Serve web UI on port N -f=FORMAT Produce diff in FORMAT "jd" (default), "patch" (RFC 6902) or "merge" (RFC 7386) -t=FORMATS Translate FILE1 between FORMATS. Supported formats are "jd", "patch" (RFC 6902), "merge" (RFC 7386), "json" and "yaml". FORMATS are provided as a pair separated by "2". E.g. "yaml2json" or "jd2patch". Examples: jd a.json b.json cat b.json | jd a.json jd -o patch a.json b.json; jd patch a.json jd -set a.json b.json jd -f patch a.json b.json jd -f merge a.json b.json ``` #### Command Line Option Details `setkeys` This option determines what keys are used to decide if two objects 'match'. Then the matched objects are compared, which will return a diff if there are differences in the objects themselves, their keys and/or values. You shouldn't expect this option to mask or ignore non-specified keys, it is not intended as a way to 'ignore' some differences between objects. ## Library usage Note: import only release commits (`v1.Y.Z`) because `master` can be unstable. ```Go import ( "fmt" jd "github.com/josephburnett/jd/lib" ) func ExampleJsonNode_Diff() { a, _ := jd.ReadJsonString(`{"foo":"bar"}`) b, _ := jd.ReadJsonString(`{"foo":"baz"}`) fmt.Print(a.Diff(b).Render()) // Output: // @ ["foo"] // - "bar" // + "baz" } func ExampleJsonNode_Patch() { a, _ := jd.ReadJsonString(`["foo"]`) diff, _ := jd.ReadDiffString(`` + `@ [1]` + "\n" + `+ "bar"` + "\n") b, _ := a.Patch(diff) fmt.Print(b.Json()) // Output: // ["foo","bar"] } ``` ## Diff language  - A diff is zero or more sections - Sections start with a `@` header and the path to a node - A path is a JSON list of zero or more elements accessing collections - A JSON number element (e.g. `0`) accesses an array - A JSON string element (e.g. `"foo"`) accesses an object - An empty JSON object element (`{}`) accesses an array as a set or multiset - After the path is one or more removals or additions, removals first - Removals start with `-` and then the JSON value to be removed - Additions start with `+` and then the JSON value to added ### EBNF ```EBNF Diff ::= ( '@' '[' ( 'JSON String' | 'JSON Number' | 'Empty JSON Object' )* ']' '\n' ( ( '-' 'JSON Value' '\n' )+ | '+' 'JSON Value' '\n' ) ( '+' 'JSON Value' '\n' )* )* ``` ### Examples ```DIFF @ ["a"] - 1 + 2 ``` ```DIFF @ [2] + {"foo":"bar"} ``` ```DIFF @ ["Movies",67,"Title"] - "Dr. Strangelove" + "Dr. Evil Love" @ ["Movies",67,"Actors","Dr. Strangelove"] - "Peter Sellers" + "Mike Myers" @ ["Movies",102] + {"Title":"Austin Powers","Actors":{"Austin Powers":"Mike Myers"}} ``` ```DIFF @ ["Movies",67,"Tags",{}] - "Romance" + "Action" + "Comedy" ``` ## Cookbook ### Use git diff to produce a structural diff: ```diff git difftool -yx jd @ -- foo.json @ ["foo"] - "bar" + "baz" ``` ### See what changes in a Kubernetes Deployment: ```bash kubectl get deployment example -oyaml > a.yaml kubectl edit deployment example # change cpu resource from 100m to 200m kubectl get deployment example -oyaml | jd -yaml a.yaml ``` output: ```diff @ ["metadata","annotations","deployment.kubernetes.io/revision"] - "2" + "3" @ ["metadata","generation"] - 2 + 3 @ ["metadata","resourceVersion"] - "4661" + "5179" @ ["spec","template","spec","containers",0,"resources","requests","cpu"] - "100m" + "200m" @ ["status","conditions",1,"lastUpdateTime"] - "2021-12-23T09:40:39Z" + "2021-12-23T09:41:49Z" @ ["status","conditions",1,"message"] - "ReplicaSet \"nginx-deployment-787d795676\" has successfully progressed." + "ReplicaSet \"nginx-deployment-795c7f5bb\" has successfully progressed." @ ["status","observedGeneration"] - 2 + 3 ``` apply these change to another deployment: ```bash # edit file "patch" to contain only the hunk updating cpu request kubectl patch deployment example2 --type json --patch "$(jd -t jd2patch ~/patch)" ``` ", Assign "at most 3 tags" to the expected json: {"id":"11717","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"