vscode-json-languageservice 5.1.3 → 5.2.0

package/CHANGELOG.md

@@ -1,4 +1,8 @@
-5.2.0 / 2022-08/19
+5.2.0 / 2023-02-02
+================
+ * Added `SchemaConfiguration.folderUri` for folder-specific schema associations
+
+5.1.1 / 2022-08/19
 ================
 * new type `SchemaDraft`, representing the offical JSON schema draft versions
 * new property `DocumentLanguageSettings.schemaDraft` to specify the schema version to use, if the schema does not contain a `$schema` property

package/lib/esm/jsonLanguageService.js

@@ -26,11 +26,7 @@ export function getLanguageService(params) {
     return {
         configure: (settings) => {
             jsonSchemaService.clearExternalSchemas();
-            if (settings.schemas) {
-                settings.schemas.forEach(settings => {
-                    jsonSchemaService.registerExternalSchema(settings.uri, settings.fileMatch, settings.schema);
-                });
-            }
+            settings.schemas?.forEach(jsonSchemaService.registerExternalSchema.bind(jsonSchemaService));
             jsonValidation.configure(settings);
         },
         resetSchema: (uri) => jsonSchemaService.onResourceChange(uri),

package/lib/esm/jsonLanguageTypes.d.ts

@@ -141,6 +141,11 @@ export interface SchemaConfiguration {
      * If no schema is provided, the schema will be fetched with the schema request service (if available).
      */
     schema?: JSONSchema;
+    /**
+     * A parent folder for folder specifc associations. An association that has a folder URI set is only used
+     * if the document that is validated has the folderUri as parent
+     */
+    folderUri?: string;
 }
 export interface WorkspaceContextService {
     resolveRelativePath(relativePath: string, resource: string): string;

package/lib/esm/parser/jsonParser.js

@@ -330,7 +330,7 @@ function validate(n, schema, validationResult, matchingSchemas, context) {
             if (!subValidationResult.hasProblems()) {
                 validationResult.problems.push({
                     location: { offset: node.offset, length: node.length },
-                    message: l10n.t("Matches a schema that is not allowed.")
+                    message: schema.errorMessage || l10n.t("Matches a schema that is not allowed.")
                 });
             }
             for (const ms of subMatchingSchemas.schemas) {

package/lib/esm/services/jsonSchemaService.js

@@ -12,7 +12,9 @@ import { isObject, isString } from '../utils/objects';
 const BANG = '!';
 const PATH_SEP = '/';
 class FilePatternAssociation {
-    constructor(pattern, uris) {
+    constructor(pattern, folderUri, uris) {
+        this.folderUri = folderUri;
+        this.uris = uris;
         this.globWrappers = [];
         try {
             for (let patternString of pattern) {
@@ -31,7 +33,9 @@ class FilePatternAssociation {
                 }
             }
             ;
-            this.uris = uris;
+            if (folderUri && !folderUri.endsWith('/')) {
+                this.folderUri = folderUri + '/';
+            }
         }
         catch (e) {
             this.globWrappers.length = 0;
@@ -39,6 +43,9 @@ class FilePatternAssociation {
         }
     }
     matchesPattern(fileName) {
+        if (this.folderUri && !fileName.startsWith(this.folderUri)) {
+            return false;
+        }
         let match = false;
         for (const { regexp, include } of this.globWrappers) {
             if (regexp.test(fileName)) {
@@ -199,7 +206,7 @@ export class JSONSchemaService {
             const schemaAssociations = schemaContributions.schemaAssociations;
             for (let schemaAssociation of schemaAssociations) {
                 const uris = schemaAssociation.uris.map(normalizeId);
-                const association = this.addFilePatternAssociation(schemaAssociation.pattern, uris);
+                const association = this.addFilePatternAssociation(schemaAssociation.pattern, schemaAssociation.folderUri, uris);
                 this.contributionAssociations.push(association);
             }
         }
@@ -212,19 +219,19 @@ export class JSONSchemaService {
     getOrAddSchemaHandle(id, unresolvedSchemaContent) {
         return this.schemasById[id] || this.addSchemaHandle(id, unresolvedSchemaContent);
     }
-    addFilePatternAssociation(pattern, uris) {
-        const fpa = new FilePatternAssociation(pattern, uris);
+    addFilePatternAssociation(pattern, folderUri, uris) {
+        const fpa = new FilePatternAssociation(pattern, folderUri, uris);
         this.filePatternAssociations.push(fpa);
         return fpa;
     }
-    registerExternalSchema(uri, filePatterns, unresolvedSchemaContent) {
-        const id = normalizeId(uri);
+    registerExternalSchema(config) {
+        const id = normalizeId(config.uri);
         this.registeredSchemasIds[id] = true;
         this.cachedSchemaForResource = undefined;
-        if (filePatterns) {
-            this.addFilePatternAssociation(filePatterns, [id]);
+        if (config.fileMatch && config.fileMatch.length) {
+            this.addFilePatternAssociation(config.fileMatch, config.folderUri, [id]);
         }
-        return unresolvedSchemaContent ? this.addSchemaHandle(id, unresolvedSchemaContent) : this.getOrAddSchemaHandle(id);
+        return config.schema ? this.addSchemaHandle(id, config.schema) : this.getOrAddSchemaHandle(id);
     }
     clearExternalSchemas() {
         this.schemasById = {};

package/lib/esm/services/jsonValidation.js

@@ -89,8 +89,8 @@ export class JSONValidation {
             return diagnostics;
         };
         if (schema) {
-            const id = schema.id || ('schemaservice://untitled/' + idCounter++);
-            const handle = this.jsonSchemaService.registerExternalSchema(id, [], schema);
+            const uri = schema.id || ('schemaservice://untitled/' + idCounter++);
+            const handle = this.jsonSchemaService.registerExternalSchema({ uri, schema });
             return handle.getResolvedSchema().then(resolvedSchema => {
                 return getDiagnostics(resolvedSchema);
             });

package/lib/umd/jsonLanguageService.js

@@ -52,11 +52,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
         return {
             configure: (settings) => {
                 jsonSchemaService.clearExternalSchemas();
-                if (settings.schemas) {
-                    settings.schemas.forEach(settings => {
-                        jsonSchemaService.registerExternalSchema(settings.uri, settings.fileMatch, settings.schema);
-                    });
-                }
+                settings.schemas?.forEach(jsonSchemaService.registerExternalSchema.bind(jsonSchemaService));
                 jsonValidation.configure(settings);
             },
             resetSchema: (uri) => jsonSchemaService.onResourceChange(uri),

package/lib/umd/jsonLanguageTypes.d.ts

@@ -141,6 +141,11 @@ export interface SchemaConfiguration {
      * If no schema is provided, the schema will be fetched with the schema request service (if available).
      */
     schema?: JSONSchema;
+    /**
+     * A parent folder for folder specifc associations. An association that has a folder URI set is only used
+     * if the document that is validated has the folderUri as parent
+     */
+    folderUri?: string;
 }
 export interface WorkspaceContextService {
     resolveRelativePath(relativePath: string, resource: string): string;

package/lib/umd/parser/jsonParser.js

@@ -357,7 +357,7 @@
                 if (!subValidationResult.hasProblems()) {
                     validationResult.problems.push({
                         location: { offset: node.offset, length: node.length },
-                        message: l10n.t("Matches a schema that is not allowed.")
+                        message: schema.errorMessage || l10n.t("Matches a schema that is not allowed.")
                     });
                 }
                 for (const ms of subMatchingSchemas.schemas) {

package/lib/umd/services/jsonSchemaService.js

@@ -24,7 +24,9 @@
     const BANG = '!';
     const PATH_SEP = '/';
     class FilePatternAssociation {
-        constructor(pattern, uris) {
+        constructor(pattern, folderUri, uris) {
+            this.folderUri = folderUri;
+            this.uris = uris;
             this.globWrappers = [];
             try {
                 for (let patternString of pattern) {
@@ -43,7 +45,9 @@
                     }
                 }
                 ;
-                this.uris = uris;
+                if (folderUri && !folderUri.endsWith('/')) {
+                    this.folderUri = folderUri + '/';
+                }
             }
             catch (e) {
                 this.globWrappers.length = 0;
@@ -51,6 +55,9 @@
             }
         }
         matchesPattern(fileName) {
+            if (this.folderUri && !fileName.startsWith(this.folderUri)) {
+                return false;
+            }
             let match = false;
             for (const { regexp, include } of this.globWrappers) {
                 if (regexp.test(fileName)) {
@@ -213,7 +220,7 @@
                 const schemaAssociations = schemaContributions.schemaAssociations;
                 for (let schemaAssociation of schemaAssociations) {
                     const uris = schemaAssociation.uris.map(normalizeId);
-                    const association = this.addFilePatternAssociation(schemaAssociation.pattern, uris);
+                    const association = this.addFilePatternAssociation(schemaAssociation.pattern, schemaAssociation.folderUri, uris);
                     this.contributionAssociations.push(association);
                 }
             }
@@ -226,19 +233,19 @@
         getOrAddSchemaHandle(id, unresolvedSchemaContent) {
             return this.schemasById[id] || this.addSchemaHandle(id, unresolvedSchemaContent);
         }
-        addFilePatternAssociation(pattern, uris) {
-            const fpa = new FilePatternAssociation(pattern, uris);
+        addFilePatternAssociation(pattern, folderUri, uris) {
+            const fpa = new FilePatternAssociation(pattern, folderUri, uris);
             this.filePatternAssociations.push(fpa);
             return fpa;
         }
-        registerExternalSchema(uri, filePatterns, unresolvedSchemaContent) {
-            const id = normalizeId(uri);
+        registerExternalSchema(config) {
+            const id = normalizeId(config.uri);
             this.registeredSchemasIds[id] = true;
             this.cachedSchemaForResource = undefined;
-            if (filePatterns) {
-                this.addFilePatternAssociation(filePatterns, [id]);
+            if (config.fileMatch && config.fileMatch.length) {
+                this.addFilePatternAssociation(config.fileMatch, config.folderUri, [id]);
             }
-            return unresolvedSchemaContent ? this.addSchemaHandle(id, unresolvedSchemaContent) : this.getOrAddSchemaHandle(id);
+            return config.schema ? this.addSchemaHandle(id, config.schema) : this.getOrAddSchemaHandle(id);
         }
         clearExternalSchemas() {
             this.schemasById = {};

package/lib/umd/services/jsonValidation.js

@@ -101,8 +101,8 @@
                 return diagnostics;
             };
             if (schema) {
-                const id = schema.id || ('schemaservice://untitled/' + idCounter++);
-                const handle = this.jsonSchemaService.registerExternalSchema(id, [], schema);
+                const uri = schema.id || ('schemaservice://untitled/' + idCounter++);
+                const handle = this.jsonSchemaService.registerExternalSchema({ uri, schema });
                 return handle.getResolvedSchema().then(resolvedSchema => {
                     return getDiagnostics(resolvedSchema);
                 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vscode-json-languageservice",
-  "version": "5.1.3",
+  "version": "5.2.0",
   "description": "Language service for JSON",
   "main": "./lib/umd/jsonLanguageService.js",
   "typings": "./lib/umd/jsonLanguageService",
@@ -15,22 +15,22 @@
     "url": "https://github.com/Microsoft/vscode-json-languageservice"
   },
   "devDependencies": {
-    "@types/mocha": "^10.0.0",
+    "@types/mocha": "^10.0.1",
     "@types/node": "16.x",
-    "@typescript-eslint/eslint-plugin": "^5.44.0",
-    "@typescript-eslint/parser": "^5.44.0",
-    "eslint": "^8.28.0",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2",
+    "eslint": "^8.32.0",
     "json-schema-test-suite": "https://github.com/json-schema-org/JSON-Schema-Test-Suite.git#69acf52990b004240839ae19b4bec8fb01d50876",
-    "mocha": "^10.1.0",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.9.3"
+    "mocha": "^10.2.0",
+    "rimraf": "^4.1.1",
+    "typescript": "^4.9.4"
   },
   "dependencies": {
     "jsonc-parser": "^3.2.0",
-    "vscode-languageserver-textdocument": "^1.0.7",
+    "vscode-languageserver-textdocument": "^1.0.8",
     "vscode-languageserver-types": "^3.17.2",
-    "vscode-uri": "^3.0.6",
-    "@vscode/l10n": "^0.0.10"
+    "vscode-uri": "^3.0.7",
+    "@vscode/l10n": "^0.0.11"
   },
   "scripts": {
     "prepack": "npm run clean && npm run compile-esm && npm run test && npm run remove-sourcemap-refs",