more comments lint fixes

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

Author: cstyan

.golangci.yml

@@ -35,6 +35,9 @@ linters:
   settings:
     dupl:
       threshold: 412
+    godot:
+      scope: all
+      capital: true
     exhaustruct:
       include:
         - httpmw\.\w+

cmd/readmevalidation/coderresources.go

@@ -70,7 +70,7 @@ func validateCoderResourceIconURL(iconURL string) []error {
 
 	// Would normally be skittish about having relative paths like this, but it
 	// should be safe because we have guarantees about the structure of the
-	// repo, and where this logic will run
+	// repo, and where this logic will run.
 	isPermittedRelativeURL := strings.HasPrefix(iconURL, "./") ||
 		strings.HasPrefix(iconURL, "/") ||
 		strings.HasPrefix(iconURL, "../../../../.icons")
@@ -91,7 +91,7 @@ func validateCoderResourceTags(tags []string) error {
 
 	// All of these tags are used for the module/template filter controls in the
 	// Registry site. Need to make sure they can all be placed in the browser
-	// URL without issue
+	// URL without issue.
 	invalidTags := []string{}
 	for _, t := range tags {
 		if t != url.QueryEscape(t) {
@@ -132,7 +132,7 @@ func validateCoderResourceReadmeBody(body string) []error {
 
 		// Code assumes that invalid headers would've already been handled by
 		// the base validation function, so we don't need to check deeper if the
-		// first line isn't an h1
+		// first line isn't an h1.
 		if lineNum == 1 {
 			if !strings.HasPrefix(nextLine, "# ") {
 				break
@@ -160,14 +160,14 @@ func validateCoderResourceReadmeBody(body string) []error {
 		}
 
 		// Code assumes that we can treat this case as the end of the "h1
-		// section" and don't need to process any further lines
+		// section" and don't need to process any further lines.
 		if lineNum > 1 && strings.HasPrefix(nextLine, "#") {
 			break
 		}
 
 		// Code assumes that if we've reached this point, the only other options
 		// are: (1) empty spaces, (2) paragraphs, (3) HTML, and (4) asset
-		// references made via [] syntax
+		// references made via [] syntax.
 		trimmedLine := strings.TrimSpace(nextLine)
 		isParagraph := trimmedLine != "" && !strings.HasPrefix(trimmedLine, "![") && !strings.HasPrefix(trimmedLine, "<")
 		foundParagraph = foundParagraph || isParagraph

cmd/readmevalidation/contributors.go

@@ -19,7 +19,7 @@ type contributorProfileFrontmatter struct {
 	Bio               string `yaml:"bio"`
 	ContributorStatus string `yaml:"status"`
 	// Script assumes that if avatar URL is nil, the Registry site build step
-	// will backfill the value with the user's GitHub avatar URL
+	// will backfill the value with the user's GitHub avatar URL.
 	AvatarURL    *string `yaml:"avatar"`
 	LinkedinURL  *string `yaml:"linkedin"`
 	WebsiteURL   *string `yaml:"website"`
@@ -62,7 +62,7 @@ func validateContributorSupportEmail(email *string) []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
+	// pipeline. Best we can do is verify the general structure.
 	username, server, ok := strings.Cut(*email, "@")
 	if !ok {
 		errs = append(errs, xerrors.Errorf("email address %q is missing @ symbol", *email))
@@ -126,7 +126,7 @@ func validateContributorAvatarURL(avatarURL *string) []error {
 	}
 
 	// Have to use .Parse instead of .ParseRequestURI because this is the
-	// one field that's allowed to be a relative URL
+	// one field that's allowed to be a relative URL.
 	if _, err := url.Parse(*avatarURL); err != nil {
 		errs = append(errs, xerrors.Errorf("URL %q is not a valid relative or absolute URL", *avatarURL))
 	}
@@ -273,12 +273,12 @@ 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
+	// 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
+		// site build step will take care of filling in the data properly.
 		if con.frontmatter.AvatarURL == nil {
 			continue
 		}

cmd/readmevalidation/main.go

@@ -16,7 +16,7 @@ func main() {
 
 	// If there are fundamental problems with how the repo is structured, we
 	// can't make any guarantees that any further validations will be relevant
-	// or accurate
+	// or accurate.
 	repoErr := validateRepoStructure()
 	if repoErr != nil {
 		log.Println(repoErr)

cmd/readmevalidation/readmefiles.go

@@ -41,15 +41,15 @@ func separateFrontmatter(readmeText string) (readmeFrontmatter string, readmeBod
 			continue
 		}
 		// Break early if the very first line wasn't a fence, because then we
-		// know for certain that the README has problems
+		// know for certain that the README has problems.
 		if fenceCount == 0 {
 			break
 		}
 
 		// It should be safe to trim each line of the frontmatter on a per-line
 		// basis, because there shouldn't be any extra meaning attached to the
 		// indentation. The same does NOT apply to the README; best we can do is
-		// gather all the lines, and then trim around it
+		// gather all the lines, and then trim around it.
 		if inReadmeBody := fenceCount >= 2; inReadmeBody {
 			body += nextLine + "\n"
 		} else {
@@ -79,7 +79,7 @@ func validateReadmeBody(body string) []error {
 
 	// If the very first line of the README, there's a risk that the rest of the
 	// validation logic will break, since we don't have many guarantees about
-	// how the README is actually structured
+	// how the README is actually structured.
 	if !strings.HasPrefix(trimmed, "# ") {
 		return []error{xerrors.New("README body must start with ATX-style h1 header (i.e., \"# \")")}
 	}
@@ -95,7 +95,7 @@ func validateReadmeBody(body string) []error {
 
 		// Have to check this because a lot of programming languages support #
 		// comments (including Terraform), and without any context, there's no
-		// way to tell the difference between a markdown header and code comment
+		// way to tell the difference between a markdown header and code comment.
 		if strings.HasPrefix(nextLine, "```") {
 			isInCodeBlock = !isInCodeBlock
 			continue
@@ -122,7 +122,7 @@ func validateReadmeBody(body string) []error {
 		}
 
 		// If we have obviously invalid headers, it's not really safe to keep
-		// proceeding with the rest of the content
+		// proceeding with the rest of the content.
 		if nextHeaderLevel == 1 {
 			errs = append(errs, xerrors.New("READMEs cannot contain more than h1 header"))
 			break
@@ -134,14 +134,14 @@ func validateReadmeBody(body string) []error {
 
 		// This is something we need to enforce for accessibility, not just for
 		// the Registry website, but also when users are viewing the README
-		// files in the GitHub web view
+		// files in the GitHub web view.
 		if nextHeaderLevel > latestHeaderLevel && nextHeaderLevel != (latestHeaderLevel+1) {
 			errs = append(errs, xerrors.New("headers are not allowed to increase more than 1 level at a time"))
 			continue
 		}
 
 		// As long as the above condition passes, there's no problems with
-		// going up a header level or going down 1+ header levels
+		// going up a header level or going down 1+ header levels.
 		latestHeaderLevel = nextHeaderLevel
 	}
 
@@ -154,20 +154,20 @@ func validateReadmeBody(body string) []error {
 type validationPhase string
 
 const (
-	// validationPhaseFileStructureValidation indicates when the entire Registry
+	// ValidationPhaseFileStructureValidation 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"
 
-	// validationPhaseFileLoad indicates when README files are being read from
+	// ValidationPhaseFileLoad indicates when README files are being read from
 	// the file system.
 	validationPhaseFileLoad = "Filesystem reading"
 
-	// validationPhaseReadmeParsing indicates when a README's frontmatter is
+	// ValidationPhaseReadmeParsing indicates when a README's frontmatter is
 	// being parsed as YAML. This phase does not include YAML validation.
 	validationPhaseReadmeParsing = "README parsing"
 
-	// validationPhaseAssetCrossReference indicates when a README's frontmatter
+	// ValidationPhaseAssetCrossReference 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"

cmd/readmevalidation/repostructure.go

@@ -18,7 +18,7 @@ func validateCoderResourceSubdirectory(dirPath string) []error {
 	subDir, err := os.Stat(dirPath)
 	if err != nil {
 		// It's valid for a specific resource directory not to exist. It's just
-		// that if it does exist, it must follow specific rules
+		// that if it does exist, it must follow specific rules.
 		if !errors.Is(err, os.ErrNotExist) {
 			errs = append(errs, addFilePathToError(dirPath, err))
 		}
@@ -39,7 +39,7 @@ func validateCoderResourceSubdirectory(dirPath string) []error {
 		// The .coder subdirectories are sometimes generated as part of Bun
 		// tests. These subdirectories will never be committed to the repo, but
 		// in the off chance that they don't get cleaned up properly, we want to
-		// skip over them
+		// skip over them.
 		if !f.IsDir() || f.Name() == ".coder" {
 			continue
 		}
@@ -96,7 +96,7 @@ func validateRegistryDirectory() []error {
 
 		for _, f := range files {
 			// Todo: Decide if there's anything more formal that we want to
-			// ensure about non-directories scoped to user namespaces
+			// ensure about non-directories scoped to user namespaces.
 			if !f.IsDir() {
 				continue
 			}