wip

bundle/artifacts/expand_globs.go

@@ -32,8 +32,12 @@ func createGlobError(v dyn.Value, p dyn.Path, message string) diag.Diagnostic {
 	return diag.Diagnostic{
 		Severity: diag.Error,
 		Summary:  fmt.Sprintf("%s: %s", source, message),
-		Locations: []dyn.Location{v.Location()},
-		Paths:     []dyn.Path{p},
+		LocationPathPairs: []diag.LocationPathPair{
+			{
+				L: v.Location(),
+				P: p,
+			},
+		},
 	}
 }
 

bundle/config/loader/process_include.go

@@ -107,18 +107,16 @@ func validateSingleResourceDefined(configRoot dyn.Value, ext, typ string) diag.D
 		detail.WriteString(l)
 	}
 
-	locations := []dyn.Location{}
-	paths := []dyn.Path{}
+	// TODO: test this.
+	locationPathPairs := []diag.LocationPathPair{}
 	for _, rr := range resources {
-		locations = append(locations, rr.value.Locations()...)
-		paths = append(paths, rr.path)
+		for _, l := range rr.value.Locations() {
+			locationPathPairs = append(locationPathPairs, diag.LocationPathPair{L: l, P: rr.path})
 		}
-	// Sort the locations and paths to make the output deterministic.
-	sort.Slice(locations, func(i, j int) bool {
-		return locations[i].String() < locations[j].String()
-	})
-	sort.Slice(paths, func(i, j int) bool {
-		return paths[i].String() < paths[j].String()
+	}
+	// Sort the location-path pairs to make the output deterministic.
+	sort.Slice(locationPathPairs, func(i, j int) bool {
+		return locationPathPairs[i].L.String() < locationPathPairs[j].L.String()
 	})
 
 	return diag.Diagnostics{
@@ -126,8 +124,7 @@ func validateSingleResourceDefined(configRoot dyn.Value, ext, typ string) diag.D
 			Severity:          diag.Recommendation,
 			Summary:           fmt.Sprintf("define a single %s in a file with the %s extension.", strings.ReplaceAll(typ, "_", " "), ext),
 			Detail:            detail.String(),
-			Locations: locations,
-			Paths:     paths,
+			LocationPathPairs: locationPathPairs,
 		},
 	}
 }

libs/cmdio/render.go

@@ -420,12 +420,23 @@ const warningTemplate = `{{ "Warning" | yellow }}: {{ .Summary }}
 
 `
 
+// const recommendationTemplate = `{{ "Recommendation" | blue }}: {{ .Summary }}
+// {{- range $index, $element := .Paths }}
+//   {{ if eq $index 0 }}at {{else}}   {{ end}}{{ $element.String | green }}
+// {{- end }}
+// {{- range $index, $element := .Locations }}
+//   {{ if eq $index 0 }}in {{else}}   {{ end}}{{ $element.String | cyan }}
+// {{- end }}
+// {{- if .Detail }}
+
+// {{ .Detail }}
+// {{- end }}
+
+// `
+
 const recommendationTemplate = `{{ "Recommendation" | blue }}: {{ .Summary }}
-{{- range $index, $element := .Paths }}
-  {{ if eq $index 0 }}at {{else}}   {{ end}}{{ $element.String | green }}
-{{- end }}
-{{- range $index, $element := .Locations }}
-  {{ if eq $index 0 }}in {{else}}   {{ end}}{{ $element.String | cyan }}
+{{- range $index, $element := .LocationPathPairs}}
+  {{ if eq $index 0 }}at {{else}}   {{ end}}{{ $element.L.String | green }} in {{ $element.P.String | cyan }}
 {{- end }}
 {{- if .Detail }}
 

libs/diag/diagnostic.go

@@ -7,6 +7,15 @@ import (
 	"github.com/databricks/cli/libs/dyn"
 )
 
+// Convenience struct for retaining a 1:1 mapping between locations and paths.
+type LocationPathPair struct {
+	// Locations are the source code locations associated with the diagnostic message.
+	L dyn.Location
+
+	// Paths are paths to the values in the configuration tree that the diagnostic is associated with.
+	P dyn.Path
+}
+
 type Diagnostic struct {
 	Severity Severity
 
@@ -18,11 +27,13 @@ type Diagnostic struct {
 	// This may be multiple lines and may be nil.
 	Detail string
 
-	// Locations are the source code locations associated with the diagnostic message.
+	// LocationPathPairs are the source code locations and paths associated with the diagnostic message.
+	// It may be empty if there are no associated locations and paths.
+	LocationPathPairs []LocationPathPair
+
 	// It may be empty if there are no associated locations.
 	Locations []dyn.Location
 
-	// Paths are paths to the values in the configuration tree that the diagnostic is associated with.
 	// It may be nil if there are no associated paths.
 	Paths []dyn.Path