feat: Make policy available in doc command (#593)

mrueg · web-flow · commit de4fbc0e5900 · 2025-02-24T19:49:54.000-08:00
diff --git a/internal/commands/document.go b/internal/commands/document.go
@@ -36,6 +36,7 @@ type Document struct {
 	Header Header
 	URL    string
 	Rego   string
+	Policy rego.Rego
 }
 
 //go:embed document_template.tpl
@@ -308,6 +309,7 @@ func getDocumentation(path string, outputDirectory string) (map[rego.Severity][]
 			Header: header,
 			URL:    url,
 			Rego:   rego,
+			Policy: policy,
 		}
 
 		if policy.Severity() == "" {
diff --git a/internal/commands/document_policy_csv.tpl b/internal/commands/document_policy_csv.tpl
@@ -0,0 +1,6 @@
+{{/* This is an example how to create a CSV file that includes the policy ID and the policy name */}}
+{{- range $severity, $value := . }}
+{{- range . }}
+{{ .Policy.PolicyID | default "-" }},{{ .Policy.Name }}
+{{- end }}
+{{- end }}

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ type Document struct {`
`36`	`36`	`Header Header`
`37`	`37`	`URL string`
`38`	`38`	`Rego string`
	`39`	`+ Policy rego.Rego`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`//go:embed document_template.tpl`
`@@ -308,6 +309,7 @@ func getDocumentation(path string, outputDirectory string) (map[rego.Severity][]`
`308`	`309`	`Header: header,`
`309`	`310`	`URL: url,`
`310`	`311`	`Rego: rego,`
	`312`	`+ Policy: policy,`
`311`	`313`	`}`
`312`	`314`
`313`	`315`	`if policy.Severity() == "" {`