Description
Inspect a package license value for an external license-file phrase.
License-related tokens can point to a file or express a legacy suffix convention. Lexical recognition does not establish that a license exists, applies to the content or permits a proposed reuse.
Inspect a package license value for an external license-file phrase.
When to use this tool
Use Package JSON License SPDX Prefix when checking a restricted license-metadata spelling.
How to use the tool and how it works
- Enter value. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read external, file. Inspect external before interpreting the associated values.
Inspect a package license value for an external license-file phrase. Require nonempty value; exact SEE LICENSE IN prefix plus nonempty file text sets external and returns file, otherwise file is empty.1
Package metadata can direct readers to a license file; recognizing that pointer does not establish its contents or applicable rights.2
| Input field | Meaning and units | Accepted input |
|---|---|---|
| value | Value | Required. Text; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| external | External | Required. Boolean. |
| file | File | Required. Text; maximum UTF-16 length 8192. |
{
"input": {
"value": "SEE LICENSE IN LICENSE.txt"
},
"output": {
"external": true,
"file": "LICENSE.txt"
}
}Limitations and assumptions
- It does not validate SPDX expressions, resolve the file or establish reuse rights.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Read the actual license and relevant provenance; use a proper SPDX parser for expressions and appropriate advice for legal interpretation.
References
Similar or alternative tools
- Package JSON Export Condition Key
Inspect one package export-condition key under a restricted rule.
- Development: Package Manager Integrity Token Split
Split a restricted package-integrity token.