Function verifyBoilerplate

hack/verify_boilerplate/main.go:85–128

verifyBoilerplate verifies if a string contains the boilerplate

(contents string)

// verifyBoilerplate verifies if a string contains the boilerplate
func verifyBoilerplate(contents string) error {
	idx := 0
	foundBoilerplateStart := false
	lines := strings.SplitSeq(contents, "\n")
	for line := range lines {
		// handle leading comments
		line = trimLeadingComment(line, "//")
		line = trimLeadingComment(line, "#")

		// find the start of the boilerplate
		bpLine := boilerPlate[idx]
		if strings.Contains(line, boilerPlateStart) {
			foundBoilerplateStart = true

			// validate the year of the copyright
			yearWords := strings.Split(line, " ")
			if yearRegexp.MatchString(yearWords[1]) {
				bpLine = strings.ReplaceAll(bpLine, yearPlaceholder, yearWords[1])
			} else {
				bpLine = strings.ReplaceAll(bpLine, yearPlaceholder+" ", "")
			}
		}

		// match line by line
		if foundBoilerplateStart {
			if line != bpLine {
				return fmt.Errorf("boilerplate line %d does not match\nexpected: %q\ngot: %q", idx+1, bpLine, line)
			}
			idx++
			// exit after the last line is found
			if strings.Index(line, boilerPlateEnd) == 0 {
				break
			}
		}
	}

	if !foundBoilerplateStart {
		return errors.New("the file is missing a boilerplate")
	}
	if idx < len(boilerPlate) {
		return errors.New("boilerplate has missing lines")
	}
	return nil
}

// verifyFile verifies if a file contains the boilerplate
func verifyFile(filePath string) error {