Skip to content

feat: add errorMessage from schema when the property is missing #1138

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
merged 2 commits into from
Oct 14, 2025
Merged

feat: add errorMessage from schema when the property is missing #1138

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b28aef9
feat: add errorMessage from schema when the property is missing
p-spacek Oct 10, 2025
4977373
chore: update errorMessage property missing
p-spacek Oct 13, 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
4 changes: 3 additions & 1 deletion src/languageservice/parser/jsonParser07.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1251,7 +1251,9 @@ function validate(
validationResult.problems.push({
location: location,
severity: DiagnosticSeverity.Warning,
message: getWarningMessage(ProblemType.missingRequiredPropWarning, [propertyName]),
message:
getWarningMessage(ProblemType.missingRequiredPropWarning, [propertyName]) +
(schema.errorMessage ? ` ${schema.errorMessage}` : ''),
source: getSchemaSource(schema, originalSchema),
schemaUri: getSchemaUri(schema, originalSchema),
problemArgs: [propertyName],
Expand Down
40 changes: 40 additions & 0 deletions test/schemaValidation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1409,6 +1409,46 @@ obj:
const result = await parseSetup(content);
expect(result[0].message).to.eq('Missing property "pineapple".');
});
it('should add errorMessage from schema when the property is missing', async () => {
schemaProvider.addSchema(SCHEMA_ID, {
type: 'object',
properties: {
icon: {
type: 'string',
},
},
required: ['title'],
errorMessage: 'Custom message',
});
const content = '';
const result = await parseSetup(content);
expect(result[0].message).to.eq('Missing property "title".' + ' ' + 'Custom message');
});
it('should add errorMessage from sub-schema when the property is missing', async () => {
schemaProvider.addSchema(SCHEMA_ID, {
type: 'object',
properties: {
icon: {
type: 'string',
},
title: {
type: 'string',
},
},
anyOf: [
{
required: ['title'],
errorMessage: 'At least one of `title` or `icon` must be defined.',
},
{
required: ['icon'],
},
],
});
const content = '';
const result = await parseSetup(content);
expect(result[0].message).to.eq('Missing property "title".' + ' ' + 'At least one of `title` or `icon` must be defined.');
});

describe('filePatternAssociation', () => {
const schema = {
Expand Down