@laudio/licenser

Licensing utility for Laudio

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@laudio/licenser
Minified + gzip package size for @laudio/licenser in KB

Readme

Licenser

npm

Automatically include licenses on the top of every source file. This is used in all Laudio repositories to ensure that each file has a license header.

Installation

Download Binaries

Pre-built binaries for Linux, MacOS and Windows are available under the bin directory.

Using NPM

npm install -g @laudio/licenser

Using Go

If you have Go installed, binaries can be regenerated for all platforms by running make.

Provide a platform to make for building for a specific platform. For example, to create a Linux binary:

make linux

Similarly, use make darwin and make windows for MacOS and Windows platforms.

Manual Installation

Run the following command to get a binary in your $GOPATH/bin/ directory:

go install .

Usage

The license is passed via a file which can be set using the -l flag.

licenser -l /path/to/LICENSE

By default, the LICENSE file in the current working directory is searched for.

A default license is used if the -l flag is not specified and the working directory does not contain a LICENSE file.

(c) Laudio, Inc. All Rights Reserved.

This file contains proprietary and confidential source
code. Unauthorized copying of this file, via any
medium is strictly prohibited.

(r) 2018 Laudio is a registered trademark of Laudio, Inc.

Migration to a New License

Use -m flag to migrate to a new license.

licenser -l /path/to/LICENSE -m /path/to/new/license

This reads - Migrate the license specified by -l to license specified by -m.

Dry Run

Add the -d flag for a dry run.

licenser -l /path/to/LICENSE -d

Verbose Output

Add the -v flag for verbose output. Since painting to the console can't keep up with the speed that the program runs at, it might take longer for execution to complete. However, this is typically neglibible - it takes 500ms to 1s longer for ~20k files.

licenser -l /path/to/LICENSE -v

License

(c) Laudio, Inc. All Rights Reserved.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.