Add range to terraform_required_version errors

Author: rdimartino

rules/terraform_required_version.go

@@ -1,6 +1,9 @@
 package rules
 
 import (
+	"path/filepath"
+	"strings"
+
 	"github.com/hashicorp/hcl/v2"
 	"github.com/terraform-linters/tflint-plugin-sdk/hclext"
 	"github.com/terraform-linters/tflint-plugin-sdk/tflint"
@@ -78,13 +81,57 @@ func (r *TerraformRequiredVersionRule) Check(runner tflint.Runner) error {
 		exists = exists || ok
 	}
 
-	if !exists {
-		return runner.EmitIssue(
-			r,
-			`terraform "required_version" attribute is required`,
-			hcl.Range{},
-		)
+	if exists {
+		return nil
+	}
+
+	var missingRange hcl.Range
+
+	if len(body.Blocks) > 0 {
+		missingRange = body.Blocks[0].DefRange
+	} else {
+		// If there are no "terraform" blocks, create a hcl.Range for the files
+
+		// Find the directory common to all files
+		var commonPath []string
+		first := true
+		for filename := range files {
+			parts := strings.Split(filename, string(filepath.Separator))
+
+			if first {
+				commonPath = parts
+				first = false
+				continue
+			}
+
+			// If parts is shorter, truncate commonPath proactively
+			if len(parts) < len(commonPath) {
+				commonPath = commonPath[:len(parts)]
+			}
+
+			for i := 0; i < len(commonPath); i++ {
+				if commonPath[i] != parts[i] {
+					// Truncate the common path at the point where it diverges
+					commonPath = commonPath[:i]
+					break
+				}
+			}
+		}
+
+		// If the result is a directory, append an empty string to get a trailing slash in the output
+		if len(files) > 1 {
+			commonPath = append(commonPath, "")
+		}
+
+		missingRange = hcl.Range{
+			// If there are multiple files, this will be a directory name
+			Filename: strings.Join(commonPath, string(filepath.Separator)),
+		}
 	}
 
-	return nil
+	return runner.EmitIssue(
+		r,
+		`terraform "required_version" attribute is required`,
+		missingRange,
+	)
 }

rules/terraform_required_version_test.go

@@ -3,6 +3,7 @@ package rules
 import (
 	"testing"
 
+	"github.com/hashicorp/hcl/v2"
 	"github.com/terraform-linters/tflint-plugin-sdk/helper"
 )
 
@@ -25,6 +26,17 @@ terraform {}
 				{
 					Rule:    NewTerraformRequiredVersionRule(),
 					Message: "terraform \"required_version\" attribute is required",
+					Range: hcl.Range{
+						Filename: "module.tf",
+						Start: hcl.Pos{
+							Line:   2,
+							Column: 1,
+						},
+						End: hcl.Pos{
+							Line:   2,
+							Column: 10,
+						},
+					},
 				},
 			},
 		},
@@ -53,6 +65,23 @@ terraform {
 `,
 			Expected: helper.Issues{},
 		},
+		{
+			Name: "no terraform block",
+			Content: `
+locals {
+	foo = "bar"
+}
+`,
+			Expected: helper.Issues{
+				{
+					Rule:    NewTerraformRequiredVersionRule(),
+					Message: "terraform \"required_version\" attribute is required",
+					Range: hcl.Range{
+						Filename: "module.tf",
+					},
+				},
+			},
+		},
 	}
 
 	rule := NewTerraformRequiredVersionRule()
@@ -73,3 +102,30 @@ terraform {
 		})
 	}
 }
+
+func Test_TerraformRequiredVersionRuleMultipleFiles(t *testing.T) {
+	rule := NewTerraformRequiredVersionRule()
+
+	t.Run("multiple files no terraform blocks", func(t *testing.T) {
+		files := map[string]string{
+			"modules/foo/bar/other.tf": "",
+			"modules/foo/outputs.tf":   "",
+			"modules/foo/main.tf":      "",
+			"modules/foo/variables.tf": "",
+		}
+		runner := helper.TestRunner(t, files)
+		if err := rule.Check(runner); err != nil {
+			t.Fatal(err)
+		}
+
+		helper.AssertIssues(t, helper.Issues{
+			{
+				Rule:    NewTerraformRequiredVersionRule(),
+				Message: "terraform \"required_version\" attribute is required",
+				Range: hcl.Range{
+					Filename: "modules/foo/",
+				},
+			},
+		}, runner.Issues)
+	})
+}