{"id":16577781,"url":"https://github.com/philippus/sbt-license-check","last_synced_at":"2025-03-21T12:32:04.615Z","repository":{"id":40336681,"uuid":"448532095","full_name":"Philippus/sbt-license-check","owner":"Philippus","description":"📝 Check the licenses used in your sbt project","archived":false,"fork":false,"pushed_at":"2024-10-27T07:05:42.000Z","size":143,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-27T23:26:03.117Z","etag":null,"topics":["licenses","sbt-plugin","scala"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Philippus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["Philippus"]}},"created_at":"2022-01-16T11:19:31.000Z","updated_at":"2024-10-27T07:05:44.000Z","dependencies_parsed_at":"2024-05-08T06:26:08.106Z","dependency_job_id":"d401d4d4-59b0-4465-93df-3d75751e7a11","html_url":"https://github.com/Philippus/sbt-license-check","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philippus%2Fsbt-license-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philippus%2Fsbt-license-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philippus%2Fsbt-license-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Philippus%2Fsbt-license-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Philippus","download_url":"https://codeload.github.com/Philippus/sbt-license-check/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221815218,"owners_count":16885143,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["licenses","sbt-plugin","scala"],"created_at":"2024-10-11T22:12:14.478Z","updated_at":"2025-03-21T12:32:04.596Z","avatar_url":"https://github.com/Philippus.png","language":"Scala","funding_links":["https://github.com/sponsors/Philippus"],"categories":[],"sub_categories":[],"readme":"# sbt-license-check\n\n[![build](https://github.com/Philippus/sbt-license-check/workflows/build/badge.svg)](https://github.com/Philippus/sbt-license-check/actions/workflows/scala.yml?query=workflow%3Abuild+branch%3Amain)\n![Current Version](https://img.shields.io/badge/version-0.0.5-brightgreen.svg?style=flat \"0.0.5\")\n[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)\n[![License](https://img.shields.io/badge/License-MPL%202.0-blue.svg?style=flat \"MPL 2.0\")](LICENSE)\n\nThis plugin can check and report the licenses used in your sbt project. You can use it also as part of your build chain\nand make the build fail if disallowed licenses are found.\n\n## Installation\n\nsbt-license-check is published for sbt 1.5.8 and above. To start using it add the following to your `plugins.sbt`:\n\n```\naddSbtPlugin(\"nl.gn0s1s\" % \"sbt-license-check\" % \"0.0.5\")\n```\n\n## Usage\n### Tasks\n| Task         | Description                                                                                                                                                                                                                                                                                                 | Command                  |\n|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------|\n| licenseCheck | Runs license check. Logs a tree of dependencies along with the licenses found, grouped by organization. If a dependency has no license, or it cannot be found it returns `no license specified`. Setting `useCoursier` to `false` before running the command yields in some cases different/better results. | ```$ sbt licenseCheck``` |\n\nTo find out the license(s) of the current project itself, the sbt command `licenses` can be used.\n\n### Configuration\nYou can configure the configuration in your `build.sbt` file.\n\n| Setting                                  | Description                                                                                                                                                                   | Default Value |\n|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|\n| licenseCheckFailBuildOnDisallowedLicense | Sets whether disallowed licenses fail the build, if `false` disallowed licenses show up as warnings in the log, if `true` they show up as errors.                             | false         |\n| licenseCheckDisallowedLicenses           | Sets the disallowed licenses, e.g. `Seq(\"Apache 2.0\")`.                                                                                                                       | Nil           |\n| licenseCheckExemptedDependencies         | Sequence of dependency names and revisions whose licenses will be allowed regardless of the `licenseCheckDisallowedLicenses` setting, e.g. `Seq((\"scala-xml_2.13\", \"2.0.1\"))` | Nil           |\n\n## Example usage\n\nBelow the output for the `scala-isbn`-project is shown:\n```\nsbt:scala-isbn\u003e set useCoursier := false\n[info] Defining useCoursier\n[info] The new value will be used by csrCacheDirectory, dependencyResolution and 9 others.\n[info]  Run `last` for details.\n[info] Reapplying settings...\n[info] set current project to scala-isbn (in build ***)\nsbt:scala-isbn\u003e licenseCheck\n[info] org.scala-lang\n[info]   +-scala-library:2.13.8\n[info]   | +-Apache-2.0 - https://www.apache.org/licenses/LICENSE-2.0\n[info]   +-scala-compiler:2.13.8\n[info]   | +-Apache-2.0 - https://www.apache.org/licenses/LICENSE-2.0\n[info]   +-scala-reflect:2.13.8\n[info]   | +-Apache-2.0 - https://www.apache.org/licenses/LICENSE-2.0\n[info] org.scalameta\n[info]   +-munit-scalacheck_2.13:0.7.29\n[info]   | +-Apache-2.0 - http://www.apache.org/licenses/LICENSE-2.0\n[info]   +-munit_2.13:0.7.29\n[info]   | +-Apache-2.0 - http://www.apache.org/licenses/LICENSE-2.0\n[info]   +-junit-interface:0.7.29\n[info]   | +-Apache-2.0 - http://www.apache.org/licenses/LICENSE-2.0\n[info] junit\n[info]   +-junit:4.13.1\n[info]   | +-Eclipse Public License 1.0 - http://www.eclipse.org/legal/epl-v10.html\n[info] org.jline\n[info]   +-jline:3.21.0\n[info]   | +-The BSD License - https://opensource.org/licenses/BSD-3-Clause\n[info] org.scala-sbt\n[info]   +-test-interface:1.0\n[info]   | +-BSD - https://github.com/sbt/test-interface/blob/master/LICENSE\n[info] net.java.dev.jna\n[info]   +-jna:5.9.0\n[info]   | +-LGPL-2.1-or-later - https://www.gnu.org/licenses/old-licenses/lgpl-2.1\n[info]   | +-Apache-2.0 - https://www.apache.org/licenses/LICENSE-2.0.txt\n[info] org.scalacheck\n[info]   +-scalacheck_2.13:1.15.4\n[info]   | +-BSD 3-clause - https://opensource.org/licenses/BSD-3-Clause\n[info] org.scala-lang.modules\n[info]   +-scala-xml_2.13:2.0.1\n[info]   | +-Apache-2.0 - https://www.apache.org/licenses/LICENSE-2.0\n[info] org.hamcrest\n[info]   +-hamcrest-core:1.3\n[info]   | +-New BSD License - http://www.opensource.org/licenses/bsd-license.php\n```\n\n## License\nThe code is available under the [Mozilla Public License, version 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilippus%2Fsbt-license-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilippus%2Fsbt-license-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilippus%2Fsbt-license-check/lists"}