Skip to content

Ensure either "type" or "@type" is used #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
progval merged 4 commits into from
Oct 7, 2025
Merged

Ensure either "type" or "@type" is used #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1e5b27
Ensure either "type" or "@type" is used
bact Oct 7, 2025
124ba1b
Make code easier to extend
bact Oct 7, 2025
924aef1
Use same style of quotes
bact Oct 7, 2025
e7768bf
Add type+@type test
bact Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion cypress/integration/validation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ describe('Document validation', function() {
);
cy.get('#validateCodemeta').click();


cy.get('#name').should('have.value', '');
cy.get('#errorMessage').should('have.text', '');
});
Expand Down Expand Up @@ -105,6 +104,20 @@ describe('Document validation', function() {

cy.get('#errorMessage').should('have.text', 'Unknown field "foobar".');
});

it('errors when both "type" and "@type" are present', function() {
cy.get('#codemetaText').then((elem) =>
elem.text(JSON.stringify({
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"type": "SoftwareSourceCode",
"@type": "SoftwareSourceCode",
"name": "Conflicting types example",
}))
);
cy.get('#validateCodemeta').click();

cy.get('#errorMessage').should('have.text', 'Document must use either "type" or "@type", not both.');
});
});

describe('URLs validation', function() {
Expand Down
8 changes: 7 additions & 1 deletion js/validation/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ function validateDocument(doc) {
}
// TODO: validate id/@id

// TODO: check there is either type or @type but not both
// Ensure either "type" or "@type" is used, but not both
const typeKeys = ['type', '@type'];
if (typeKeys.filter(k => Object.prototype.hasOwnProperty.call(doc, k)).length > 1) {
setError(`Document must use either "type" or "@type", not both.`);
return false;
}

var type = getDocumentType(doc);
if (type === undefined) {
setError("Missing type (must be SoftwareSourceCode or SoftwareApplication).")
Expand Down