minor contributors.go style changes

cstyan · cstyan · commit ed629c196ace · 2025-05-16T11:14:22.000-07:00
Signed-off-by: Callum Styan &lt;callumstyan@gmail.com&gt;
diff --git a/cmd/readmevalidation/contributors.go b/cmd/readmevalidation/contributors.go
@@ -35,7 +35,7 @@ type contributorProfileReadme struct {
 
 func validateContributorDisplayName(displayName string) error {
 	if displayName == "" {
-		return fmt.Errorf("missing display_name")
+		return errors.New("missing display_name")
 	}
 
 	return nil
@@ -53,17 +53,16 @@ func validateContributorLinkedinURL(linkedinURL *string) error {
 	return nil
 }
 
+// validateContributorSupportEmail does best effort validation of a contributors email address.	We can't 100% validate
+// that this is correct without actually sending an email, especially because some contributors are individual developers
+// and we don't want to do that on every single run of the CI pipeline. The best we can do is verify the general structure.
 func validateContributorSupportEmail(email *string) []error {
 	if email == nil {
 		return nil
 	}
 
 	errs := []error{}
 
-	// Can't 100% validate that this is correct without actually sending
-	// an email, and especially with some contributors being individual
-	// developers, we don't want to do that on every single run of the CI
-	// pipeline. Best we can do is verify the general structure
 	username, server, ok := strings.Cut(*email, "@")
 	if !ok {
 		errs = append(errs, fmt.Errorf("email address %q is missing @ symbol", *email))
@@ -113,21 +112,18 @@ func validateContributorStatus(status string) error {
 	return nil
 }
 
-// Can't validate the image actually leads to a valid resource in a pure
-// function, but can at least catch obvious problems
+// Can't validate the image actually leads to a valid resource in a pure function, but can at least catch obvious problems.
 func validateContributorAvatarURL(avatarURL *string) []error {
 	if avatarURL == nil {
 		return nil
 	}
 
-	errs := []error{}
 	if *avatarURL == "" {
-		errs = append(errs, errors.New("avatar URL must be omitted or non-empty string"))
-		return errs
+		return []error{errors.New("avatar URL must be omitted or non-empty string")}
 	}
 
-	// Have to use .Parse instead of .ParseRequestURI because this is the
-	// one field that's allowed to be a relative URL
+	errs := []error{}
+	// Have to use .Parse instead of .ParseRequestURI because this is the one field that's allowed to be a relative URL.
 	if _, err := url.Parse(*avatarURL); err != nil {
 		errs = append(errs, fmt.Errorf("URL %q is not a valid relative or absolute URL", *avatarURL))
 	}
@@ -220,8 +216,7 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
 
 	yamlValidationErrors := []error{}
 	for _, p := range profilesByNamespace {
-		errors := validateContributorReadme(p)
-		if len(errors) > 0 {
+		if errors := validateContributorReadme(p); len(errors) > 0 {
 			yamlValidationErrors = append(yamlValidationErrors, errors...)
 			continue
 		}
@@ -245,11 +240,12 @@ func aggregateContributorReadmeFiles() ([]readme, error) {
 	allReadmeFiles := []readme{}
 	errs := []error{}
 	for _, e := range dirEntries {
-		dirPath := path.Join(rootRegistryPath, e.Name())
 		if !e.IsDir() {
 			continue
 		}
 
+		dirPath := path.Join(rootRegistryPath, e.Name())
+
 		readmePath := path.Join(dirPath, "README.md")
 		rmBytes, err := os.ReadFile(readmePath)
 		if err != nil {
@@ -273,20 +269,17 @@ func aggregateContributorReadmeFiles() ([]readme, error) {
 }
 
 func validateContributorRelativeUrls(contributors map[string]contributorProfileReadme) error {
-	// This function only validates relative avatar URLs for now, but it can be
-	// beefed up to validate more in the future
+	// This function only validates relative avatar URLs for now, but it can be beefed up to validate more in the future.
 	errs := []error{}
 
 	for _, con := range contributors {
-		// If the avatar URL is missing, we'll just assume that the Registry
-		// site build step will take care of filling in the data properly
+		// If the avatar URL is missing, we'll just assume that the Registry site build step will take care of filling
+		// in the data properly.
 		if con.frontmatter.AvatarURL == nil {
 			continue
 		}
 
-		isRelativeURL := strings.HasPrefix(*con.frontmatter.AvatarURL, ".") ||
-			strings.HasPrefix(*con.frontmatter.AvatarURL, "/")
-		if !isRelativeURL {
+		if !strings.HasPrefix(*con.frontmatter.AvatarURL, ".") || !strings.HasPrefix(*con.frontmatter.AvatarURL, "/") {
 			continue
 		}
 
@@ -297,8 +290,7 @@ func validateContributorRelativeUrls(contributors map[string]contributorProfileR
 
 		absolutePath := strings.TrimSuffix(con.filePath, "README.md") +
 			*con.frontmatter.AvatarURL
-		_, err := os.ReadFile(absolutePath)
-		if err != nil {
+		if _, err := os.ReadFile(absolutePath); err != nil {
 			errs = append(errs, fmt.Errorf("%q: relative avatar path %q does not point to image in file system", con.filePath, *con.frontmatter.AvatarURL))
 		}
 	}
@@ -325,8 +317,7 @@ func validateAllContributorFiles() error {
 	}
 	logger.Info(context.Background(), "Processed README files as valid contributor profiles", "num_contributors", len(contributors))
 
-	err = validateContributorRelativeUrls(contributors)
-	if err != nil {
+	if err = validateContributorRelativeUrls(contributors); err != nil {
 		return err
 	}
 	logger.Info(context.Background(), "All relative URLs for READMEs are valid")
