Skip to content

[Linting Rule] Software Has License

github-actions[bot] edited this page Nov 8, 2026 · 1 revision

Generated from 'wiki-linter.ts' on 2026-10-27, 10:46:55 UTC (v2.16.6), do not edit directly.

Software Has License [overview]

smell documentation usability

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.

Configuration

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:

Examples

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.

Clone this wiki locally

⌂ 换网址