give validation phases more obvious name prefixes

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

Author: cstyan

cmd/readmevalidation/coderresources.go

@@ -247,7 +247,7 @@ func parseCoderResourceReadmeFiles(resourceType string, rms []readme) (map[strin
 	}
 	if len(yamlParsingErrs) != 0 {
 		return nil, validationPhaseError{
-			phase:  readmeParsing,
+			phase:  validationPhaseReadme,
 			errors: yamlParsingErrs,
 		}
 	}
@@ -261,7 +261,7 @@ func parseCoderResourceReadmeFiles(resourceType string, rms []readme) (map[strin
 	}
 	if len(yamlValidationErrors) != 0 {
 		return nil, validationPhaseError{
-			phase:  readmeParsing,
+			phase:  validationPhaseReadme,
 			errors: yamlValidationErrors,
 		}
 	}
@@ -319,7 +319,7 @@ func aggregateCoderResourceReadmeFiles(resourceType string) ([]readme, error) {
 
 	if len(errs) != 0 {
 		return nil, validationPhaseError{
-			phase:  fileLoad,
+			phase:  validationPhaseFile,
 			errors: errs,
 		}
 	}

cmd/readmevalidation/contributors.go

@@ -206,7 +206,7 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
 	}
 	if len(yamlParsingErrors) != 0 {
 		return nil, validationPhaseError{
-			phase:  readmeParsing,
+			phase:  validationPhaseReadme,
 			errors: yamlParsingErrors,
 		}
 	}
@@ -220,7 +220,7 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
 	}
 	if len(yamlValidationErrors) != 0 {
 		return nil, validationPhaseError{
-			phase:  readmeParsing,
+			phase:  validationPhaseReadme,
 			errors: yamlValidationErrors,
 		}
 	}
@@ -258,7 +258,7 @@ func aggregateContributorReadmeFiles() ([]readme, error) {
 
 	if len(errs) != 0 {
 		return nil, validationPhaseError{
-			phase:  fileLoad,
+			phase:  validationPhaseFile,
 			errors: errs,
 		}
 	}
@@ -299,7 +299,7 @@ func validateContributorRelativeURLs(contributors map[string]contributorProfileR
 		return nil
 	}
 	return validationPhaseError{
-		phase:  assetCrossReference,
+		phase:  validationPhaseCrossReference,
 		errors: errs,
 	}
 }

cmd/readmevalidation/readmefiles.go

@@ -16,23 +16,23 @@ const (
 	rootRegistryPath = "./registry"
 
 	// --- validationPhases ---
-	// fileStructureValidation indicates when the entire Registry
+	// validationPhaseStructure indicates when the entire Registry
 	// directory is being verified for having all files be placed in the file
 	// system as expected.
-	fileStructureValidation validationPhase = "File structure validation"
+	validationPhaseStructure validationPhase = "File structure validation"
 
-	// FileLoad indicates when README files are being read from
+	// validationPhaseFile indicates when README files are being read from
 	// the file system.
-	fileLoad validationPhase = "Filesystem reading"
+	validationPhaseFile validationPhase = "Filesystem reading"
 
-	// ReadmeParsing indicates when a README's frontmatter is
+	// validationPhaseReadme indicates when a README's frontmatter is
 	// being parsed as YAML. This phase does not include YAML validation.
-	readmeParsing validationPhase = "README parsing"
+	validationPhaseReadme validationPhase = "README parsing"
 
-	// AssetCrossReference indicates when a README's frontmatter
+	// validationPhaseCrossReference indicates when a README's frontmatter
 	// is having all its relative URLs be validated for whether they point to
 	// valid resources.
-	assetCrossReference validationPhase = "Cross-referencing relative asset URLs"
+	validationPhaseCrossReference validationPhase = "Cross-referencing relative asset URLs"
 	// --- end of validationPhases ---.
 )
 

cmd/readmevalidation/repostructure.go

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