Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

header

package

Go to main page

Versions in this module

v0

v0.9.0

Aug 24, 2026

Changes in this version

+ func DiffFile(file string, config *ConfigHeader) (string, error)

+ func MatchPaths(file string, patterns []string) bool

v0.8.0

Sep 14, 2025

v0.7.0

Feb 9, 2025

v0.6.0

Apr 7, 2024

v0.5.0

Aug 15, 2023

Changes in this version

type LicenseConfig

+ CopyrightYear string

+ SoftwareName string

v0.4.0

Jul 8, 2022

v0.3.0

May 10, 2022

Changes in this version

type ConfigHeader

+ Languages map[string]comments.Language

+ func (config *ConfigHeader) LicensePattern(style *comments.CommentStyle) *regexp.Regexp

v0.2.0

Oct 14, 2021

Changes in this version

+ func Check(config *ConfigHeader, result *Result) error

+ func CheckFile(file string, config *ConfigHeader, result *Result) error

+ func Fix(file string, config *ConfigHeader, result *Result) error

+ func GenerateLicenseHeader(style *comments.CommentStyle, config *ConfigHeader) (string, error)

+ func InsertComment(file string, style *comments.CommentStyle, config *ConfigHeader, ...) error

+ type CommentOption string

+ var ASFNames = regexp.MustCompile("(?i)(the )?(Apache Software Foundation|ASF)")

+ var Always CommentOption = "always"

+ var Never CommentOption = "never"

+ var OnFailure CommentOption = "on-failure"

+ type ConfigHeader struct

+ Comment CommentOption

+ License LicenseConfig

+ LicenseLocationThreshold int

+ Paths []string

+ PathsIgnore []string

+ Pattern string

+ func (config *ConfigHeader) Finalize() error

+ func (config *ConfigHeader) GetLicenseContent() string

+ func (config *ConfigHeader) NormalizedLicense() string

+ func (config *ConfigHeader) NormalizedPattern() *regexp.Regexp

+ func (config *ConfigHeader) ShouldIgnore(path string) (bool, error)

+ type LicenseConfig struct

+ Content string

+ CopyrightOwner string

+ Pattern string

+ SpdxID string

+ type Result struct

+ Failure []string

+ Fixed []string

+ Ignored []string

+ Success []string

+ func (result *Result) Error() error

+ func (result *Result) Fail(file string)

+ func (result *Result) Fix(file string)

+ func (result *Result) HasFailure() bool

+ func (result *Result) Ignore(file string)

+ func (result *Result) String() string

+ func (result *Result) Succeed(file string)