Skip to content

Commit a27027b

Browse files
Anas-ElhounsriAnas-Elhounsri
committed
Addig dummy results
2 parents f5b21c6 + dea72d5 commit a27027b

2 files changed

Lines changed: 353 additions & 0 deletions

File tree

‎results/pitfalls/output_1_pitfalls.jsonld‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
{
2+
"@context": "https://w3id.org/example/metacheck/0.1.0/",
3+
"@type": "SoftwareQualityAssessment",
4+
"name": "Quality Assessment for dgarijo/Widoco",
5+
"description": "Wizard for documenting ontologies. WIDOCO is a step by step generator of HTML templates with the documentation of your ontology. It uses the LODE environment to create part of the template.",
6+
"creator": {
7+
"@type": "schema:Person",
8+
"name": "Anonymous",
9+
"email": "example@email.com"
10+
},
11+
"dateCreated": "2026-01-19T12:52:32Z",
12+
"license": {
13+
"@id": "https://opensource.org/license/mit"
14+
},
15+
"assessedSoftware": {
16+
"@type": "schema:SoftwareApplication",
17+
"name": "dgarijo/Widoco",
18+
"softwareVersion": "v1.4.25",
19+
"url": "https://github.com/dgarijo/Widoco",
20+
"schema:identifier": {
21+
"@id": "https://doi.org/10.5281/zenodo.11093793"
22+
}
23+
},
24+
"checks": [
25+
{
26+
"@type": "CheckResult",
27+
"assessesIndicator": {
28+
"@id": "https://w3id.org/example/metacheck/i/indicators/metadatafile"
29+
},
30+
"checkingSoftware": {
31+
"@type": "schema:SoftwareApplication",
32+
"name": "metacheck",
33+
"@id": "https://w3id.org/example/metacheck/tools/",
34+
"softwareVersion": "0.1.0"
35+
},
36+
"process": "The metadata file (codemeta or other) has a version which does not correspond to the version used in the latest release",
37+
"status": {
38+
"@id": "schema:CompletedActionStatus"
39+
},
40+
"checkId": "P001",
41+
"evidence": "P001 detected: pom.xml version '1.4.26' does not match release version '1.4.25'",
42+
"suggestion": "Ensure the version in your metadata matches the latest official release. Keeping these synchronized avoids confusion for users and improves reproducibility."
43+
},
44+
{
45+
"@type": "CheckResult",
46+
"assessesIndicator": {
47+
"@id": "https://w3id.org/example/metacheck/i/indicators/codemeta"
48+
},
49+
"checkingSoftware": {
50+
"@type": "schema:SoftwareApplication",
51+
"name": "metacheck",
52+
"@id": "https://w3id.org/example/metacheck/tools/",
53+
"softwareVersion": "0.1.0"
54+
},
55+
"process": "codemeta.json version does not match the package's",
56+
"status": {
57+
"@id": "schema:CompletedActionStatus"
58+
},
59+
"checkId": "P017",
60+
"evidence": "P017 detected: codemeta.json version 'v1.4.25' does not match package version",
61+
"suggestion": "You need to synchronize all version references across metadata and build configuration files."
62+
},
63+
{
64+
"@type": "CheckResult",
65+
"assessesIndicator": {
66+
"@id": "https://w3id.org/example/metacheck/i/indicators/codemeta"
67+
},
68+
"checkingSoftware": {
69+
"@type": "schema:SoftwareApplication",
70+
"name": "metacheck",
71+
"@id": "https://w3id.org/example/metacheck/tools/",
72+
"softwareVersion": "0.1.0"
73+
},
74+
"process": "The dateModified in codemeta.json is outdated compared to the actual repository last update date",
75+
"status": {
76+
"@id": "schema:CompletedActionStatus"
77+
},
78+
"checkId": "W002",
79+
"evidence": "W002 detected: codemeta.json dateModified '2025-01-31T00:00:00' is outdated compared to repository date '2026-01-19T11:22:31'",
80+
"suggestion": "You need to align the version in your metadata file with your latest release tag. Automating this synchronization as part of your release process is highly recommended."
81+
},
82+
{
83+
"@type": "CheckResult",
84+
"assessesIndicator": {
85+
"@id": "https://w3id.org/example/metacheck/i/indicators/codemeta"
86+
},
87+
"checkingSoftware": {
88+
"@type": "schema:SoftwareApplication",
89+
"name": "metacheck",
90+
"@id": "https://w3id.org/example/metacheck/tools/",
91+
"softwareVersion": "0.1.0"
92+
},
93+
"process": "Programming languages in codemeta.json do not have versions",
94+
"status": {
95+
"@id": "schema:CompletedActionStatus"
96+
},
97+
"checkId": "W004",
98+
"evidence": "W004 detected: codemeta.json Programming languages without versions: JavaScript, Java, XSLT, CSS, HTML, Dockerfile",
99+
"suggestion": "Include version numbers for each programming language used. Defining these helps ensure reproducibility and compatibility across systems."
100+
},
101+
{
102+
"@type": "CheckResult",
103+
"assessesIndicator": {
104+
"@id": "https://w3id.org/example/metacheck/i/indicators/metadatafile"
105+
},
106+
"checkingSoftware": {
107+
"@type": "schema:SoftwareApplication",
108+
"name": "metacheck",
109+
"@id": "https://w3id.org/example/metacheck/tools/",
110+
"softwareVersion": "0.1.0"
111+
},
112+
"process": "The metadata file softwareRequirements have more than one req, but it's written as one string",
113+
"status": {
114+
"@id": "schema:CompletedActionStatus"
115+
},
116+
"checkId": "W005",
117+
"evidence": "W005 detected: codemeta.json Multiple requirements written as single string: 'Just add the dependency and repository to your `pom.xml` file as follows. See the [WIDOCO JitPack](https://jitpack.io/#dgarijo/Widoco) page to find alternative means to incorporate WIDOCO to your project.\n\n```xml\n<dependencies>\n <dependency>\n <groupId>com.github.dgarijo</groupId>\n <artifactId>Widoco</artifactId>\n <version>v1.4.24</version>\n </dependency>\n</dependencies>\n\n[ ... ]\n\n<repositories>\n\t<repository>\n\t <id>jitpack.io</id>\n\t <url>https://jitpack.io</url>\n\t</repository>\n</repositories>\n```'",
118+
"suggestion": "Rewrite your dependencies as a proper list, with each item separated and preferably with their versions. This makes them easier to parse for metadata systems."
119+
}
120+
]
121+
}

