feat: TF-25532: Recognize tfcomponent.hcl extension (#1977)

* feat: TF-25532: Recognize tfcomponent.hcl extension

* feat: TF-25532: Added: changelog

* Update changelog message

Co-authored-by: James Pogran <[email protected]>

* feat: TF-25532: Refactored: order of stack file names

* feat: TF-25532: Fixed: documentation regarding language id and supported file names

* feat: TF-25532: Modified: bumped hcl-lang version

* Revert "feat: TF-25532: Modified: bumped hcl-lang version"

This reverts commit 914a3c9.

* feat: TF-25532: Modified: bumped terraform-schema version

* feat: TF-25532: Modified: bumped terraform-schema and hcl-lang version

* feat: TF-25532: Modified: bumped terraform-schema version

---------

Co-authored-by: Anubhav Goel <[email protected]>
Co-authored-by: James Pogran <[email protected]>

Author: 3 people

.changes/unreleased/ENHANCEMENTS-20250602-105745.yaml

@@ -0,0 +1,6 @@
+kind: ENHANCEMENTS
+body: 'Support new Terraform Stacks tfcomponent.hcl extension'
+time: 2025-06-02T10:57:45.782842+05:30
+custom:
+    Issue: "1977"
+    Repository: terraform-ls

docs/USAGE.md

@@ -8,7 +8,7 @@ The following filetypes are supported by the Terraform Language Server:
 
 - `terraform` - standard `*.tf` config files
 - `terraform-vars` - variable files (`*.tfvars`)
-- `terraform-stack` - standard `*.tfstack.hcl` files
+- `terraform-stack` - standard `*.tfcomponent.hcl` and `*.tfstack.hcl` files
 - `terraform-deploy` - standard `*.tfdeploy.hcl` files
 
 _NOTE:_ Clients should be configured to follow the above language ID conventions

docs/architecture.md

@@ -59,7 +59,7 @@ We currently have several features:
 - `*.tf` and `*.tf.json` files are handled in the `modules` feature
 - `*.tfvars` and `*.tfvars.json` files are handled in the `variables` feature
 - `.terraform/` and `.terraform.lock.hcl` related operations are handled in the `rootmodules` feature
-- `*.tfstack.hcl` and `*.tfdeploy.hcl` files are handled in the `stacks` feature
+- `*.tfcomponent.hcl`, `*.tfstack.hcl` and `*.tfdeploy.hcl` files are handled in the `stacks` feature
 
 A feature can provide data to the external consumers through methods. For example, the `variables` feature needs a list of variables from the `modules` feature. There should be no direct import from feature packages (we could enforce this by using `internal/`, but we won't for now) into other parts of the codebase. The "hot path" service mentioned above takes care of initializing each feature at the start of a new LS session.
 
@@ -92,12 +92,12 @@ The `jobs` package of each feature contains all the different indexing jobs need
 
 ### Stack Feature Jobs
 
-- `ParseStackConfiguration` - parses `*.tfstack.hcl` and `*.tfdeploy.hcl` files to turn `[]byte` into `hcl` types (AST)
+- `ParseStackConfiguration` - parses `*.tfcomponent.hcl`, `*.tfstack.hcl` and `*.tfdeploy.hcl` files to turn `[]byte` into `hcl` types (AST)
 - `LoadStackMetadata` - uses [`earlydecoder`](https://pkg.go.dev/github.com/hashicorp/terraform-schema@main/stacks/earlydecoder) to do early TF version-agnostic decoding to obtain metadata (variables, outputs etc.) which can be used to do more detailed decoding in hot-path within `hcl-lang` decoder
 - `PreloadEmbeddedSchema` – loads provider schemas based on provider requirements from the bundled schemas
-- `DecodeReferenceTargets` - uses `hcl-lang` decoder to collect reference targets within `*.tfstack.hcl` and `*.tfdeploy.hcl`
-- `DecodeReferenceOrigins` - uses `hcl-lang` decoder to collect reference origins within `*.tfstack.hcl` and `*.tfdeploy.hcl`
-- `SchemaStackValidation` - does schema-based validation of module files (`*.tfstack.hcl` and `*.tfdeploy.hcl`) and produces diagnostics associated with any "invalid" parts of code
+- `DecodeReferenceTargets` - uses `hcl-lang` decoder to collect reference targets within `*.tfcomponent.hcl`, `*.tfstack.hcl` and `*.tfdeploy.hcl`
+- `DecodeReferenceOrigins` - uses `hcl-lang` decoder to collect reference origins within `*.tfcomponent.hcl`, `*.tfstack.hcl` and `*.tfdeploy.hcl`
+- `SchemaStackValidation` - does schema-based validation of module files (`*.tfcomponent.hcl`, `*.tfstack.hcl` and `*.tfdeploy.hcl`) and produces diagnostics associated with any "invalid" parts of code
 - `ReferenceValidation` - does validation based on (mis)matched reference origins and targets, to flag up "orphaned" references
 
 ### Adding a new feature / "language"

docs/language-clients.md

@@ -8,8 +8,8 @@ The following file types are currently supported and language IDs expected:
 
 - `terraform` - standard `*.tf` config files
 - `terraform-vars` - variable files (`*.tfvars`)
-- `terraform-stack` - standard `*.tfstack.hcl` files
-- `terraform-deploy` - standard `*.tfstack.hcl` files
+- `terraform-stack` - standard `*.tfcomponent.hcl` and `*.tfstack.hcl` files
+- `terraform-deploy` - standard `*.tfdeploy.hcl` files
 
 Client can choose to highlight other files locally, but such other files
 must **not** be send to the server as the server isn't equipped to handle those.
@@ -46,7 +46,7 @@ This allows IntelliSense to remain accurate e.g. when switching branches in VCS
 or when there are any other changes made to these files outside the editor.
 
 If the client implements file watcher, it should watch for any changes
-in `**/*.tf`, `**/*.tfvars`, `**/*.tfstack.hcl` and `**/*.tfstack.hcl` files in the workspace.
+in `**/*.tf`, `**/*.tfvars`, `*.tfstack.hcl`, `**/*.tfstack.hcl` and `**/*.tfstack.hcl` files in the workspace.
 
 Client should **not** send changes for any other files.
 

go.mod

@@ -14,12 +14,12 @@ require (
 	github.com/hashicorp/go-uuid v1.0.3
 	github.com/hashicorp/go-version v1.7.0
 	github.com/hashicorp/hc-install v0.9.2
-	github.com/hashicorp/hcl-lang v0.0.0-20250117153936-66cdc97e9d3b
+	github.com/hashicorp/hcl-lang v0.0.0-20250613065305-ef4e1a57cead
 	github.com/hashicorp/hcl/v2 v2.23.0
 	github.com/hashicorp/terraform-exec v0.23.0
 	github.com/hashicorp/terraform-json v0.25.0
-	github.com/hashicorp/terraform-registry-address v0.2.5
-	github.com/hashicorp/terraform-schema v0.0.0-20250117153811-3c4991466f2c
+	github.com/hashicorp/terraform-registry-address v0.3.0
+	github.com/hashicorp/terraform-schema v0.0.0-20250616115602-34f2164294a0
 	github.com/mcuadros/go-defaults v1.2.0
 	github.com/mh-cbon/go-fmt-fail v0.0.0-20160815164508-67765b3fbcb5
 	github.com/mitchellh/cli v1.1.5

go.sum

@@ -116,18 +116,20 @@ github.com/hashicorp/golang-lru v0.5.4 h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+l
 github.com/hashicorp/golang-lru v0.5.4/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4=
 github.com/hashicorp/hc-install v0.9.2 h1:v80EtNX4fCVHqzL9Lg/2xkp62bbvQMnvPQ0G+OmtO24=
 github.com/hashicorp/hc-install v0.9.2/go.mod h1:XUqBQNnuT4RsxoxiM9ZaUk0NX8hi2h+Lb6/c0OZnC/I=
-github.com/hashicorp/hcl-lang v0.0.0-20250117153936-66cdc97e9d3b h1:JWLbh10Hji/SYrBGwaWmvmqvbbOxQzuFZ0CplYCwCM4=
-github.com/hashicorp/hcl-lang v0.0.0-20250117153936-66cdc97e9d3b/go.mod h1:7aFvdIfHocBadjQ6j5RbxV0rSEasCPj0RTj/ujGCmi8=
+github.com/hashicorp/hcl-lang v0.0.0-20250613065305-ef4e1a57cead h1:Nthdz3YLW98zGxDKgkBj6lTXWKhp1tWDg8ecyLkYe94=
+github.com/hashicorp/hcl-lang v0.0.0-20250613065305-ef4e1a57cead/go.mod h1:lUY+oHKrbuViZqM+HHqmKE/18umUBPLAIoVT0WSZjKE=
 github.com/hashicorp/hcl/v2 v2.23.0 h1:Fphj1/gCylPxHutVSEOf2fBOh1VE4AuLV7+kbJf3qos=
 github.com/hashicorp/hcl/v2 v2.23.0/go.mod h1:62ZYHrXgPoX8xBnzl8QzbWq4dyDsDtfCRgIq1rbJEvA=
 github.com/hashicorp/terraform-exec v0.23.0 h1:MUiBM1s0CNlRFsCLJuM5wXZrzA3MnPYEsiXmzATMW/I=
 github.com/hashicorp/terraform-exec v0.23.0/go.mod h1:mA+qnx1R8eePycfwKkCRk3Wy65mwInvlpAeOwmA7vlY=
 github.com/hashicorp/terraform-json v0.25.0 h1:rmNqc/CIfcWawGiwXmRuiXJKEiJu1ntGoxseG1hLhoQ=
 github.com/hashicorp/terraform-json v0.25.0/go.mod h1:sMKS8fiRDX4rVlR6EJUMudg1WcanxCMoWwTLkgZP/vc=
-github.com/hashicorp/terraform-registry-address v0.2.5 h1:2GTftHqmUhVOeuu9CW3kwDkRe4pcBDq0uuK5VJngU1M=
-github.com/hashicorp/terraform-registry-address v0.2.5/go.mod h1:PpzXWINwB5kuVS5CA7m1+eO2f1jKb5ZDIxrOPfpnGkg=
-github.com/hashicorp/terraform-schema v0.0.0-20250117153811-3c4991466f2c h1:g/Y0BUI5Gk1hgMWcI5PpeXtvvmzvQruW6az0yPhFFKk=
-github.com/hashicorp/terraform-schema v0.0.0-20250117153811-3c4991466f2c/go.mod h1:+fQEDxf+c6PnG7/3ZF26K69zWLnIp/uTmsMffCsuw6o=
+github.com/hashicorp/terraform-registry-address v0.3.0 h1:HMpK3nqaGFPS9VmgRXrJL/dzHNdheGVKk5k7VlFxzCo=
+github.com/hashicorp/terraform-registry-address v0.3.0/go.mod h1:jRGCMiLaY9zii3GLC7hqpSnwhfnCN5yzvY0hh4iCGbM=
+github.com/hashicorp/terraform-schema v0.0.0-20250616093749-5d8128deffd1 h1:6ncaZLzLWeXs9J++HtPoJpwg3ZJ4mDEFMqpj3ol9ehc=
+github.com/hashicorp/terraform-schema v0.0.0-20250616093749-5d8128deffd1/go.mod h1:si3wjikcavAEF1QIx+p+tk5EvVubBpzu9sl8YasITTs=
+github.com/hashicorp/terraform-schema v0.0.0-20250616115602-34f2164294a0 h1:fpu271clSg0mDkfy7CYr1fs3ntT9AEioutKZR5r1n2s=
+github.com/hashicorp/terraform-schema v0.0.0-20250616115602-34f2164294a0/go.mod h1:si3wjikcavAEF1QIx+p+tk5EvVubBpzu9sl8YasITTs=
 github.com/hashicorp/terraform-svchost v0.1.1 h1:EZZimZ1GxdqFRinZ1tpJwVxxt49xc/S52uzrw4x0jKQ=
 github.com/hashicorp/terraform-svchost v0.1.1/go.mod h1:mNsjQfZyf/Jhz35v6/0LWcv26+X7JPS+buii2c9/ctc=
 github.com/hexops/autogold v1.3.1 h1:YgxF9OHWbEIUjhDbpnLhgVsjUDsiHDTyDfy2lrfdlzo=

internal/features/stacks/ast/stacks.go

@@ -32,8 +32,11 @@ func (mf StackFilename) IsIgnored() bool {
 }
 
 func IsStackFilename(name string) bool {
-	return strings.HasSuffix(name, ".tfstack.hcl") ||
+	return strings.HasSuffix(name, ".tfcomponent.hcl") ||
+		strings.HasSuffix(name, ".tfcomponent.json") ||
+		strings.HasSuffix(name, ".tfstack.hcl") ||
 		strings.HasSuffix(name, ".tfstack.json")
+
 }
 
 // DeployFilename is a custom type for deployment files

internal/features/stacks/jobs/parse_stack.go

@@ -20,7 +20,7 @@ import (
 )
 
 // ParseStackConfiguration parses the whole Stack configuration,
-// i.e. turns bytes of `*.tfstack.hcl` & `*.tfdeploy.hcl` files into AST ([*hcl.File]).
+// i.e. turns bytes of `*.tfcomponent.hcl`, `*.tfstack.hcl` & `*.tfdeploy.hcl` files into AST ([*hcl.File]).
 func ParseStackConfiguration(ctx context.Context, fs ReadOnlyFS, stackStore *state.StackStore, stackPath string) error {
 	record, err := stackStore.StackRecordByPath(stackPath)
 	if err != nil {

internal/features/stacks/jobs/parse_test.go

@@ -20,6 +20,21 @@ import (
 )
 
 func TestParseStackConfiguration(t *testing.T) {
+	runTestParseStackConfiguration(t, struct {
+		folderName string
+		extension  string
+	}{folderName: "simple-stack", extension: "tfcomponent.hcl"})
+
+	runTestParseStackConfiguration(t, struct {
+		folderName string
+		extension  string
+	}{folderName: "simple-stack-legacy-extension", extension: "tfstack.hcl"})
+}
+
+func runTestParseStackConfiguration(t *testing.T, tc struct {
+	folderName string
+	extension  string
+}) {
 	ctx := context.Background()
 	gs, err := globalState.NewStateStore()
 	if err != nil {
@@ -36,7 +51,7 @@ func TestParseStackConfiguration(t *testing.T) {
 	}
 	testFs := filesystem.NewFilesystem(gs.DocumentStore)
 
-	simpleStackPath := filepath.Join(testData, "simple-stack")
+	simpleStackPath := filepath.Join(testData, tc.folderName)
 
 	err = ss.Add(simpleStackPath)
 	if err != nil {
@@ -58,7 +73,7 @@ func TestParseStackConfiguration(t *testing.T) {
 	ctx = job.WithIgnoreState(ctx, true)
 
 	// say we're coming from did_change request
-	componentsURI, err := filepath.Abs(filepath.Join(simpleStackPath, "components.tfstack.hcl"))
+	componentsURI, err := filepath.Abs(filepath.Join(simpleStackPath, "components."+tc.extension))
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -78,24 +93,24 @@ func TestParseStackConfiguration(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	componentsFile := ast.StackFilename("components.tfstack.hcl")
-	// test if components.tfstack.hcl is not the same as first seen
+	componentsFile := ast.StackFilename("components." + tc.extension)
+	// test if components.tfstack.hcl / components.tfcomponent.hcl is not the same as first seen
 	if before.ParsedFiles[componentsFile] == after.ParsedFiles[componentsFile] {
 		t.Fatal("file should mismatch")
 	}
 
-	variablesFile := ast.StackFilename("variables.tfstack.hcl")
-	// test if variables.tfstack.hcl is the same as first seen
+	variablesFile := ast.StackFilename("variables." + tc.extension)
+	// test if variables.tfstack.hcl / variables.tfcomponent.hcl is the same as first seen
 	if before.ParsedFiles[variablesFile] != after.ParsedFiles[variablesFile] {
 		t.Fatal("file mismatch")
 	}
 
-	// examine diags should change for components.tfstack.hcl
+	// examine diags should change for components.tfstack.hcl / components.tfcomponent.hcl
 	if before.Diagnostics[globalAst.HCLParsingSource][componentsFile][0] == after.Diagnostics[globalAst.HCLParsingSource][componentsFile][0] {
 		t.Fatal("diags should mismatch")
 	}
 
-	// examine diags should not change for variables.tfstack.hcl
+	// examine diags should not change for variables.tfstack.hcl / variables.tfcomponent.hcl
 	if before.Diagnostics[globalAst.HCLParsingSource][variablesFile][0] != after.Diagnostics[globalAst.HCLParsingSource][variablesFile][0] {
 		t.Fatal("diags should match")
 	}

internal/features/stacks/jobs/schema_test.go

@@ -25,6 +25,13 @@ import (
 )
 
 func TestPreloadEmbeddedSchema_basic(t *testing.T) {
+	runTestPreloadEmbeddedSchema_basic(t, struct{ extension string }{extension: "tfstack.hcl"})
+	runTestPreloadEmbeddedSchema_basic(t, struct{ extension string }{extension: "tfcomponent.hcl"})
+}
+
+func runTestPreloadEmbeddedSchema_basic(t *testing.T, tc struct {
+	extension string
+}) {
 	ctx := context.Background()
 	dataDir := "data"
 	schemasFS := fstest.MapFS{
@@ -52,10 +59,10 @@ func TestPreloadEmbeddedSchema_basic(t *testing.T) {
 		// These are somewhat awkward double entries
 		// to account for io/fs and our own path separator differences
 		// See https://github.com/hashicorp/terraform-ls/issues/1025
-		stackPath + "/providers.tfstack.hcl": &fstest.MapFile{
+		stackPath + "/providers." + tc.extension: &fstest.MapFile{
 			Data: []byte{},
 		},
-		filepath.Join(stackPath, "providers.tfstack.hcl"): &fstest.MapFile{
+		filepath.Join(stackPath, "providers."+tc.extension): &fstest.MapFile{
 			Data: []byte(`required_providers {
 	random = {
 		source = "hashicorp/random"
@@ -105,6 +112,13 @@ func TestPreloadEmbeddedSchema_basic(t *testing.T) {
 }
 
 func TestPreloadEmbeddedSchema_unknownProviderOnly(t *testing.T) {
+	runTestPreloadEmbeddedSchema_unknownProviderOnly(t, struct{ extension string }{extension: "tfstack.hcl"})
+	runTestPreloadEmbeddedSchema_unknownProviderOnly(t, struct{ extension string }{extension: "tfextension.hcl"})
+}
+
+func runTestPreloadEmbeddedSchema_unknownProviderOnly(t *testing.T, tc struct {
+	extension string
+}) {
 	ctx := context.Background()
 	dataDir := "data"
 	schemasFS := fstest.MapFS{
@@ -125,10 +139,10 @@ func TestPreloadEmbeddedSchema_unknownProviderOnly(t *testing.T) {
 		// These are somewhat awkward double entries
 		// to account for io/fs and our own path separator differences
 		// See https://github.com/hashicorp/terraform-ls/issues/1025
-		stackPath + "/providers.tfstack.hcl": &fstest.MapFile{
+		stackPath + "/providers." + tc.extension: &fstest.MapFile{
 			Data: []byte{},
 		},
-		filepath.Join(stackPath, "providers.tfstack.hcl"): &fstest.MapFile{
+		filepath.Join(stackPath, "providers."+tc.extension): &fstest.MapFile{
 			Data: []byte(`required_providers {
 	unknown = {
 		source = "hashicorp/unknown"
@@ -160,6 +174,13 @@ func TestPreloadEmbeddedSchema_unknownProviderOnly(t *testing.T) {
 }
 
 func TestPreloadEmbeddedSchema_idempotency(t *testing.T) {
+	runTestPreloadEmbeddedSchema_idempotency(t, struct{ extension string }{extension: "tfstack.hcl"})
+	runTestPreloadEmbeddedSchema_idempotency(t, struct{ extension string }{extension: "tfcomponent.hcl"})
+}
+
+func runTestPreloadEmbeddedSchema_idempotency(t *testing.T, tc struct {
+	extension string
+}) {
 	ctx := context.Background()
 	dataDir := "data"
 	schemasFS := fstest.MapFS{
@@ -187,10 +208,10 @@ func TestPreloadEmbeddedSchema_idempotency(t *testing.T) {
 		// These are somewhat awkward two entries
 		// to account for io/fs and our own path separator differences
 		// See https://github.com/hashicorp/terraform-ls/issues/1025
-		stackPath + "/providers.tfstack.hcl": &fstest.MapFile{
+		stackPath + "/providers." + tc.extension: &fstest.MapFile{
 			Data: []byte{},
 		},
-		filepath.Join(stackPath, "providers.tfstack.hcl"): &fstest.MapFile{
+		filepath.Join(stackPath, "providers."+tc.extension): &fstest.MapFile{
 			Data: []byte(`required_providers {
 	random = {
 		source = "hashicorp/random"
@@ -242,6 +263,13 @@ func TestPreloadEmbeddedSchema_idempotency(t *testing.T) {
 }
 
 func TestPreloadEmbeddedSchema_raceCondition(t *testing.T) {
+	runTestPreloadEmbeddedSchema_raceCondition(t, struct{ extension string }{extension: "tfstack.hcl"})
+	runTestPreloadEmbeddedSchema_raceCondition(t, struct{ extension string }{extension: "tfcomponent.hcl"})
+}
+
+func runTestPreloadEmbeddedSchema_raceCondition(t *testing.T, tc struct {
+	extension string
+}) {
 	ctx := context.Background()
 	dataDir := "data"
 	schemasFS := fstest.MapFS{
@@ -269,10 +297,10 @@ func TestPreloadEmbeddedSchema_raceCondition(t *testing.T) {
 		// These are somewhat awkward two entries
 		// to account for io/fs and our own path separator differences
 		// See https://github.com/hashicorp/terraform-ls/issues/1025
-		stackPath + "/providers.tfstack.hcl": &fstest.MapFile{
+		stackPath + "/providers." + tc.extension: &fstest.MapFile{
 			Data: []byte{},
 		},
-		filepath.Join(stackPath, "providers.tfstack.hcl"): &fstest.MapFile{
+		filepath.Join(stackPath, "providers."+tc.extension): &fstest.MapFile{
 			Data: []byte(`required_providers {
 	random = {
 		source = "hashicorp/random"