Method CheckNewFiles

tools/mage/headers.go:226–267

CheckNewFiles checks that all new files contain the required file header with the correct year.

()

// CheckNewFiles checks that all new files contain the required file header with the correct year.
func (h Headers) CheckNewFiles() error {
	mg.Deps(Headers.loadFile)
	base := "origin/" + os.Getenv("GITHUB_BASE_REF")

	currentYear := time.Now().Year()
	correctHeader := fmt.Sprintf("// Copyright © %d ", currentYear)

	cmd := exec.Command("git", "diff", "--name-only", "--diff-filter=A", base)
	output, err := cmd.Output()
	if err != nil {
		return fmt.Errorf("failed to get list of new files: %w", err)
	}

	var checkErrs errorSlice
	for _, path := range strings.Split(strings.TrimSpace(string(output)), "\n") {
		// Check if the file matches the HeaderRule before checking its header.
		if rule := headerConfig.get(path); rule == nil {
			continue // Skip files that do not match any HeaderRule.
		}

		fileContent, err := os.ReadFile(path)
		if err != nil {
			return fmt.Errorf("failed to read file %s: %w", path, err)
		}

		// Check if the first line of the file contains the correct copyright header.
		scanner := bufio.NewScanner(bytes.NewReader(fileContent))
		if scanner.Scan() {
			firstLine := scanner.Text()
			if !strings.Contains(firstLine, correctHeader) {
				checkErrs = append(checkErrs, &checkErr{Path: path, Reason: "incorrect year in copyright header; should be " + strconv.Itoa(currentYear)})
			}
		} else {
			checkErrs = append(checkErrs, &checkErr{Path: path, Reason: "empty file or missing header"})
		}
	}

	if len(checkErrs) > 0 {
		return checkErrs
	}
	return nil
}

func init() {
	preCommitChecks = append(preCommitChecks, Headers.Check)