update go header to v1.0.0-rc.5

Signed-off-by: Denis Tingaikin <[email protected]>

Author: denis-tingaikin

go.mod

@@ -1,6 +1,8 @@
 module github.com/golangci/golangci-lint/v2
 
-go 1.23.0
+go 1.24
+
+toolchain go1.24.1
 
 require (
 	4d63.com/gocheckcompilerdirectives v1.3.0
@@ -35,7 +37,7 @@ require (
 	github.com/ckaznocha/intrange v0.3.1
 	github.com/curioswitch/go-reassign v0.3.0
 	github.com/daixiang0/gci v0.13.6
-	github.com/denis-tingaikin/go-header v0.5.0
+	github.com/denis-tingaikin/go-header v1.0.0-rc.5
 	github.com/fatih/color v1.18.0
 	github.com/firefart/nonamedreturns v1.0.6
 	github.com/fzipp/gocyclo v0.6.0

go.sum

@@ -1,7 +1,6 @@
 package goheader
 
 import (
-	"go/token"
 	"strings"
 
 	goheader "github.com/denis-tingaikin/go-header"
@@ -14,118 +13,18 @@ import (
 const linterName = "goheader"
 
 func New(settings *config.GoHeaderSettings, replacer *strings.Replacer) *goanalysis.Linter {
-	conf := &goheader.Configuration{}
+	conf := &goheader.Config{}
 	if settings != nil {
-		conf = &goheader.Configuration{
+		conf = &goheader.Config{
 			Values:       settings.Values,
 			Template:     settings.Template,
 			TemplatePath: replacer.Replace(settings.TemplatePath),
 		}
 	}
-
-	analyzer := &analysis.Analyzer{
-		Name: linterName,
-		Doc:  goanalysis.TheOnlyanalyzerDoc,
-		Run: func(pass *analysis.Pass) (any, error) {
-			err := runGoHeader(pass, conf)
-			if err != nil {
-				return nil, err
-			}
-
-			return nil, nil
-		},
-	}
-
 	return goanalysis.NewLinter(
 		linterName,
 		"Checks if file header matches to pattern",
-		[]*analysis.Analyzer{analyzer},
+		[]*analysis.Analyzer{goheader.NewAnalyzer(conf)},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeSyntax)
 }
-
-func runGoHeader(pass *analysis.Pass, conf *goheader.Configuration) error {
-	if conf.TemplatePath == "" && conf.Template == "" {
-		// User did not pass template, so then do not run go-header linter
-		return nil
-	}
-
-	template, err := conf.GetTemplate()
-	if err != nil {
-		return err
-	}
-
-	values, err := conf.GetValues()
-	if err != nil {
-		return err
-	}
-
-	a := goheader.New(goheader.WithTemplate(template), goheader.WithValues(values))
-
-	for _, file := range pass.Files {
-		position, isGoFile := goanalysis.GetGoFilePosition(pass, file)
-		if !isGoFile {
-			continue
-		}
-
-		issue := a.Analyze(&goheader.Target{File: file, Path: position.Filename})
-		if issue == nil {
-			continue
-		}
-
-		f := pass.Fset.File(file.Pos())
-
-		commentLine := 1
-		var offset int
-
-		// Inspired by https://github.com/denis-tingaikin/go-header/blob/4c75a6a2332f025705325d6c71fff4616aedf48f/analyzer.go#L85-L92
-		if len(file.Comments) > 0 && file.Comments[0].Pos() < file.Package {
-			if !strings.HasPrefix(file.Comments[0].List[0].Text, "/*") {
-				// When the comment is "//" there is a one character offset.
-				offset = 1
-			}
-			commentLine = goanalysis.GetFilePositionFor(pass.Fset, file.Comments[0].Pos()).Line
-		}
-
-		// Skip issues related to build directives.
-		// https://github.com/denis-tingaikin/go-header/issues/18
-		if issue.Location().Position-offset < 0 {
-			continue
-		}
-
-		diag := analysis.Diagnostic{
-			Pos:     f.LineStart(issue.Location().Line+1) + token.Pos(issue.Location().Position-offset), // The position of the first divergence.
-			Message: issue.Message(),
-		}
-
-		if fix := issue.Fix(); fix != nil {
-			current := len(fix.Actual)
-			for _, s := range fix.Actual {
-				current += len(s)
-			}
-
-			start := f.LineStart(commentLine)
-
-			end := start + token.Pos(current)
-
-			header := strings.Join(fix.Expected, "\n") + "\n"
-
-			// Adds an extra line between the package and the header.
-			if end == file.Package {
-				header += "\n"
-			}
-
-			diag.SuggestedFixes = []analysis.SuggestedFix{{
-				TextEdits: []analysis.TextEdit{{
-					Pos:     start,
-					End:     end,
-					NewText: []byte(header),
-				}},
-			}}
-		}
-
-		pass.Report(diag)
-	}
-
-	return nil
-}

pkg/golinters/goheader/goheader.go

@@ -1,8 +1,8 @@
 /*
-Copyright 1999 The Awesome
-
-Use of this source code is governed by LICENSE
-*/
+ * Copyright 1999 The Awesome
+ *
+ * Use of this source code is governed by LICENSE
+ */
 
 //golangcitest:args -Egoheader
 //golangcitest:expected_exitcode 0

pkg/golinters/goheader/testdata/fix/in/goheader_3.go

@@ -1,6 +1,8 @@
-/* Copyright 2024 The Awesome Project Authors
+/*
+Copyright 2024 The Awesome Project Authors
 
-Use of this source code is governed by LICENSE */
+Use of this source code is governed by LICENSE
+*/
 
 //golangcitest:args -Egoheader
 //golangcitest:expected_exitcode 0

pkg/golinters/goheader/testdata/fix/out/goheader_2.go

@@ -1,8 +1,8 @@
 /*
-Copyright 2024 The Awesome Project Authors
-
-Use of this source code is governed by LICENSE
-*/
+ * Copyright 2024 The Awesome Project Authors
+ *
+ * Use of this source code is governed by LICENSE
+ */
 
 //golangcitest:args -Egoheader
 //golangcitest:expected_exitcode 0

pkg/golinters/goheader/testdata/fix/out/goheader_3.go

@@ -1,7 +1,7 @@
 /*
-	Copyright 2024 The Awesome Project Authors
+Copyright 2024 The Awesome Project Authors
 
-	Use of this source code is governed by LICENSE
+Use of this source code is governed by LICENSE
 */
 
 //golangcitest:args -Egoheader

pkg/golinters/goheader/testdata/fix/out/goheader_4.go

@@ -7,6 +7,6 @@ linters:
         const:
           AUTHOR: The Awesome Project Authors
       template: |-
-        Copyright 2024 {{ AUTHOR }}
-  
+        Copyright 2024 {{ .AUTHOR }}
+
         Use of this source code is governed by LICENSE

pkg/golinters/goheader/testdata/goheader-fix.yml

@@ -3,7 +3,7 @@ version: "2"
 linters:
   settings:
     goheader:
-      template: MY {{title}}
+      template: MY {{.title}}.
       values:
         const:
-          title: TITLE.
+          title: TITLE

pkg/golinters/goheader/testdata/goheader.yml

@@ -1,5 +1,6 @@
-/*MY TITLE!*/ // want `Expected:TITLE\., Actual: TITLE!`
+/*oops!*/ // want `template doesn't match`
 
 //golangcitest:args -Egoheader
 //golangcitest:config_path testdata/goheader.yml
+//golangcitest:expected_exitcode 1
 package testdata