#11: Implement json-pretty print option

Author: vdjagilev

README.md

@@ -49,6 +49,9 @@ nmap-formatter [path-to-nmap.xml] md > some-markdown.md
 * `--skip-down-hosts` skips hosts that are down
   * Applicable in: `html`, `md`, `csv`
   * Default: `true`
+* `--json-pretty` pretty-prints JSON
+  * Applicable in: `json`
+  * Default: `true`
 
 ## Installation
 

cmd/root.go

@@ -1,3 +1,5 @@
+package cmd
+
 /*
 Copyright © 2021 vdjagilev
 
@@ -19,10 +21,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
-package cmd
 
 import (
-	_ "embed"
 	"errors"
 	"fmt"
 	"log"
@@ -61,7 +61,10 @@ func init() {
 	log.SetOutput(os.Stderr)
 
 	rootCmd.Flags().StringVarP((*string)(&config.OutputFile), "file", "f", "", "-f output-file (by default \"\" will output to STDOUT)")
+
+	// Some options related to the output
 	rootCmd.Flags().BoolVar(&config.OutputOptions.SkipDownHosts, "skip-down-hosts", true, "--skip-down-hosts=false")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.JSONPrettyPrint, "json-pretty", true, "--json-pretty=false (pretty prints JSON output)")
 
 	workflow = &formatter.MainWorkflow{}
 }

formatter/formatter_json.go

@@ -13,7 +13,12 @@ type JSONFormatter struct {
 // Format the data and output it to appropriate io.Writer
 func (f *JSONFormatter) Format(td *TemplateData) (err error) {
 	jsonData := new(bytes.Buffer)
-	err = json.NewEncoder(jsonData).Encode(td.NMAPRun)
+	encoder := json.NewEncoder(jsonData)
+	if td.OutputOptions.JSONPrettyPrint {
+		// space size = 2
+		encoder.SetIndent("", "  ")
+	}
+	err = encoder.Encode(td.NMAPRun)
 	if err != nil {
 		return err
 	}

formatter/formatter_json_test.go

@@ -34,6 +34,59 @@ func TestJSONFormatter_Format(t *testing.T) {
 			err:        nil,
 			wantOutput: "{\"Scanner\":\"\",\"Args\":\"\",\"Start\":\"\",\"StartStr\":\"\",\"Version\":\"\",\"ScanInfo\":{\"Type\":\"\",\"Protocol\":\"\",\"NumServices\":\"\",\"Services\":\"\"},\"Host\":null,\"Verbose\":{\"Level\":\"\"},\"Debugging\":{\"Level\":\"\"},\"RunStats\":{\"Finished\":{\"Time\":\"\",\"TimeStr\":\"\",\"Elapsed\":\"\",\"Summary\":\"\",\"Exit\":\"\"},\"Hosts\":{\"Up\":\"\",\"Down\":\"\",\"Total\":\"\"}}}\n",
 		},
+		{
+			name: "Empty output (with intend)",
+			f: &JSONFormatter{
+				&Config{
+					Writer: &writer,
+				},
+			},
+			args: args{
+				td: &TemplateData{
+					NMAPRun: NMAPRun{},
+					OutputOptions: OutputOptions{
+						JSONPrettyPrint: true,
+					},
+				},
+			},
+			wantErr: false,
+			err:     nil,
+			wantOutput: `{
+  "Scanner": "",
+  "Args": "",
+  "Start": "",
+  "StartStr": "",
+  "Version": "",
+  "ScanInfo": {
+    "Type": "",
+    "Protocol": "",
+    "NumServices": "",
+    "Services": ""
+  },
+  "Host": null,
+  "Verbose": {
+    "Level": ""
+  },
+  "Debugging": {
+    "Level": ""
+  },
+  "RunStats": {
+    "Finished": {
+      "Time": "",
+      "TimeStr": "",
+      "Elapsed": "",
+      "Summary": "",
+      "Exit": ""
+    },
+    "Hosts": {
+      "Up": "",
+      "Down": "",
+      "Total": ""
+    }
+  }
+}
+`,
+		},
 		{
 			name: "Error",
 			f: &JSONFormatter{

formatter/output_options.go

@@ -4,4 +4,6 @@ package formatter
 type OutputOptions struct {
 	// The hosts that are down wont be displayed in the TOC
 	SkipDownHosts bool
+	// JSONPrettyPrint defines if JSON output would be pretty-printed (human-readable) or not (machine readable)
+	JSONPrettyPrint bool
 }