vscode-json-languageservice 5.4.1 → 5.4.3

package/lib/esm/jsonSchema.d.ts

@@ -83,6 +83,7 @@ export interface JSONSchema {
     suggestSortText?: string;
     allowComments?: boolean;
     allowTrailingCommas?: boolean;
+    completionDetail?: string;
 }
 export interface JSONSchemaMap {
     [name: string]: JSONSchemaRef;

package/lib/esm/parser/jsonParser.js

@@ -164,6 +164,10 @@ export class ValidationResult {
     mergeEnumValues(validationResult) {
         if (!this.enumValueMatch && !validationResult.enumValueMatch && this.enumValues && validationResult.enumValues) {
             this.enumValues = this.enumValues.concat(validationResult.enumValues);
+        }
+    }
+    updateEnumMismatchProblemMessages() {
+        if (!this.enumValueMatch && this.enumValues) {
             for (const error of this.problems) {
                 if (error.code === ErrorCode.EnumValueMismatch) {
                     error.message = l10n.t('Value is not accepted. Valid values: {0}.', this.enumValues.map(v => JSON.stringify(v)).join(', '));
@@ -382,6 +386,7 @@ function validate(n, schema, validationResult, matchingSchemas, context) {
                 });
             }
             if (bestMatch) {
+                bestMatch.validationResult.updateEnumMismatchProblemMessages();
                 validationResult.merge(bestMatch.validationResult);
                 matchingSchemas.merge(bestMatch.matchingSchemas);
             }

package/lib/esm/services/configuration.js

@@ -460,8 +460,8 @@ export const schemaContributions = {
 const descriptions = {
     id: l10n.t("A unique identifier for the schema."),
     $schema: l10n.t("The schema to verify this document against."),
-    title: l10n.t("A descriptive title of the element."),
-    description: l10n.t("A long description of the element. Used in hover menus and suggestions."),
+    title: l10n.t("A descriptive title of the schema."),
+    description: l10n.t("A long description of the schema. Used in hover menus and suggestions."),
     default: l10n.t("A default value. Used by suggestions."),
     multipleOf: l10n.t("A number that should cleanly divide the current value (i.e. have no remainder)."),
     maximum: l10n.t("The maximum numerical value, inclusive by default."),
@@ -471,7 +471,7 @@ const descriptions = {
     maxLength: l10n.t("The maximum length of a string."),
     minLength: l10n.t("The minimum length of a string."),
     pattern: l10n.t("A regular expression to match the string against. It is not implicitly anchored."),
-    additionalItems: l10n.t("For arrays, only when items is set as an array. If it is a schema, then this schema validates items after the ones specified by the items array. If it is false, then additional items will cause validation to fail."),
+    additionalItems: l10n.t("For arrays, only when items is set as an array. If items are a schema, this schema validates items after the ones specified by the items schema. If false, additional items will cause validation to fail."),
     items: l10n.t("For arrays. Can either be a schema to validate every element against or an array of schemas to validate each item against in order (the first schema will validate the first element, the second schema will validate the second element, and so on."),
     maxItems: l10n.t("The maximum number of items that can be inside an array. Inclusive."),
     minItems: l10n.t("The minimum number of items that can be inside an array. Inclusive."),
@@ -479,14 +479,14 @@ const descriptions = {
     maxProperties: l10n.t("The maximum number of properties an object can have. Inclusive."),
     minProperties: l10n.t("The minimum number of properties an object can have. Inclusive."),
     required: l10n.t("An array of strings that lists the names of all properties required on this object."),
-    additionalProperties: l10n.t("Either a schema or a boolean. If a schema, then used to validate all properties not matched by 'properties' or 'patternProperties'. If false, then any properties not matched by either will cause this schema to fail."),
+    additionalProperties: l10n.t("Either a schema or a boolean. If a schema, used to validate all properties not matched by 'properties', 'propertyNames', or 'patternProperties'. If false, any properties not defined by the adajacent keywords will cause this schema to fail."),
     definitions: l10n.t("Not used for validation. Place subschemas here that you wish to reference inline with $ref."),
     properties: l10n.t("A map of property names to schemas for each property."),
     patternProperties: l10n.t("A map of regular expressions on property names to schemas for matching properties."),
     dependencies: l10n.t("A map of property names to either an array of property names or a schema. An array of property names means the property named in the key depends on the properties in the array being present in the object in order to be valid. If the value is a schema, then the schema is only applied to the object if the property in the key exists on the object."),
     enum: l10n.t("The set of literal values that are valid."),
     type: l10n.t("Either a string of one of the basic schema types (number, integer, null, array, object, boolean, string) or an array of strings specifying a subset of those types."),
-    format: l10n.t("Describes the format expected for the value."),
+    format: l10n.t("Describes the format expected for the value. By default, not used for validation"),
     allOf: l10n.t("An array of schemas, all of which must match."),
     anyOf: l10n.t("An array of schemas, where at least one must match."),
     oneOf: l10n.t("An array of schemas, exactly one of which must match."),
@@ -502,7 +502,7 @@ const descriptions = {
     contentMediaType: l10n.t("Describes the media type of a string property."),
     contentEncoding: l10n.t("Describes the content encoding of a string property."),
     if: l10n.t("The validation outcome of the \"if\" subschema controls which of the \"then\" or \"else\" keywords are evaluated."),
-    then: l10n.t("The \"if\" subschema is used for validation when the \"if\" subschema succeeds."),
+    then: l10n.t("The \"then\" subschema is used for validation when the \"if\" subschema succeeds."),
     else: l10n.t("The \"else\" subschema is used for validation when the \"if\" subschema fails.")
 };
 for (const schemaName in schemaContributions.schemas) {

package/lib/esm/services/jsonCompletion.js

@@ -205,8 +205,11 @@ export class JSONCompletion {
                                 insertText: this.getInsertTextForProperty(key, propertySchema, addValue, separatorAfter),
                                 insertTextFormat: InsertTextFormat.Snippet,
                                 filterText: this.getFilterTextForValue(key),
-                                documentation: this.fromMarkup(propertySchema.markdownDescription) || propertySchema.description || '',
+                                documentation: this.fromMarkup(propertySchema.markdownDescription) || propertySchema.description || ''
                             };
+                            if (propertySchema.completionDetail !== undefined) {
+                                proposal.detail = propertySchema.completionDetail;
+                            }
                             if (propertySchema.suggestSortText !== undefined) {
                                 proposal.sortText = propertySchema.suggestSortText;
                             }
@@ -229,8 +232,11 @@ export class JSONCompletion {
                             insertText: this.getInsertTextForProperty(name, undefined, addValue, separatorAfter),
                             insertTextFormat: InsertTextFormat.Snippet,
                             filterText: this.getFilterTextForValue(name),
-                            documentation: enumDescription || this.fromMarkup(schemaPropertyNames.markdownDescription) || schemaPropertyNames.description || '',
+                            documentation: enumDescription || this.fromMarkup(schemaPropertyNames.markdownDescription) || schemaPropertyNames.description || ''
                         };
+                        if (schemaPropertyNames.completionDetail !== undefined) {
+                            proposal.detail = schemaPropertyNames.completionDetail;
+                        }
                         if (schemaPropertyNames.suggestSortText !== undefined) {
                             proposal.sortText = schemaPropertyNames.suggestSortText;
                         }

package/lib/esm/services/jsonSchemaService.js

@@ -352,7 +352,7 @@ export class JSONSchemaService {
             }
         };
         const resolveExternalLink = (node, uri, refSegment, parentHandle) => {
-            if (contextService && !/^[A-Za-z][A-Za-z0-9+\-.+]*:\/\/.*/.test(uri)) {
+            if (contextService && !/^[A-Za-z][A-Za-z0-9+\-.+]*:\/.*/.test(uri)) {
                 uri = contextService.resolveRelativePath(uri, parentHandle.uri);
             }
             uri = normalizeId(uri);

package/lib/esm/utils/sort.js

@@ -321,12 +321,8 @@ function sortJsoncDocument(jsonDocument, propertyTree) {
     }
     return sortedJsonDocument;
 }
-function sortPropertiesCaseSensitive(properties) {
-    properties.sort((a, b) => {
-        const aName = a.propertyName ?? '';
-        const bName = b.propertyName ?? '';
-        return aName < bName ? -1 : aName > bName ? 1 : 0;
-    });
+function sortProperties(properties) {
+    properties.sort((a, b) => a.propertyName.localeCompare(b.propertyName));
 }
 function updateSortingQueue(queue, propertyTree, beginningLineNumber) {
     if (propertyTree.childrenProperties.length === 0) {
@@ -341,7 +337,7 @@ function updateSortingQueue(queue, propertyTree, beginningLineNumber) {
         }
         const diff = minimumBeginningLineNumber - propertyTree.beginningLineNumber;
         beginningLineNumber = beginningLineNumber + diff;
-        sortPropertiesCaseSensitive(propertyTree.childrenProperties);
+        sortProperties(propertyTree.childrenProperties);
         queue.push(new SortingRange(beginningLineNumber, propertyTree.childrenProperties));
     }
     else if (propertyTree.type === Container.Array) {

package/lib/umd/jsonSchema.d.ts

@@ -83,6 +83,7 @@ export interface JSONSchema {
     suggestSortText?: string;
     allowComments?: boolean;
     allowTrailingCommas?: boolean;
+    completionDetail?: string;
 }
 export interface JSONSchemaMap {
     [name: string]: JSONSchemaRef;

package/lib/umd/parser/jsonParser.js

@@ -190,6 +190,10 @@
         mergeEnumValues(validationResult) {
             if (!this.enumValueMatch && !validationResult.enumValueMatch && this.enumValues && validationResult.enumValues) {
                 this.enumValues = this.enumValues.concat(validationResult.enumValues);
+            }
+        }
+        updateEnumMismatchProblemMessages() {
+            if (!this.enumValueMatch && this.enumValues) {
                 for (const error of this.problems) {
                     if (error.code === jsonLanguageTypes_1.ErrorCode.EnumValueMismatch) {
                         error.message = l10n.t('Value is not accepted. Valid values: {0}.', this.enumValues.map(v => JSON.stringify(v)).join(', '));
@@ -410,6 +414,7 @@
                     });
                 }
                 if (bestMatch) {
+                    bestMatch.validationResult.updateEnumMismatchProblemMessages();
                     validationResult.merge(bestMatch.validationResult);
                     matchingSchemas.merge(bestMatch.matchingSchemas);
                 }

package/lib/umd/services/configuration.js

@@ -472,8 +472,8 @@
     const descriptions = {
         id: l10n.t("A unique identifier for the schema."),
         $schema: l10n.t("The schema to verify this document against."),
-        title: l10n.t("A descriptive title of the element."),
-        description: l10n.t("A long description of the element. Used in hover menus and suggestions."),
+        title: l10n.t("A descriptive title of the schema."),
+        description: l10n.t("A long description of the schema. Used in hover menus and suggestions."),
         default: l10n.t("A default value. Used by suggestions."),
         multipleOf: l10n.t("A number that should cleanly divide the current value (i.e. have no remainder)."),
         maximum: l10n.t("The maximum numerical value, inclusive by default."),
@@ -483,7 +483,7 @@
         maxLength: l10n.t("The maximum length of a string."),
         minLength: l10n.t("The minimum length of a string."),
         pattern: l10n.t("A regular expression to match the string against. It is not implicitly anchored."),
-        additionalItems: l10n.t("For arrays, only when items is set as an array. If it is a schema, then this schema validates items after the ones specified by the items array. If it is false, then additional items will cause validation to fail."),
+        additionalItems: l10n.t("For arrays, only when items is set as an array. If items are a schema, this schema validates items after the ones specified by the items schema. If false, additional items will cause validation to fail."),
         items: l10n.t("For arrays. Can either be a schema to validate every element against or an array of schemas to validate each item against in order (the first schema will validate the first element, the second schema will validate the second element, and so on."),
         maxItems: l10n.t("The maximum number of items that can be inside an array. Inclusive."),
         minItems: l10n.t("The minimum number of items that can be inside an array. Inclusive."),
@@ -491,14 +491,14 @@
         maxProperties: l10n.t("The maximum number of properties an object can have. Inclusive."),
         minProperties: l10n.t("The minimum number of properties an object can have. Inclusive."),
         required: l10n.t("An array of strings that lists the names of all properties required on this object."),
-        additionalProperties: l10n.t("Either a schema or a boolean. If a schema, then used to validate all properties not matched by 'properties' or 'patternProperties'. If false, then any properties not matched by either will cause this schema to fail."),
+        additionalProperties: l10n.t("Either a schema or a boolean. If a schema, used to validate all properties not matched by 'properties', 'propertyNames', or 'patternProperties'. If false, any properties not defined by the adajacent keywords will cause this schema to fail."),
         definitions: l10n.t("Not used for validation. Place subschemas here that you wish to reference inline with $ref."),
         properties: l10n.t("A map of property names to schemas for each property."),
         patternProperties: l10n.t("A map of regular expressions on property names to schemas for matching properties."),
         dependencies: l10n.t("A map of property names to either an array of property names or a schema. An array of property names means the property named in the key depends on the properties in the array being present in the object in order to be valid. If the value is a schema, then the schema is only applied to the object if the property in the key exists on the object."),
         enum: l10n.t("The set of literal values that are valid."),
         type: l10n.t("Either a string of one of the basic schema types (number, integer, null, array, object, boolean, string) or an array of strings specifying a subset of those types."),
-        format: l10n.t("Describes the format expected for the value."),
+        format: l10n.t("Describes the format expected for the value. By default, not used for validation"),
         allOf: l10n.t("An array of schemas, all of which must match."),
         anyOf: l10n.t("An array of schemas, where at least one must match."),
         oneOf: l10n.t("An array of schemas, exactly one of which must match."),
@@ -514,7 +514,7 @@
         contentMediaType: l10n.t("Describes the media type of a string property."),
         contentEncoding: l10n.t("Describes the content encoding of a string property."),
         if: l10n.t("The validation outcome of the \"if\" subschema controls which of the \"then\" or \"else\" keywords are evaluated."),
-        then: l10n.t("The \"if\" subschema is used for validation when the \"if\" subschema succeeds."),
+        then: l10n.t("The \"then\" subschema is used for validation when the \"if\" subschema succeeds."),
         else: l10n.t("The \"else\" subschema is used for validation when the \"if\" subschema fails.")
     };
     for (const schemaName in exports.schemaContributions.schemas) {

package/lib/umd/services/jsonCompletion.js

@@ -217,8 +217,11 @@
                                     insertText: this.getInsertTextForProperty(key, propertySchema, addValue, separatorAfter),
                                     insertTextFormat: jsonLanguageTypes_1.InsertTextFormat.Snippet,
                                     filterText: this.getFilterTextForValue(key),
-                                    documentation: this.fromMarkup(propertySchema.markdownDescription) || propertySchema.description || '',
+                                    documentation: this.fromMarkup(propertySchema.markdownDescription) || propertySchema.description || ''
                                 };
+                                if (propertySchema.completionDetail !== undefined) {
+                                    proposal.detail = propertySchema.completionDetail;
+                                }
                                 if (propertySchema.suggestSortText !== undefined) {
                                     proposal.sortText = propertySchema.suggestSortText;
                                 }
@@ -241,8 +244,11 @@
                                 insertText: this.getInsertTextForProperty(name, undefined, addValue, separatorAfter),
                                 insertTextFormat: jsonLanguageTypes_1.InsertTextFormat.Snippet,
                                 filterText: this.getFilterTextForValue(name),
-                                documentation: enumDescription || this.fromMarkup(schemaPropertyNames.markdownDescription) || schemaPropertyNames.description || '',
+                                documentation: enumDescription || this.fromMarkup(schemaPropertyNames.markdownDescription) || schemaPropertyNames.description || ''
                             };
+                            if (schemaPropertyNames.completionDetail !== undefined) {
+                                proposal.detail = schemaPropertyNames.completionDetail;
+                            }
                             if (schemaPropertyNames.suggestSortText !== undefined) {
                                 proposal.sortText = schemaPropertyNames.suggestSortText;
                             }

package/lib/umd/services/jsonSchemaService.js

@@ -366,7 +366,7 @@
                 }
             };
             const resolveExternalLink = (node, uri, refSegment, parentHandle) => {
-                if (contextService && !/^[A-Za-z][A-Za-z0-9+\-.+]*:\/\/.*/.test(uri)) {
+                if (contextService && !/^[A-Za-z][A-Za-z0-9+\-.+]*:\/.*/.test(uri)) {
                     uri = contextService.resolveRelativePath(uri, parentHandle.uri);
                 }
                 uri = normalizeId(uri);

package/lib/umd/utils/sort.js

@@ -333,12 +333,8 @@
         }
         return sortedJsonDocument;
     }
-    function sortPropertiesCaseSensitive(properties) {
-        properties.sort((a, b) => {
-            const aName = a.propertyName ?? '';
-            const bName = b.propertyName ?? '';
-            return aName < bName ? -1 : aName > bName ? 1 : 0;
-        });
+    function sortProperties(properties) {
+        properties.sort((a, b) => a.propertyName.localeCompare(b.propertyName));
     }
     function updateSortingQueue(queue, propertyTree, beginningLineNumber) {
         if (propertyTree.childrenProperties.length === 0) {
@@ -353,7 +349,7 @@
             }
             const diff = minimumBeginningLineNumber - propertyTree.beginningLineNumber;
             beginningLineNumber = beginningLineNumber + diff;
-            sortPropertiesCaseSensitive(propertyTree.childrenProperties);
+            sortProperties(propertyTree.childrenProperties);
             queue.push(new SortingRange(beginningLineNumber, propertyTree.childrenProperties));
         }
         else if (propertyTree.type === propertyTree_1.Container.Array) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vscode-json-languageservice",
-  "version": "5.4.1",
+  "version": "5.4.3",
   "description": "Language service for JSON",
   "main": "./lib/umd/jsonLanguageService.js",
   "typings": "./lib/umd/jsonLanguageService",
@@ -15,15 +15,15 @@
     "url": "https://github.com/Microsoft/vscode-json-languageservice"
   },
   "devDependencies": {
-    "@types/mocha": "^10.0.7",
+    "@types/mocha": "^10.0.10",
     "@types/node": "18.x",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-  "eslint": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^8.22.0",
+    "@typescript-eslint/parser": "^8.22.0",
+  "eslint": "^9.19.0",
     "json-schema-test-suite": "https://github.com/json-schema-org/JSON-Schema-Test-Suite.git#69acf52990b004240839ae19b4bec8fb01d50876",
-    "mocha": "^10.7.3",
+    "mocha": "^11.1.0",
     "rimraf": "^6.0.1",
-    "typescript": "^5.5.4"
+    "typescript": "^5.7.3"
   },
   "dependencies": {
     "jsonc-parser": "^3.3.1",