This repository has been archived by the owner on May 27, 2024. It is now read-only.
Add JSON schema for output of reuse lint --json
#128
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| { | ||
| "$schema": "https://reuse.software/schemas/1.0.0_lint_schema.json", | ||
| "$ref": "#/definitions/Result", | ||
| "definitions": { | ||
| "Result": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "lint_version": { | ||
| "type": "string" | ||
| }, | ||
| "reuse_spec_version": { | ||
| "type": "string" | ||
| }, | ||
| "reuse_tool_version": { | ||
| "type": "string" | ||
| }, | ||
| "files": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/File" | ||
| } | ||
| }, | ||
| "non_compliant": { | ||
| "$ref": "#/definitions/NonCompliant" | ||
| }, | ||
| "summary": { | ||
| "$ref": "#/definitions/Summary" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "files", | ||
| "lint_version", | ||
| "non_compliant", | ||
| "reuse_spec_version", | ||
| "reuse_tool_version", | ||
| "summary" | ||
| ], | ||
| "title": "Welcome" | ||
| }, | ||
| "File": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "path": { | ||
| "type": "string" | ||
| }, | ||
| "copyrights": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/Copyright" | ||
| } | ||
| }, | ||
| "licenses": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/Copyright" | ||
| } | ||
| } | ||
| }, | ||
| "required": ["copyrights", "licenses", "path"], | ||
| "title": "File" | ||
| }, | ||
| "Copyright": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "value": { | ||
| "type": "string" | ||
| }, | ||
| "source": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": ["source", "value"], | ||
| "title": "Copyright" | ||
| }, | ||
| "NonCompliant": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "missing_licenses": { | ||
| "$ref": "#/definitions/MissingLicenses" | ||
| }, | ||
| "unused_licenses": { | ||
| "type": "array", | ||
| "items": {} | ||
| }, | ||
| "deprecated_licenses": { | ||
| "type": "array", | ||
| "items": {} | ||
| }, | ||
| "bad_licenses": { | ||
| "$ref": "#/definitions/BadLicenses" | ||
| }, | ||
| "licenses_without_extension": { | ||
| "$ref": "#/definitions/LicensesWithoutExtension" | ||
| }, | ||
| "missing_copyright_info": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "missing_licensing_info": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "read_errors": { | ||
| "type": "array", | ||
| "items": {} | ||
| } | ||
| }, | ||
| "required": [ | ||
| "bad_licenses", | ||
| "deprecated_licenses", | ||
| "licenses_without_extension", | ||
| "missing_copyright_info", | ||
| "missing_licenses", | ||
| "missing_licensing_info", | ||
| "read_errors", | ||
| "unused_licenses" | ||
| ], | ||
| "title": "NonCompliant" | ||
| }, | ||
| "BadLicenses": { | ||
| "type": "object", | ||
| "additionalProperties": { "type": "object" }, | ||
| "title": "BadLicenses" | ||
| }, | ||
| "LicensesWithoutExtension": { | ||
| "type": "object", | ||
| "additionalProperties": { "type": "object" }, | ||
| "title": "LicensesWithoutExtension" | ||
| }, | ||
| "MissingLicenses": { | ||
| "type": "object", | ||
| "additionalProperties": { "type": "object" }, | ||
| "title": "MissingLicenses" | ||
| }, | ||
|
Comment on lines
+128
to
+142
There was a problem hiding this comment. If I understand it correctly these objects are not defined or explicitly structured. There was a problem hiding this comment. Yep, you're right. That's because the key of these objects is in a sense arbitrary, i.e. the license name. I don't know JSON schema well enough to know whether this can be alleviated. I think for a first version, this is fine though. There was a problem hiding this comment. Least we could do is force the keys to be strings https://stackoverflow.com/a/26848488 |
||
| "Summary": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "used_licenses": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "files_total": { | ||
| "type": "integer" | ||
| }, | ||
| "files_with_copyright_info": { | ||
| "type": "integer" | ||
| }, | ||
| "files_with_licensing_info": { | ||
| "type": "integer" | ||
| }, | ||
| "compliant": { | ||
| "type": "boolean" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "compliant", | ||
| "files_total", | ||
| "files_with_copyright_info", | ||
| "files_with_licensing_info", | ||
| "used_licenses" | ||
| ], | ||
| "title": "Summary" | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the object name Copyright the correct name if it also used in a licensing context?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would be the alternative?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe Details or FindingDetails?