Add each.* hover data (#148)

This adds hover data support for `each.key` and `each.value`

Author: jpogran

decoder/decoder.go

@@ -248,3 +248,17 @@ func foreachEachCandidate(editRng hcl.Range) []lang.Candidate {
 		},
 	}
 }
+
+func eachKeyHoverData(rng hcl.Range) *lang.HoverData {
+	return &lang.HoverData{
+		Content: lang.Markdown("`each.key` _string_\n\nThe map key (or set member) corresponding to this instance"),
+		Range:   rng,
+	}
+}
+
+func eachValueHoverData(rng hcl.Range) *lang.HoverData {
+	return &lang.HoverData{
+		Content: lang.Markdown("`each.value` _any type_\n\nThe map value corresponding to this instance. (If a set was provided, this is the same as `each.key`.)"),
+		Range:   rng,
+	}
+}

decoder/hover.go

@@ -258,15 +258,17 @@ func (d *PathDecoder) hoverDataForExpr(ctx context.Context, expr hcl.Expression,
 		if err != nil {
 			return nil, err
 		}
-		if address.Equals(lang.Address{
-			lang.RootStep{
-				Name: "count",
-			},
-			lang.AttrStep{
-				Name: "index",
-			},
-		}) && schema.ActiveCountFromContext(ctx) {
+
+		countIndexAddr := lang.Address{lang.RootStep{Name: "count"}, lang.AttrStep{Name: "index"}}
+		eachKeyAddr := lang.Address{lang.RootStep{Name: "each"}, lang.AttrStep{Name: "key"}}
+		eachValueAddr := lang.Address{lang.RootStep{Name: "each"}, lang.AttrStep{Name: "value"}}
+
+		if address.Equals(countIndexAddr) && schema.ActiveCountFromContext(ctx) {
 			return countIndexHoverData(expr.Range()), nil
+		} else if address.Equals(eachKeyAddr) && schema.ActiveForEachFromContext(ctx) {
+			return eachKeyHoverData(expr.Range()), nil
+		} else if address.Equals(eachValueAddr) && schema.ActiveForEachFromContext(ctx) {
+			return eachValueHoverData(expr.Range()), nil
 		}
 
 		tes, ok := constraints.TraversalExprs()

decoder/hover_test.go

@@ -1155,13 +1155,13 @@ func TestDecoder_HoverAtPos_foreach_extension(t *testing.T) {
 	}
 }
 `,
-			hcl.Pos{Line: 5, Column: 16, Byte: 73},
+			hcl.Pos{Line: 2, Column: 8, Byte: 30},
 			&lang.HoverData{
-				Content: lang.Markdown("_map of dynamic_"),
+				Content: lang.Markdown("`each.key` _string_\n\nThe map key (or set member) corresponding to this instance"),
 				Range: hcl.Range{
 					Filename: "test.tf",
-					Start:    hcl.Pos{Line: 3, Column: 13, Byte: 50},
-					End:      hcl.Pos{Line: 6, Column: 3, Byte: 81},
+					Start:    hcl.Pos{Line: 2, Column: 8, Byte: 29},
+					End:      hcl.Pos{Line: 2, Column: 16, Byte: 37},
 				},
 			},
 		},
@@ -1200,13 +1200,13 @@ func TestDecoder_HoverAtPos_foreach_extension(t *testing.T) {
 	}
 }
 `,
-			hcl.Pos{Line: 5, Column: 16, Byte: 73},
+			hcl.Pos{Line: 2, Column: 8, Byte: 30},
 			&lang.HoverData{
-				Content: lang.Markdown("_map of dynamic_"),
+				Content: lang.Markdown("`each.value` _any type_\n\nThe map value corresponding to this instance. (If a set was provided, this is the same as `each.key`.)"),
 				Range: hcl.Range{
 					Filename: "test.tf",
-					Start:    hcl.Pos{Line: 3, Column: 13, Byte: 52},
-					End:      hcl.Pos{Line: 6, Column: 3, Byte: 83},
+					Start:    hcl.Pos{Line: 2, Column: 8, Byte: 29},
+					End:      hcl.Pos{Line: 2, Column: 18, Byte: 39},
 				},
 			},
 		},