Always convert CRLF to LF for output description

khos2ow · khos2ow · commit e72f215e3e97 · 2022-01-07T19:09:55.000-05:00
Signed-off-by: Khosrow Moossavi &lt;khos2ow@gmail.com&gt;
diff --git a/.editorconfig b/.editorconfig
@@ -40,5 +40,8 @@ trim_trailing_whitespace = false
 [**/inputs-crlf/variables.tf]
 end_of_line = crlf
 
+[**/outputs-crlf/outputs.tf]
+end_of_line = crlf
+
 [Makefile]
 indent_style = tab
diff --git a/terraform/load.go b/terraform/load.go
@@ -278,7 +278,8 @@ func loadOutputs(tfmodule *tfconfig.Module, config *print.Config) ([]*Output, er
 		}
 	}
 	for _, o := range tfmodule.Outputs {
-		description := o.Description
+		// convert CRLF to LF early on (https://github.com/terraform-docs/terraform-docs/issues/584)
+		description := strings.ReplaceAll(o.Description, "\r\n", "\n")
 		if description == "" && config.Settings.ReadComments {
 			description = loadComments(o.Pos.Filename, o.Pos.Line)
 		}
diff --git a/terraform/load_test.go b/terraform/load_test.go
@@ -618,6 +618,37 @@ func TestLoadOutputs(t *testing.T) {
 	}
 }
 
+func TestLoadOutputsLineEnding(t *testing.T) {
+	tests := []struct {
+		name     string
+		path     string
+		expected string
+	}{
+		{
+			name:     "load module outputs from file with lf line ending",
+			path:     "outputs-lf",
+			expected: "The quick brown fox jumps\nover the lazy dog\n",
+		},
+		{
+			name:     "load module outputs from file with crlf line ending",
+			path:     "outputs-crlf",
+			expected: "The quick brown fox jumps\nover the lazy dog\n",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert := assert.New(t)
+
+			config := print.NewConfig()
+			module, _ := loadModule(filepath.Join("testdata", tt.path))
+			outputs, _ := loadOutputs(module, config)
+
+			assert.Equal(1, len(outputs))
+			assert.Equal(tt.expected, string(outputs[0].Description))
+		})
+	}
+}
+
 func TestLoadOutputsValues(t *testing.T) {
 	type expected struct {
 		outputs int
diff --git a/terraform/testdata/inputs-crlf/variables.tf b/terraform/testdata/inputs-crlf/variables.tf
@@ -1,4 +1,4 @@
-variable "multi-line-lf" {
+variable "multi-line-crlf" {
   type = string
   description = <<-EOT
   The quick brown fox jumps
diff --git a/terraform/testdata/inputs-lf/variables.tf b/terraform/testdata/inputs-lf/variables.tf
@@ -1,4 +1,4 @@
-variable "multi-line-crlf" {
+variable "multi-line-lf" {
   type = string
   description = <<-EOT
   The quick brown fox jumps
diff --git a/terraform/testdata/outputs-crlf/outputs.tf b/terraform/testdata/outputs-crlf/outputs.tf
@@ -0,0 +1,7 @@
+output "multi-line-crlf" {
+  value = "foo"
+  description = <<-EOT
+  The quick brown fox jumps
+  over the lazy dog
+  EOT
+}
diff --git a/terraform/testdata/outputs-lf/outputs.tf b/terraform/testdata/outputs-lf/outputs.tf
@@ -0,0 +1,7 @@
+output "multi-line-lf" {
+  value = "foo"
+  description = <<-EOT
+  The quick brown fox jumps
+  over the lazy dog
+  EOT
+}

Original file line number	Diff line number	Diff line change
`@@ -278,7 +278,8 @@ func loadOutputs(tfmodule tfconfig.Module, config print.Config) ([]*Output, er`
`278`	`278`	`}`
`279`	`279`	`}`
`280`	`280`	`for _, o := range tfmodule.Outputs {`
`281`		`- description := o.Description`
	`281`	`+ // convert CRLF to LF early on (https://github.com/terraform-docs/terraform-docs/issues/584)`
	`282`	`+ description := strings.ReplaceAll(o.Description, "\r\n", "\n")`
`282`	`283`	`if description == "" && config.Settings.ReadComments {`
`283`	`284`	`description = loadComments(o.Pos.Filename, o.Pos.Line)`
`284`	`285`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-variable "multi-line-lf" {`
	`1`	`+variable "multi-line-crlf" {`
`2`	`2`	`type = string`
`3`	`3`	`description = <<-EOT`
`4`	`4`	`The quick brown fox jumps`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-variable "multi-line-crlf" {`
	`1`	`+variable "multi-line-lf" {`
`2`	`2`	`type = string`
`3`	`3`	`description = <<-EOT`
`4`	`4`	`The quick brown fox jumps`