Function FormatQuickInfo

internal/layergraph/format.go:307–370

FormatQuickInfo renders provider/requirer info as a JSDoc comment.

(
	c *checker.Checker,
	providersAndRequirers []ProviderRequirerInfo,
	sf *ast.SourceFile,
)

// FormatQuickInfo renders provider/requirer info as a JSDoc comment.
func FormatQuickInfo(
	c *checker.Checker,
	providersAndRequirers []ProviderRequirerInfo,
	sf *ast.SourceFile,
) string {
	if len(providersAndRequirers) == 0 {
		return ""
	}

	var providedItems, requiredItems []ProviderRequirerInfo
	for _, item := range providersAndRequirers {
		if item.Kind == ProviderRequirerKindProvided {
			providedItems = append(providedItems, item)
		} else {
			requiredItems = append(requiredItems, item)
		}
	}

	var textualExplanation []string

	appendInfo := func(item ProviderRequirerInfo) {
		typeName := getTypeDisplayName(c, item.Type)

		var positions []string
		for i, displayNode := range item.DisplayNodes {
			displaySourceFile := getNodeSourceFile(displayNode)
			nodeText := getNodeText(displayNode, displaySourceFile)
			nodeText = strings.ReplaceAll(nodeText, "\n", " ")
			if len(nodeText) > 50 {
				nodeText = nodeText[:50]
			}
			loc := formatLocation(displayNode, sf)
			// Intentional fix over .repos reference: the .repos version unconditionally
			// prepends "at " for the first display node, producing a double preposition
			// "provided at in file.ts at ln X col Y" for cross-file references. This
			// check skips the "at " prefix when the location already starts with "in ",
			// yielding the correct "provided in file.ts at ln X col Y".
			if !strings.HasPrefix(loc, "in ") {
				if i == 0 {
					loc = "at " + loc
				}
			}
			positions = append(positions, fmt.Sprintf("%s by `%s`", loc, nodeText))
		}

		textualExplanation = append(textualExplanation, fmt.Sprintf("- %s %s %s", typeName, item.Kind, strings.Join(positions, ", ")))
	}

	for _, item := range providedItems {
		appendInfo(item)
	}
	if len(providedItems) > 0 && len(requiredItems) > 0 {
		textualExplanation = append(textualExplanation, "")
	}
	for _, item := range requiredItems {
		appendInfo(item)
	}