Method ToPackageOverrideString

pkg/packages/packages.go:192–216

ToPackageOverrideString converts the struct back into a string which the server can parse e.g. StepName:Version. This is the inverse of ParsePackageOverrideString

()

// ToPackageOverrideString converts the struct back into a string which the server can parse e.g. StepName:Version.
// This is the inverse of ParsePackageOverrideString
func (p *PackageVersionOverride) ToPackageOverrideString() string {
	components := make([]string, 0, 3)

	// stepNameOrPackageID always comes first if we have it; escape delimiter chars so the server can parse correctly
	if p.PackageID != "" {
		components = append(components, escapePackageDelimiters(p.PackageID))
	} else if p.ActionName != "" { // can't have both PackageID and ActionName; PackageID wins
		components = append(components, escapePackageDelimiters(p.ActionName))
	}

	// followed by package reference name if we have it
	if p.PackageReferenceName != "" {
		if len(components) == 0 { // if we have an explicit packagereference but no packageId or action, we need to express it with *:ref:version
			components = append(components, "*")
		}
		components = append(components, escapePackageDelimiters(p.PackageReferenceName))
	}

	if len(components) == 0 { // the server can't deal with just a number by itself; if we want to override everything we must pass *:Version
		components = append(components, "*")
	}
	components = append(components, p.Version)

	return strings.Join(components, ":")
}

// splitPackageOverrideString splits the input string into components based on delimiter characters (:, /, =).
// A backslash escapes the next char only when that char is one of : / = \ ; any other "\X" sequence is preserved