make each phase type string explicitly an instance the validationPhase type

Signed-off-by: Callum Styan <[email protected]>

Author: cstyan

cmd/readmevalidation/coderresources.go

@@ -246,7 +246,7 @@ func parseCoderResourceReadmeFiles(resourceType string, rms []readme) (map[strin
 	}
 	if len(yamlParsingErrs) != 0 {
 		return nil, validationPhaseError{
-			phase:  validationPhaseReadmeParsing,
+			phase:  readmeParsing,
 			errors: yamlParsingErrs,
 		}
 	}
@@ -260,7 +260,7 @@ func parseCoderResourceReadmeFiles(resourceType string, rms []readme) (map[strin
 	}
 	if len(yamlValidationErrors) != 0 {
 		return nil, validationPhaseError{
-			phase:  validationPhaseReadmeParsing,
+			phase:  readmeParsing,
 			errors: yamlValidationErrors,
 		}
 	}
@@ -318,7 +318,7 @@ func aggregateCoderResourceReadmeFiles(resourceType string) ([]readme, error) {
 
 	if len(errs) != 0 {
 		return nil, validationPhaseError{
-			phase:  validationPhaseFileLoad,
+			phase:  fileLoad,
 			errors: errs,
 		}
 	}

cmd/readmevalidation/contributors.go

@@ -209,7 +209,7 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
 	}
 	if len(yamlParsingErrors) != 0 {
 		return nil, validationPhaseError{
-			phase:  validationPhaseReadmeParsing,
+			phase:  readmeParsing,
 			errors: yamlParsingErrors,
 		}
 	}
@@ -223,7 +223,7 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
 	}
 	if len(yamlValidationErrors) != 0 {
 		return nil, validationPhaseError{
-			phase:  validationPhaseReadmeParsing,
+			phase:  readmeParsing,
 			errors: yamlValidationErrors,
 		}
 	}
@@ -261,7 +261,7 @@ func aggregateContributorReadmeFiles() ([]readme, error) {
 
 	if len(errs) != 0 {
 		return nil, validationPhaseError{
-			phase:  validationPhaseFileLoad,
+			phase:  fileLoad,
 			errors: errs,
 		}
 	}
@@ -300,7 +300,7 @@ func validateContributorRelativeURLs(contributors map[string]contributorProfileR
 		return nil
 	}
 	return validationPhaseError{
-		phase:  validationPhaseAssetCrossReference,
+		phase:  assetCrossReference,
 		errors: errs,
 	}
 }

cmd/readmevalidation/readmefiles.go

@@ -8,26 +8,32 @@ import (
 	"strings"
 )
 
+// validationPhase represents a specific phase during README validation. It is expected that each phase is discrete, and
+// errors during one will prevent a future phase from starting.
+type validationPhase string
+
 const (
 	rootRegistryPath = "./registry"
 
-	// validationPhaseFileStructureValidation indicates when the entire Registry
+	// --- validationPhases ---
+	// fileStructureValidation indicates when the entire Registry
 	// directory is being verified for having all files be placed in the file
 	// system as expected.
-	validationPhaseFileStructureValidation validationPhase = "File structure validation"
+	fileStructureValidation validationPhase = "File structure validation"
 
-	// validationPhaseFileLoad indicates when README files are being read from
+	// fileLoad indicates when README files are being read from
 	// the file system.
-	validationPhaseFileLoad = "Filesystem reading"
+	fileLoad validationPhase = "Filesystem reading"
 
-	// validationPhaseReadmeParsing indicates when a README's frontmatter is
+	// readmeParsing indicates when a README's frontmatter is
 	// being parsed as YAML. This phase does not include YAML validation.
-	validationPhaseReadmeParsing = "README parsing"
+	readmeParsing validationPhase = "README parsing"
 
-	// validationPhaseAssetCrossReference indicates when a README's frontmatter
+	// assetCrossReference indicates when a README's frontmatter
 	// is having all its relative URLs be validated for whether they point to
 	// valid resources.
-	validationPhaseAssetCrossReference = "Cross-referencing relative asset URLs"
+	assetCrossReference validationPhase = "Cross-referencing relative asset URLs"
+	// --- end of validationPhases ---
 )
 
 var (
@@ -36,10 +42,6 @@ var (
 	readmeHeaderRe = regexp.MustCompile(`^(#{1,})(\s*)`)
 )
 
-// validationPhase represents a specific phase during README validation. It is expected that each phase is discrete, and
-// errors during one will prevent a future phase from starting.
-type validationPhase string
-
 // readme represents a single README file within the repo (usually within the top-level "/registry" directory).
 type readme struct {
 	filePath string

cmd/readmevalidation/repostructure.go

@@ -127,7 +127,7 @@ func validateRepoStructure() error {
 
 	if len(errs) != 0 {
 		return validationPhaseError{
-			phase:  validationPhaseFileStructureValidation,
+			phase:  fileStructureValidation,
 			errors: errs,
 		}
 	}