improvements

This commit is contained in:
Martin Aeschlimann 2020-09-07 10:09:15 +02:00
parent 896dc31762
commit f0dea5ec85

View file

@ -143,34 +143,37 @@ In addition to the settings, schemas associations can also be provided through a
Notification:
- method: 'json/schemaAssociations'
- params: `ISchemaAssociations | SchemaConfiguration[]` defined as follows
- params: `ISchemaAssociations` or `ISchemaAssociation[]` defined as follows
```ts
/**
* 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;
interface ISchemaAssociations {
/**
* An object where:
* - keys are file names or file paths (using `/` as path separator). `*` can be used as a wildcard.
* - values are an arrays of schema URIs
*/
[pattern: string]: string[];
}
interface ISchemaAssociation {
/**
* 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[];
}
```
`ISchemaAssociations`
- 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'