Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.54 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.54 KB
Raw

Go Licenser Build Status

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 2.0
  • 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:

  -copyright
        sets the copyright string as the first line
  -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, ASL2-Short, Cloud, Elastic, Elasticv2 (default "ASL2")
  -licensor string
        sets the name of the licensor (default "Elasticsearch B.V.")
  -multiline
        uses multiline comments
  -version
        prints out the binary version.

Contributing

See CONTRIBUTING.md.