Skip to contents

Check for unnecessary "+ file LICENSE" references

Source: R/check-license-file.R
cl_check_license_file.Rd

Flags a License field that references + file LICENSE alongside a base license that isn't one of the CRAN templates requiring an additional file. Per the CRAN Cookbook, most licenses are bundled with R itself and don't need a LICENSE file in the package; only MIT, BSD_2_clause, and BSD_3_clause are templates that do. A LICENSE file is otherwise only needed when there are additional attribution requirements or restrictions beyond the base license, which this check can't detect – so a finding here is a prompt to review, not an automatic removal.

Usage

cl_check_license_file(path = ".")

Arguments

path

Path to the package root. Defaults to the current directory.

Value

A tibble following the cranlint check-result contract; see AGENTS.md.

Examples

pkg_dir <- cl_example_pkg(
  description = c(License = "GPL-3 + file LICENSE")
)
cl_check_license_file(pkg_dir)
#> # A tibble: 1 × 6
#>   check        file         line severity   message             policy_reference
#>   <chr>        <chr>       <int> <ord>      <chr>               <chr>           
#> 1 license_file DESCRIPTION    NA should_fix "License field is … https://contrib…
unlink(pkg_dir, recursive = TRUE)