Ignore inputs with terraform-docs-ignore comment

kampka · khos2ow · commit 943489ca41b9 · 2024-05-27T15:47:00.000-04:00
diff --git a/terraform/load.go b/terraform/load.go
@@ -187,10 +187,17 @@ func loadInputs(tfmodule *tfconfig.Module, config *print.Config) ([]*Input, []*I
 	var optional = make([]*Input, 0, len(tfmodule.Variables))
 
 	for _, input := range tfmodule.Variables {
+		comments := loadComments(input.Pos.Filename, input.Pos.Line)
+
+		// Skip over inputs that are marked as being ignored
+		if strings.Contains(comments, "terraform-docs-ignore") {
+			continue
+		}
+
 		// convert CRLF to LF early on (https://github.com/terraform-docs/terraform-docs/issues/305)
 		inputDescription := strings.ReplaceAll(input.Description, "\r\n", "\n")
 		if inputDescription == "" && config.Settings.ReadComments {
-			inputDescription = loadComments(input.Pos.Filename, input.Pos.Line)
+			inputDescription = comments
 		}
 
 		i := &Input{
diff --git a/terraform/testdata/full-example/variables.tf b/terraform/testdata/full-example/variables.tf
@@ -28,3 +28,9 @@ variable "G" {
   description = "G description"
   default     = null
 }
+
+# terraform-docs-ignore
+variable "H" {
+  description = "H description"
+  default = null
+}
