fix: update base README logic to ignore code blocks

Author: buenos-nachos

cmd/readmevalidation/coderResources.go

@@ -116,15 +116,15 @@ func validateCoderResourceTags(tags []string) error {
 // would be a big improvement.
 var terraformVersionRe = regexp.MustCompile("^\\bversion\\s+=")
 
-// This validation function definitely has risks of false positives right now,
-// but realistically, it's not going to cause problems for launch. The most
-// foolproof way to rebuild this would be to parse each README into an AST, and
-// then parse each Terraform code block as Terraform
 func validateCoderResourceReadmeBody(body string) []error {
 	trimmed := strings.TrimSpace(body)
 	var errs []error
 	errs = append(errs, validateReadmeBody(trimmed)...)
 
+	if true {
+		return errs
+	}
+
 	foundParagraph := false
 	terraformCodeBlockCount := 0
 	foundTerraformVersionRef := false

cmd/readmevalidation/readmeFiles.go

@@ -68,8 +68,8 @@ func separateFrontmatter(readmeText string) (string, string, error) {
 
 var readmeHeaderRe = regexp.MustCompile("^(#{1,})(\\s*)")
 
-// Todo: This is a little chaotic, and might have some risks of false positives.
-// Might be better to bring in an
+// Todo: This seems to work okay for now, but the really proper way of doing
+// this is by parsing this as an AST, and then checking the resulting nodes
 func validateReadmeBody(body string) []error {
 	trimmed := strings.TrimSpace(body)
 	var errs []error
@@ -82,29 +82,39 @@ func validateReadmeBody(body string) []error {
 		return errs
 	}
 
-	lineNum := 0
-	lastHeaderLevel := 0
+	latestHeaderLevel := 0
 	foundFirstH1 := false
+	isInCodeBlock := false
 
 	lineScanner := bufio.NewScanner(strings.NewReader(trimmed))
 	for lineScanner.Scan() {
-		lineNum++
 		nextLine := lineScanner.Text()
 
+		// 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
+		if strings.HasPrefix(nextLine, "```") {
+			isInCodeBlock = !isInCodeBlock
+			continue
+		}
+		if isInCodeBlock {
+			continue
+		}
+
 		headerGroups := readmeHeaderRe.FindStringSubmatch(nextLine)
 		if headerGroups == nil {
 			continue
 		}
 
 		spaceAfterHeader := headerGroups[2]
 		if spaceAfterHeader == "" {
-			errs = append(errs, fmt.Errorf("line %d: header does not have space between header characters and main header text", lineNum))
+			errs = append(errs, errors.New("header does not have space between header characters and main header text"))
 		}
 
 		nextHeaderLevel := len(headerGroups[1])
 		if nextHeaderLevel == 1 && !foundFirstH1 {
 			foundFirstH1 = true
-			lastHeaderLevel = 1
+			latestHeaderLevel = 1
 			continue
 		}
 
@@ -115,21 +125,21 @@ func validateReadmeBody(body string) []error {
 			break
 		}
 		if nextHeaderLevel > 6 {
-			errs = append(errs, fmt.Errorf("line %d: README/HTML files cannot have headers exceed level 6 (found level %d)", lineNum, nextHeaderLevel))
+			errs = append(errs, fmt.Errorf("README/HTML files cannot have headers exceed level 6 (found level %d)", nextHeaderLevel))
 			break
 		}
 
 		// 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
-		if nextHeaderLevel > lastHeaderLevel && nextHeaderLevel != (lastHeaderLevel+1) {
-			errs = append(errs, fmt.Errorf("line %d: headers are not allowed to increase more than 1 level at a time", lineNum))
+		if nextHeaderLevel > latestHeaderLevel && nextHeaderLevel != (latestHeaderLevel+1) {
+			errs = append(errs, fmt.Errorf("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
-		lastHeaderLevel = nextHeaderLevel
+		latestHeaderLevel = nextHeaderLevel
 	}
 
 	return errs

registry/coder/modules/claude-code/README.md

@@ -22,7 +22,7 @@ module "claude-code" {
 }
 ```
 
-### Prerequisites
+## Prerequisites
 
 - Node.js and npm must be installed in your workspace to install Claude Code
 - `screen` must be installed in your workspace to run Claude Code in the background

registry/coder/modules/github-upload-public-key/README.md

@@ -20,13 +20,13 @@ module "github-upload-public-key" {
 }
 ```
 
-# Requirements
+## Requirements
 
 This module requires `curl` and `jq` to be installed inside your workspace.
 
 Github External Auth must be enabled in the workspace for this module to work. The Github app that is configured for external auth must have both read and write permissions to "Git SSH keys" in order to upload the public key. Additionally, a Coder admin must also have the `admin:public_key` scope added to the external auth configuration of the Coder deployment. For example:
 
-```
+```txt
 CODER_EXTERNAL_AUTH_0_ID="USER_DEFINED_ID"
 CODER_EXTERNAL_AUTH_0_TYPE=github
 CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxx

registry/coder/modules/goose/README.md

@@ -22,7 +22,7 @@ module "goose" {
 }
 ```
 
-### Prerequisites
+## Prerequisites
 
 - `screen` must be installed in your workspace to run Goose in the background
 - You must add the [Coder Login](https://registry.coder.com/modules/coder-login) module to your template