#7: Rename down-hosts output option

vdjagilev · Jul 8, 2021 · 7bdedf6 · 7bdedf6
1 parent 2ed873e
commit 7bdedf6
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -26,10 +26,15 @@ nmap-formatter [path-to-nmap.xml] md > some-markdown.md
 
 ### Flags
 
-* `--down-hosts` includes hosts that are down in the template (html, md)
 * `-f, --file [filename]` outputs result to the file (by default output goes to STDOUT)
 * `--help` display help message
 
+#### Output Related Flags
+
+* `--skip-down-hosts` skips hosts that are down
+  * Applicable in: `html`, `md`, `csv`
+  * Default: `true`
+
 ## Installation
 
 ### Using Go

diff --git a/cmd/root.go b/cmd/root.go
@@ -85,7 +85,7 @@ func init() {
 	log.SetOutput(os.Stderr)
 
 	rootCmd.Flags().StringVarP((*string)(&config.OutputFile), "file", "f", "", "-f output-file (by default \"\" will output to STDOUT)")
-	rootCmd.Flags().BoolVar(&config.OutputOptions.DisplayDownHosts, "down-hosts", false, "--down-hosts=true")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.SkipDownHosts, "skip-down-hosts", true, "--skip-down-hosts=false")
 }
 
 // validate is checking input from the command line

diff --git a/formatter/formatter_csv.go b/formatter/formatter_csv.go
@@ -19,7 +19,7 @@ func (f *CSVFormatter) convert(td *TemplateData) (data [][]string) {
 	data = append(data, []string{"IP", "Port", "Protocol", "State", "Service", "Reason", "Product", "Version", "Extra info"})
 	for _, host := range td.NMAPRun.Host {
 		// Skipping hosts that are down
-		if !td.OutputOptions.DisplayDownHosts && host.Status.State != "up" {
+		if td.OutputOptions.SkipDownHosts && host.Status.State != "up" {
 			continue
 		}
 		address := fmt.Sprintf("%s (%s)", host.HostAddress.Address, host.Status.State)

diff --git a/formatter/output_options.go b/formatter/output_options.go
@@ -3,5 +3,5 @@ package formatter
 // OutputOptions describes various output options for nmap formatter
 type OutputOptions struct {
 	// The hosts that are down wont be displayed in the TOC
-	DisplayDownHosts bool
+	SkipDownHosts bool
 }
diff --git a/formatter/resources/templates/markdown.tmpl b/formatter/resources/templates/markdown.tmpl
@@ -1,6 +1,6 @@
 NMAP Scan Result: {{ .NMAPRun.StartStr }}
 ==========================================
-{{- $displayDownHosts := .OutputOptions.DisplayDownHosts }}
+{{- $displayDownHosts := not .OutputOptions.SkipDownHosts }}
 
 ## TOC
 

diff --git a/formatter/resources/templates/simple-html.gohtml b/formatter/resources/templates/simple-html.gohtml
@@ -77,7 +77,7 @@
 		</style>
 	</head>
 	<body>
-		{{ $displayDownHosts := .OutputOptions.DisplayDownHosts }}
+		{{ $displayDownHosts := not .OutputOptions.SkipDownHosts }}
 		<h1>NMAP Scan Result: {{ .NMAPRun.StartStr }}</h1>
 		<hr />
 		<h2>TOC:</h2>