Repository navigation
[Linting Rule] Software Has License
Generated from 'wiki-linter.ts' on 2026-10-27, 10:46:55 UTC (v2.16.6), do not edit directly.
Software Has License [overview]
This rule ports the following steps of R CMD check (see the conformance table for the legend):
| # | Step | Coverage | Note |
|---|---|---|---|
| 25 | DESCRIPTION meta-information (book) | 🟩 |
This rule is a best-effort rule.
Finds software projects without a license (a LICENSE file or the License field of the DESCRIPTION).
This linting rule is implemented in src/linter/rules/software-has-license.ts.
Linting rules can be configured by passing a configuration object to the linter query as shown in the example below.
The software-has-license rule accepts the following configuration options:
-
checkDescriptionFile
Whether to also inspect the DESCRIPTION file for a License field
R CMD check #25
cat("a project without a license")The linting query can be used to run this rule on the above example:
[ { "type": "linter", "rules": [ { "name": "software-has-license", "config": {} } ] } ]Results (prettified and summarized):
Query: linter (0 ms)
╰ Software Has License (software-has-license):
╰ certain:
╰ No license found in the project
More examples are the test cases in test/functionality/linter/lint-software-has-license.test.ts.
Currently maintained by Florian Sihler and Oliver Gerstl at Ulm University
Email | GitHub | Penguins | Portfolio
- 🧑💻 Developer Onboarding
- 💻 Setup
- 👓 Overview
- 🪟 Interfacing with flowR
- 🌋 Core
- 🧹 Testing & Linting (Benchmark Page)
⁉️ FAQ- ℹ️ Extra Information