development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-08-27 13:00:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse source 
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.

Resolves #106060
This commit is contained in:
Rafał Chłodnicki 2020-09-03 19:57:02 +02:00
parent 616afa93e2
commit 896dc31762
2 changed files with 27 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
extensions/json-language-features/server/README.md
View file

@ -143,15 +143,34 @@ In addition to the settings, schemas associations can also be provided through a
Notification:
- method: 'json/schemaAssociations'
- params: `ISchemaAssociations` defined as follows
- params: `ISchemaAssociations | SchemaConfiguration[]` defined as follows
```ts
interface ISchemaAssociations {
[pattern: string]: string[];
/**
* An object where:
* - keys are file names or file paths (separated by `/`). `*` can be used as a wildcard.
* - values ar an arrays of schema URLs
*/
type ISchemaAssociations = Record<string, string[]>
interface SchemaConfiguration {
/**
* The URI of the schema, which is also the identifier of the schema.
*/
uri: string;
/**
* A list of file path patterns that are associated to the schema. The '*' wildcard can be used. Exclusion patterns starting with '!'.
* For example '*.schema.json', 'package.json', '!foo*.schema.json'.
* A match succeeds when there is at least one pattern matching and last matching pattern does not start with '!'.
*/
fileMatch?: string[];
/**
* The schema for the given URI.
* If no schema is provided, the schema will be fetched with the schema request service (if available).
*/
schema?: JSONSchema;
}
```
- keys: a file names or file path (separated by `/`). `*` can be used as a wildcard.
- values: An array of schema URLs
Notification:
- method: 'json/schemaContent'

13
extensions/json-language-features/server/src/jsonServer.ts
View file

@ -14,17 +14,10 @@ import { TextDocument, JSONDocument, JSONSchema, getLanguageService, DocumentLan
import { getLanguageModelCache } from './languageModelCache';
import { RequestService, basename, resolvePath } from './requests';
interface ISchemaAssociations {
[pattern: string]: string[];
}
interface ISchemaAssociation {
fileMatch: string[];
uri: string;
}
type ISchemaAssociations = Record<string, string[]>;
namespace SchemaAssociationNotification {
export const type: NotificationType<ISchemaAssociations | ISchemaAssociation[], any> = new NotificationType('json/schemaAssociations');
export const type: NotificationType<ISchemaAssociations | SchemaConfiguration[], any> = new NotificationType('json/schemaAssociations');
}
namespace VSCodeContentRequest {
@ -212,7 +205,7 @@ export function startServer(connection: Connection, runtime: RuntimeEnvironment)
}();
let jsonConfigurationSettings: JSONSchemaSettings[] | undefined = undefined;
let schemaAssociations: ISchemaAssociations | ISchemaAssociation[] | undefined = undefined;
let schemaAssociations: ISchemaAssociations | SchemaConfiguration[] | undefined = undefined;
let formatterRegistration: Thenable<Disposable> | null = null;
// The settings have changed. Is send on server activation as well.