[json-language-features] Fix json/schemaAssociations parameters documentation

[rchl]

The json/schemaAssociations documentation is not accurate in stating
that the only supported parameter is an object in { pattern: uri }
format. It also supports the structure defined by SchemaConfiguration
interface from "vscode-json-languageservice".

Also updated the server code to match that.

This PR fixes #106060

[ghost]

All CLA requirements met.

[rchl]

schema property is also supported.
The type could be set to object if you didn't want to reference JSONSchema.

[rchl]

Wait, I see what you did there now.

It's no longer accurate again after your change...

[rchl]

This change was meant to describe two possible inputs for that notification:

1. An object form. Example:

{
  'foo.js': ['http://schemas.org/foo.json'],
  'bar.js': ['http://schemas.org/bar.json'],
}

2. An array form. Example:

[
  {
    fileMatch: ['foo.js'],
    uri: ['http://schemas.org/foo.json'],
  },
  {
    fileMatch: ['bar.js'],
    uri: ['http://schemas.org/bar.json'],
  },
]

With your change, we're back to just explaining the first form.

[rchl]

No, sorry, was confused by ISchemaAssociations/ISchemaAssociation[] naming. Thought that ISchemaAssociations is just an array of ISchemaAssociation and thus equivalent.

I'm just wondering why schema property was removed from the interface documentation.

[aeschli]

The json/schemaAssociations message is for the associations that come from the jsonValidation contribution point in vscode,
More associations can come the user settings. There you can have the schema.

See the Settings section in the readme.

[rchl]

The json/schemaAssociations message is for the associations that come from the jsonValidation contribution point in vscode,
More associations can come the user settings. There you can have the schema.

What is used in vscode is one thing but I'm talking about what this endpoint supports specifically.
Those are handled at https://github.com/microsoft/vscode-json-languageservice/blob/a5d6dfbfb6032fdfa5901c3e21409581e0d10f0a/src/jsonLanguageService.ts#L75-L75 and so also support schema object.

[aeschli]

That's the API of the service (vscode-json-languageservice)

The readme is for the server.

The server listens to the (LSP) configuration and schema association messagse (see here) and then configures the service with the sum of all configurations. (see here)

[rchl]

That's the API of the service (vscode-json-languageservice)

Here is what the server does:

vscode/extensions/json-language-features/server/src/jsonServer.ts

Lines 269 to 272 in 183d11a

	if (schemaAssociations) {
	if (Array.isArray(schemaAssociations)) {
	Array.prototype.push.apply(languageSettings.schemas, schemaAssociations);
	} else {

It just passes json/schemaAssociations-provided schemas as is to the service. That means the service will handle the schema property if it was provided by the user.

I also know about schemas passed through initialize request but that doesn't change the handling of json/schemaAssociations itself.

[aeschli]

Ok I see, that was not intentional.
First we had the map, then (since a few releases) the array. You can see from the map code that we haven't supported schema.
I want to leave it at that, and will make a code change to not simply copy the array.

[rchl]

I'm not against making that code more explicit but I don't see any reason to limit it to not pass schema property.
It's more consistent if it's supported both from that place and initialize request.

BTW. Also, semi-related, the schemas passed through initialize request require url property while those passed through json/schemaAssociations an uri property. That is inconsistent. It's always a URI really.

[aeschli]

Yes, the uri/url inconsistency is unhappy, it has historical reasons. As the url is part of user settings, change it is not trivial and could result in more confusion that clarity.

[aeschli]

I added the ISchemaAssociation.schema to the spec, after all. You are right, it's more consistent and makes it easier to configure the LS with schemas.

1b96024