google / licensecheck

The licensecheck package classifies license files and heuristically determines how well they correspond to known open source licenses.
BSD 3-Clause "New" or "Revised" License
447 stars 74 forks source link

Reuse Compatability #53

Open schmidtw opened 2 years ago

schmidtw commented 2 years ago

I changed a go project I have over to use spdx & the FSF's reuse tooling to attempt to make things more clear & simpler to manage. It looks like this license checker doesn't handle looking in a LICENSES directory for the SPDX licenses. The purpose for this issue is to see if that is something the maintainers here would be willing to accept a change for.

For reference, this is what reuse shows for it's structuring: https://reuse.software/tutorial/#result

Here is my project (that uses the reuse cli tool): https://github.com/schmidtw/goschtalt/tree/main/LICENSES

Of note is that the code isn't dual licensed (meaning it's available under both) but parts are covered by one license and other are covered by a different license.

oliverpool commented 1 year ago

I face the same issue with my repo: https://codeberg.org/pfad.fr/vanitydoc/src/branch/main/LICENSES (I don't even have a LICENSE file, since it shouldn't be needed).

Instead of looking for the LICENSES folder, the tool should directly check the SPDX-License-Identifier headers.

As such, the documentation of my package is not displayed on pkg.go.dev (luckily the goal of this package is to enable self-hosting documentation: https://code.pfad.fr/vanitydoc ;)