c4milo / licentia

Manage the open source licenses of your projects

Licentia

Helps you manage the open source licenses of your projects quickly and effortlessly.

Features

Licentia allows you to:

• Easily manage your opensource licenses across several files
• Update the year of your copyright notice across several files
• Change the license of a subset of files by using glob patterns

Installation

go get github.com/c4milo/licentia

Usage

Licentia.

Usage:
  licentia set <type> <owner> <files> <eol-comment-style>
  licentia unset <type> <owner> <files> <eol-comment-style>
  licentia detect <files>
  licentia dump <type> <owner>
  licentia list
  licentia -h | --help
  licentia --version

Supported license types:

* apache2   * gpl3       * gpl2
* mpl2      * cddl       * unlicense
* mit       * epl
* newbsd    * freebsd
* lgpl3     * lgpl2

Actions:
  set                Sets a license header to the specified files
  unset              Removes license header from the specified files
  detect             Detects license type for the specified files
  dump               Dumps to stdout a given license using the specified owner and the current year
  list               List supported licenses

Arguments:
  type               License type to set. Ex: apache2, mpl2, mit, newbsd, lgpl3
  owner              Copyright owner. Ex: "YourCompany Inc"
  files              Source files to set the license header. It supports globbing patterns as well as specifying individual files. Ex: *.go, myfile.go, **/*.go
  eol-comment-style  End-of-line comment style. Ex: #, ;, //, --, ', etc.

Options:
  -h --help     Show this screen.
  --version     Show version.

Licenses supported

• Apache License 2.0
• Mozilla Public License 2.0
• MIT License
• GNU General Public License (GPL)
• GNU Library or "Lesser" General Public License (LGPL)
• BSD 2-Clause "Simplified" or "FreeBSD" license
• BSD 3-Clause "New" or "Revised" license
• Common Development and Distribution License
• Eclipse Public Licenses
• Unlicense

licentia's Issues

Adding an individual folder is not working

Docs say that you can add an individual folder but that won't work, the error says something like:

licentia_test.go:69: unexpected error: ! open path/to/dir: is a directory

The following test fails:

func TestSetDir(t *testing.T) {
    dirpath, err := ioutil.TempDir(os.TempDir(), "licentia-tests-")
    ok(t, err)

    defer os.Remove(dirpath)

    file, err := ioutil.TempFile(dirpath, "file-")

    config := &Config{
        CopyrightOwner:  "Test",
        LicenseType:     MPL2,
        Files:           dirpath,
        EOLCommentStyle: "//",
    }

    err = Set(config)
    ok(t, err)

    data, err := ioutil.ReadFile(file.Name())
    ok(t, err)

    equals(t, mpl2, string(data))
}

Unable finish Undeath

Write tests

Implement Detect function

Perhaps using https://github.com/jbrukh/bayesian

Implement unsetting a license header from one or multiple files

Implement dumping licenses to stdout

This will allow us to quickly set a LICENSE file at the top of the any project folder.