EmbarkStudios / EmbarkStudios/cargo-about

`[[DEPENDENCY.additional]]`: add diagnostics for missing `license-file`s

Open
#152 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Rust
Stars
782
Forks
46
Avg merge
13m
Merged PRs (30d)
1

Description

**Is your feature request related to a problem? Please describe.**
It appears `cargo-about` will silently fail to generate license text for [`[[DEPPENDENCY.additional]]`](https://github.com/EmbarkStudios/cargo-about#dependencyadditional) tags which only specify `license-file` and not `license`. This might occur if:

* The license file is outside of the crate (e.g. using a relative path like `../../LICENSE-MIT`, **like I was trying to**)
* The license filename or path is typoed (e.g. `LICENSE-MOT`)
* The license file was moved without updating `about.toml` (e.g. from `LICENSE-MIT` to `LICENSE-MIT.md`)

**Describe the solution you'd like**
Some kind of error, warning, or other diagnostic if a `license-file` isn't resolved.

**Describe alternatives you've considered**
My own needs for this feature are mooted by "Add a `--workspace` flag " https://github.com/EmbarkStudios/cargo-about/issues/151 , but I imagine others will accidentally omit licenses trying to use this feature.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.