‎results/summary.json‎

Lines changed: 232 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,232 @@
1+
{
2+
"summary": {
3+
"total_repositories_analyzed": 1,
4+
"repositories_with_target_languages": 1,
5+
"individual_jsonld_files_created": 1,
6+
"total_pitfalls_detected": 2,
7+
"total_warnings_detected": 3,
8+
"target_languages": [
9+
"Python",
10+
"Java",
11+
"C++",
12+
"C",
13+
"R",
14+
"Rust"
15+
]
16+
},
17+
"pitfalls & warnings": [
18+
{
19+
"pitfall_code": "P001",
20+
"pitfall_desc": "The metadata file (codemeta or other) has a version which does not correspond to the version used in the latest release",
21+
"count": 1,
22+
"percentage": 100.0,
23+
"languages": {
24+
"Java": 1
25+
}
26+
},
27+
{
28+
"pitfall_code": "P002",
29+
"pitfall_desc": "LICENSE file contains template placeholders like <program>, <year>, <name of author> that were not replaced",
30+
"count": 0,
31+
"percentage": 0.0,
32+
"languages": {}
33+
},
34+
{
35+
"pitfall_code": "P003",
36+
"pitfall_desc": "Metadata files have multiple authors in single field instead of a list",
37+
"count": 0,
38+
"percentage": 0.0,
39+
"languages": {}
40+
},
41+
{
42+
"pitfall_code": "P004",
43+
"pitfall_desc": "In codemeta.json README property pointing to their homepage/wiki instead of README file",
44+
"count": 0,
45+
"percentage": 0.0,
46+
"languages": {}
47+
},
48+
{
49+
"pitfall_code": "P005",
50+
"pitfall_desc": "codemeta.json referencePublication refers to software archive instead of paper",
51+
"count": 0,
52+
"percentage": 0.0,
53+
"languages": {}
54+
},
55+
{
56+
"pitfall_code": "P006",
57+
"pitfall_desc": "The metadata file has License pointing to a local file instead of stating the name",
58+
"count": 0,
59+
"percentage": 0.0,
60+
"languages": {}
61+
},
62+
{
63+
"pitfall_code": "P007",
64+
"pitfall_desc": "CITATION.cff does not have referencePublication even though it's referenced in codemeta.json",
65+
"count": 0,
66+
"percentage": 0.0,
67+
"languages": {}
68+
},
69+
{
70+
"pitfall_code": "P008",
71+
"pitfall_desc": "The metadata file softwareRequirement points to an invalid page",
72+
"count": 0,
73+
"percentage": 0.0,
74+
"languages": {}
75+
},
76+
{
77+
"pitfall_code": "P009",
78+
"pitfall_desc": "The metadata file coderepository points to their homepage",
79+
"count": 0,
80+
"percentage": 0.0,
81+
"languages": {}
82+
},
83+
{
84+
"pitfall_code": "P010",
85+
"pitfall_desc": "LICENSE file only contains copyright information without actual license terms",
86+
"count": 0,
87+
"percentage": 0.0,
88+
"languages": {}
89+
},
90+
{
91+
"pitfall_code": "P011",
92+
"pitfall_desc": "codemeta.json IssueTracker violates the expected URL format",
93+
"count": 0,
94+
"percentage": 0.0,
95+
"languages": {}
96+
},
97+
{
98+
"pitfall_code": "P012",
99+
"pitfall_desc": "codemeta.json downloadURL is outdated",
100+
"count": 0,
101+
"percentage": 0.0,
102+
"languages": {}
103+
},
104+
{
105+
"pitfall_code": "P013",
106+
"pitfall_desc": "The metadata file License does not have the specific version",
107+
"count": 0,
108+
"percentage": 0.0,
109+
"languages": {}
110+
},
111+
{
112+
"pitfall_code": "P014",
113+
"pitfall_desc": "codemeta.json uses bare DOIs in the identifier field instead of full https://doi.org/ URL",
114+
"count": 0,
115+
"percentage": 0.0,
116+
"languages": {}
117+
},
118+
{
119+
"pitfall_code": "P015",
120+
"pitfall_desc": "In codemeta.json contIntegration link returns 404",
121+
"count": 0,
122+
"percentage": 0.0,
123+
"languages": {}
124+
},
125+
{
126+
"pitfall_code": "P016",
127+
"pitfall_desc": "The metadata file codeRepository does not point to the same repository",
128+
"count": 0,
129+
"percentage": 0.0,
130+
"languages": {}
131+
},
132+
{
133+
"pitfall_code": "P017",
134+
"pitfall_desc": "codemeta.json version does not match the package's",
135+
"count": 1,
136+
"percentage": 100.0,
137+
"languages": {
138+
"Java": 1
139+
}
140+
},
141+
{
142+
"pitfall_code": "P018",
143+
"pitfall_desc": "codemeta.json Identifier uses raw SWHIDs without their resolvable URL",
144+
"count": 0,
145+
"percentage": 0.0,
146+
"languages": {}
147+
},
148+
{
149+
"pitfall_code": "P019",
150+
"pitfall_desc": "Inconsistent author counts found across metadata files",
151+
"count": 0,
152+
"percentage": 0.0,
153+
"languages": {}
154+
},
155+
{
156+
"warning_code": "W001",
157+
"warning_desc": "Software requirements in metadata files don't have version specifications",
158+
"count": 0,
159+
"percentage": 0.0,
160+
"languages": {}
161+
},
162+
{
163+
"warning_code": "W002",
164+
"warning_desc": "The dateModified in codemeta.json is outdated compared to the actual repository last update date",
165+
"count": 1,
166+
"percentage": 100.0,
167+
"languages": {
168+
"Java": 1
169+
}
170+
},
171+
{
172+
"warning_code": "W003",
173+
"warning_desc": "Codemeta.json repository has multiple licenses but only one is listed",
174+
"count": 0,
175+
"percentage": 0.0,
176+
"languages": {}
177+
},
178+
{
179+
"warning_code": "W004",
180+
"warning_desc": "Programming languages in codemeta.json do not have versions",
181+
"count": 1,
182+
"percentage": 100.0,
183+
"languages": {
184+
"Java": 1
185+
}
186+
},
187+
{
188+
"warning_code": "W005",
189+
"warning_desc": "The metadata file softwareRequirements have more than one req, but it's written as one string",
190+
"count": 1,
191+
"percentage": 100.0,
192+
"languages": {
193+
"Java": 1
194+
}
195+
},
196+
{
197+
"warning_code": "W006",
198+
"warning_desc": "codemeta.json Identifier is a name instead of a valid unique identifier, but an identifier exist",
199+
"count": 0,
200+
"percentage": 0.0,
201+
"languages": {}
202+
},
203+
{
204+
"warning_code": "W007",
205+
"warning_desc": "codemeta.json Identifier is empty",
206+
"count": 0,
207+
"percentage": 0.0,
208+
"languages": {}
209+
},
210+
{
211+
"warning_code": "W008",
212+
"warning_desc": "The metadata file GivenName is a list instead of a string",
213+
"count": 0,
214+
"percentage": 0.0,
215+
"languages": {}
216+
},
217+
{
218+
"pitfall_code": "W009",
219+
"pitfall_desc": "codemeta.json developmentStatus is a URL instead of a string",
220+
"count": 0,
221+
"percentage": 0.0,
222+
"languages": {}
223+
},
224+
{
225+
"pitfall_code": "W010",
226+
"pitfall_desc": "The metadata file codeRepository uses Git remote-style shorthand instead of full URL",
227+
"count": 0,
228+
"percentage": 0.0,
229+
"languages": {}
230+
}
231+
]
232+
}

0 commit comments

Comments
 (0)