https://github.com/samuelmanzanera/ex_license
Utility to insert or check license headers
https://github.com/samuelmanzanera/ex_license
elixir license-header spdx-license
Last synced: about 1 year ago
JSON representation
Utility to insert or check license headers
- Host: GitHub
- URL: https://github.com/samuelmanzanera/ex_license
- Owner: samuelmanzanera
- License: mit
- Created: 2022-02-22T14:33:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-14T23:22:35.000Z (over 4 years ago)
- Last Synced: 2024-10-19T20:54:56.508Z (over 1 year ago)
- Topics: elixir, license-header, spdx-license
- Language: Elixir
- Homepage:
- Size: 14.6 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ExLicense
Utility to insert license header in each Elixir file using SPDX specification.
A mix task is available to insert header or to verify (useful for CI actions)
```sh
$ mix insert_license --license mit
```
```sh
$ mix insert_license --verify --license mit
```
Here, the `--license` option takes one of these values `mit, agpl, gpl, lgpl, mozilla, apache, boost`
## Installation
Install from [Hex](https://hex.pm/packages/ex_license), the package can be installed
by adding `ex_license` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_license, "~> 0.1.0"}
]
end
```
## Available License
It supports the following license
- [x] [mit](https://spdx.org/licenses/MIT.html)
- [x] [agpl_v3](https://spdx.org/licenses/AGPL-3.0-or-later.html)
- [x] [gpl_v3](https://spdx.org/licenses/GPL-3.0-or-later.html)
- [x] [lgpl_v3](https://spdx.org/licenses/LGPL-3.0-or-later.html)
- [x] [mozilla_v2](https://spdx.org/licenses/MPL-2.0.html)
- [x] [apache_v2](https://spdx.org/licenses/Apache-2.0.html)
- [x] [boost_v1](https://spdx.org/licenses/BSL-1.0.html)
Documentation published on [HexDocs](https://hexdocs.pm/ex_license).