Documentation
¶
Index ¶
- Constants
- Variables
- func CheckNoChanges() error
- func FindFilesRecursive(match func(path string, info os.FileInfo) bool) ([]string, error)
- func GenerateNotice(overrides, rules, noticeTemplate string) error
- func GitDiff() error
- func GitDiffIndex() ([]string, error)
- func InstallGoLicenser() error
- func InstallGoNoticeGen() error
- type Benchmark
- type Deps
- type GoImports
- type Linter
Constants ¶
const ( // GoImportsImportPath controls the import path used to install goimports. GoImportsImportPath = "golang.org/x/tools/cmd/goimports" // GoImportsLocalPrefix is a string prefix matching imports that should be // grouped after third-party packages. GoImportsLocalPrefix = "github.com/elastic" )
Variables ¶
var ( // GoLicenserImportPath controls the import path used to install go-licenser. GoLicenserImportPath = "github.com/elastic/go-licenser" // GoNoticeGeneratorImportPath controls the import path used to install go-licence-detector. GoNoticeGeneratorImportPath = "go.elastic.co/go-licence-detector" )
Functions ¶
func CheckNoChanges ¶ added in v0.2.1
func CheckNoChanges() error
func FindFilesRecursive ¶ added in v0.2.12
FindFilesRecursive recursively traverses from the CWD and invokes the given match function on each regular file to determine if the given path should be returned as a match. It ignores files in .git directories.
func GenerateNotice ¶ added in v0.2.0
func GitDiff ¶ added in v0.2.1
func GitDiff() error
GitDiff runs 'git diff' and writes the output to stdout.
func GitDiffIndex ¶ added in v0.2.1
GitDiffIndex returns a list of files that differ from what is committed. These could file that were created, deleted, modified, or moved.
func InstallGoLicenser ¶ added in v0.2.0
func InstallGoLicenser() error
InstallGoLicenser target installs go-licenser
func InstallGoNoticeGen ¶ added in v0.2.0
func InstallGoNoticeGen() error
InstallGoLicenser target installs go-licenser
Types ¶
type Benchmark ¶ added in v0.3.5
Benchmark namespace for mage to group all the related targets under this namespace
func (Benchmark) Deps ¶ added in v0.3.5
Deps installs required plugins for reading benchmarks results
type Deps ¶
Deps contains targets related to checking dependencies
func (Deps) CheckModuleTidy ¶
CheckModuleTidy checks if `go mod tidy` was run before the last commit.
type Linter ¶
Linter contains targets related to linting the Go code
func (Linter) CheckConfig ¶
CheckConfig makes sure that the `.golangci.yml` does not have uncommitted changes
func (Linter) ForceInstall ¶ added in v0.2.10
ForceInstall force installs the linter regardless of whether it exists or not.
func (Linter) Install ¶
Install installs golangci-lint (https://golangci-lint.run) to `./build` using the official installation script downloaded from GitHub. If the linter binary already exists does nothing.
func (Linter) LastChange ¶
LastChange runs the linter against all files changed since the fork point from `main`. If the current branch is `main` then runs against the files changed in the last commit.
Source Files
Directories