Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add label for scheme contributions #315

Merged
merged 2 commits into from
Jul 16, 2020
Merged

Add label for scheme contributions #315

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
428823d
#267 add label for scheme contributions
evidolob Jul 15, 2020
44359b1
fix import
evidolob Jul 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 91 additions & 65 deletions src/schema-extension-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,74 +1,87 @@
import { URI } from 'vscode-uri'
import { LanguageClient, RequestType } from 'vscode-languageclient';
import { workspace } from 'vscode';

interface SchemaContributorProvider {
readonly requestSchema: (resource: string) => string;
readonly requestSchemaContent: (uri: string) => string;
readonly requestSchema: (resource: string) => string;
readonly requestSchemaContent: (uri: string) => string;
readonly label?: string;
}

export enum MODIFICATION_ACTIONS {
'delete',
'add'
'delete',
'add'
}

export interface SchemaAdditions {
schema: string,
action: MODIFICATION_ACTIONS.add,
path: string,
key: string,
content: any
schema: string,
action: MODIFICATION_ACTIONS.add,
path: string,
key: string,
content: any
}

export interface SchemaDeletions {
schema: string,
action: MODIFICATION_ACTIONS.delete,
path: string,
key: string
schema: string,
action: MODIFICATION_ACTIONS.delete,
path: string,
key: string
}

namespace SchemaModificationNotification {
export const type: RequestType<SchemaAdditions | SchemaDeletions, void, { }, { }> = new RequestType('json/schema/modify');
export const type: RequestType<SchemaAdditions | SchemaDeletions, void, {}, {}> = new RequestType('json/schema/modify');
}

export interface ExtensionAPI {
registerContributor(schema: string, requestSchema: (resource: string) => string, requestSchemaContent: (uri: string) => string): boolean;
modifySchemaContent(schemaModifications: SchemaAdditions | SchemaDeletions): Promise<void>;
registerContributor(schema: string, requestSchema: (resource: string) => string, requestSchemaContent: (uri: string) => string, label?: string): boolean;
modifySchemaContent(schemaModifications: SchemaAdditions | SchemaDeletions): Promise<void>;
}

class SchemaExtensionAPI implements ExtensionAPI {
private _customSchemaContributors: { [index: string]: SchemaContributorProvider } = {};
private _yamlClient: LanguageClient;
private _customSchemaContributors: { [index: string]: SchemaContributorProvider } = {};
private _yamlClient: LanguageClient;

constructor(client: LanguageClient) {
this._yamlClient = client;
}
constructor(client: LanguageClient) {
this._yamlClient = client;
}

/**
* Register a custom schema provider
*
* @param {string} the provider's name
* @param requestSchema the requestSchema function
* @param requestSchemaContent the requestSchemaContent function
* @param label the content label, yaml key value pair, like 'apiVersion:some.api/v1'
* @returns {boolean}
*/
public registerContributor(schema: string,
requestSchema: (resource: string) => string,
requestSchemaContent: (uri: string) => string): boolean {
if (this._customSchemaContributors[schema]) {
return false;
}

if (!requestSchema) {
throw new Error("Illegal parameter for requestSchema.");
}

this._customSchemaContributors[schema] = <SchemaContributorProvider>{
requestSchema,
requestSchemaContent
};

return true;
}
public registerContributor(schema: string,
requestSchema: (resource: string) => string,
requestSchemaContent: (uri: string) => string,
label?: string): boolean {
if (this._customSchemaContributors[schema]) {
return false;
}

if (!requestSchema) {
throw new Error("Illegal parameter for requestSchema.");
}

if (label) {
let [first, second] = label.split(':');
if (first && second) {
second = second.trim();
second = second.replace('.', '\\.');
label = `${first}:[\t ]+${second}`;
}
}
this._customSchemaContributors[schema] = <SchemaContributorProvider>{
requestSchema,
requestSchemaContent,
label
};

return true;
}

/**
* Call requestSchema for each provider and finds all matches.
Expand All @@ -77,42 +90,55 @@ class SchemaExtensionAPI implements ExtensionAPI {
* @returns {string} the schema uri
*/
public requestCustomSchema(resource: string): string[] {
const matches = [];
for (let customKey of Object.keys(this._customSchemaContributors)) {
const contributor = this._customSchemaContributors[customKey];
const uri = contributor.requestSchema(resource);

if (uri) {
matches.push(uri);
}
}
return matches;
}
const matches = [];
for (let customKey of Object.keys(this._customSchemaContributors)) {
const contributor = this._customSchemaContributors[customKey];
let uri: string;
if (contributor.label && workspace.textDocuments) {
const labelRegexp = new RegExp(contributor.label, 'g');
for (const doc of workspace.textDocuments) {
if (doc.uri.toString() === resource) {
if (labelRegexp.test(doc.getText())) {
uri = contributor.requestSchema(resource);
return [uri];
}
}
}
}

uri = contributor.requestSchema(resource);

if (uri) {
matches.push(uri);
}
}
return matches;
}

/**
* Call requestCustomSchemaContent for named provider and get the schema content.
*
* @param {string} uri the schema uri returned from requestSchema.
* @returns {string} the schema content
*/
public requestCustomSchemaContent(uri: string): string {
if (uri) {
let _uri = URI.parse(uri);

if (_uri.scheme && this._customSchemaContributors[_uri.scheme] &&
this._customSchemaContributors[_uri.scheme].requestSchemaContent) {
return this._customSchemaContributors[_uri.scheme].requestSchemaContent(uri);
}
}
}

public async modifySchemaContent(schemaModifications: SchemaAdditions | SchemaDeletions) {
return this._yamlClient.sendRequest(SchemaModificationNotification.type, schemaModifications);
}
public requestCustomSchemaContent(uri: string): string {
if (uri) {
let _uri = URI.parse(uri);

if (_uri.scheme && this._customSchemaContributors[_uri.scheme] &&
this._customSchemaContributors[_uri.scheme].requestSchemaContent) {
return this._customSchemaContributors[_uri.scheme].requestSchemaContent(uri);
}
}
}

public async modifySchemaContent(schemaModifications: SchemaAdditions | SchemaDeletions) {
return this._yamlClient.sendRequest(SchemaModificationNotification.type, schemaModifications);
}
}

// constants
export const CUSTOM_SCHEMA_REQUEST = 'custom/schema/request';
export const CUSTOM_CONTENT_REQUEST = 'custom/schema/content';

export { SchemaExtensionAPI };
export { SchemaExtensionAPI };