Make the default output format JSONL

Author: oschwald

CHANGELOG.md

@@ -2,11 +2,16 @@
 
 ## 2.0.0
 
-* The output format has been flattened. When outputting to JSON, there is
-  now one JSON object per line, containing the following keys: `database_path`,
-  `requested_lookup`, `network`, and `record`. This allows for efficient
-  streaming of large lookups, makes the key naming more consistent, and
-  reduces the depth of the data structure.
+* The default output format is now YAML. This was done to improve the
+  readability when using the tool as a standalone utility for doing lookups
+  in an MMDB database. Use the `-jsonl` flag to output as JSONL instead.
+* When outputting as JSON, we now use JSONL. There is one JSON object per
+  line.
+* The output format has been flattened. Each record that is output now
+  contains the following keys: `database_path`, `requested_lookup`,
+  `network`, and `record`. This allows for efficient streaming of large
+  lookups, makes the key naming more consistent, and reduces the depth of
+  the data structure.
 * Upgrade to `github.com/oschwald/maxminddb-golang/v2`. This is a breaking
   API change, but should not affect the use of the program.
 * You may now use a glob for the `-db` argument. If there are multiple

cmd/mmdbinspect/main.go

@@ -10,6 +10,7 @@ import (
 	"os"
 	"strings"
 
+	"github.com/goccy/go-yaml"
 	"github.com/maxmind/mmdbinspect/v2/pkg/mmdbinspect"
 )
 
@@ -34,6 +35,8 @@ func main() {
 		"Include aliased networks (e.g. 6to4, Teredo). This option may cause IPv4 networks to be listed more than once via aliases.", //nolint: lll
 	)
 
+	useJSONL := flag.Bool("jsonl", false, "Output as JSONL instead of YAML")
+
 	flag.Usage = usage
 	flag.Parse()
 
@@ -52,7 +55,16 @@ func main() {
 		os.Exit(1)
 	}
 
-	encoder := json.NewEncoder(os.Stdout)
+	w := os.Stdout
+
+	var encoder interface {
+		Encode(any) error
+	}
+	if *useJSONL {
+		encoder = json.NewEncoder(w)
+	} else {
+		encoder = yaml.NewEncoder(w)
+	}
 
 	iterator := mmdbinspect.Records(network, mmdb, *includeAliasedNetworks)
 

go.mod

@@ -3,6 +3,7 @@ module github.com/maxmind/mmdbinspect/v2
 go 1.23
 
 require (
+	github.com/goccy/go-yaml v1.15.23
 	github.com/oschwald/maxminddb-golang/v2 v2.0.0-beta.3
 	github.com/stretchr/testify v1.10.0
 )

go.sum

@@ -1,5 +1,7 @@
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/goccy/go-yaml v1.15.23 h1:WS0GAX1uNPDLUvLkNU2vXq6oTnsmfVFocjQ/4qA48qo=
+github.com/goccy/go-yaml v1.15.23/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
 github.com/oschwald/maxminddb-golang/v2 v2.0.0-beta.3 h1:dIygR/m/ArKzJy5HFVlDpBOG0hju03T+567HxrRRAF4=
 github.com/oschwald/maxminddb-golang/v2 v2.0.0-beta.3/go.mod h1:JojXVel5ck1JzMiz32OVBfSk7lAtfSDUfzxIyVEuahM=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=