Diagnose an Unfilled LICENSE Template

Flags a LICENSE file still carrying template placeholders such as <YEAR> or <COPYRIGHT HOLDER>.

Usage

lab_license_year(path = ".", verbose = TRUE)

Arguments

path

Character. Path to the package directory. Default: ".".

verbose

Logical. Print diagnostic output. Default: TRUE.

Value

checktor_check_result() with passed, issues, message.

Source

The CRAN Cookbook covers the file itself under LICENSE files. An unfilled template, with <YEAR> or <COPYRIGHT HOLDER> left in, leaves a placeholder, and no binding rule names it, which is why this sits at robustness tier. See vignette("check-sources", package = "checktor") for how every check maps to its source.

See also

checktor(), which runs this and every other check.

Examples

pkg <- example_diagnose_scenario("description_examples/license_year_bad.LICENSE",
                                 show_content = FALSE)
lab_license_year(pkg, verbose = FALSE)$issues
#> [1] "LICENSE has an unfilled template placeholder: <YEAR>"            
#> [2] "LICENSE has an unfilled template placeholder: <COPYRIGHT HOLDER>"
unlink(pkg, recursive = TRUE)