go-licenser

command module

v0.4.0 Latest Latest Go to latest Published: Dec 21, 2020 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/evanljp/go-licenser

Links

Open Source Insights

README ¶

Go Licenser

Small zero dependency license header checker for source files. The aim of this project is to provide a common binary that can be used to ensure that code source files contain a license header. It's unlikely that this project is useful outside of Elastic at the current stage, but the licensing package can be used as a building block.

Supported Licenses

Apache 2.0
Elastic
Elastic Cloud

Supported languages

Go

Installing

go get -u github.com/elastic/go-licenser

Usage

Usage: go-licenser [flags] [path]

  go-licenser walks the specified path recursively and appends a license Header if the current
  header doesn't match the one found in the file.

Options:

  -d	skips rewriting files and returns exitcode 1 if any discrepancies are found.
  -exclude value
    	path to exclude (can be specified multiple times).
  -ext string
    	sets the file extension to scan for. (default ".go")
  -license string
    	sets the license type to check: ASL2, Elastic, Cloud (default "ASL2")
  -licensor string
        sets the name of the licensor (default "Elasticsearch B.V.")
  -version
    	prints out the binary version.

Contributing

See CONTRIBUTING.md.

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
golden
cloud Package testdata holds test data for the licensing cmd	Package testdata holds test data for the licensing cmd
excludedpath Package excludedpath holds test data for the licensing cmd	Package excludedpath holds test data for the licensing cmd
multilevel Package testdata holds test data for the licensing cmd	Package testdata holds test data for the licensing cmd
multilevel/sublevel Package sublevel holds test data for the licensing cmd	Package sublevel holds test data for the licensing cmd
singlelevel Package testdata holds test data for the licensing cmd	Package testdata holds test data for the licensing cmd
x-pack Package testdata holds test data for the licensing cmd	Package testdata holds test data for the licensing cmd
licensing Package licensing provides a set of functions that read the top lines of a file and can determine if they match a specific header.	Package licensing provides a set of functions that read the top lines of a file and can determine if they match a specific header.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL