alm
Version:
The best IDE for TypeScript
528 lines (471 loc) • 18 kB
text/typescript
/**
* Based on https://github.com/Microsoft/vscode-json-languageservice/blob/master/src/services/jsonCompletion.ts
*
* - Redirected dependencies
* - I deleted stuff around `jsonContributions` (I have no idea what it is)
* - Changed TextModel => monaco.IModel
* - Removed any constructor parameters
*/
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
'use strict';
/** BAS the function that was provided by vscode-nls */
import {localize} from "../core/localize";
import Parser = require('../core/jsonParser');
import SchemaService = require('./jsonSchemaService');
import schemaService = require('./jsonSchemaService');
import {JSONSchema} from '../core/jsonSchema';
import Thenable = monaco.Thenable;
import PromiseConstructor = monaco.Promise;
import CompletionItem = monaco.languages.CompletionItem;
import CompletionItemKind = monaco.languages.CompletionItemKind;
import CompletionList = monaco.languages.CompletionList;
import TextDocument = monaco.editor.IReadOnlyModel;
import Position = monaco.Position;
import Range = monaco.Range;
/**
* BAS:
* https://github.com/Microsoft/vscode-json-languageservice/blob/master/src/jsonContributions.ts
*/
interface CompletionsCollector {
add(suggestion: CompletionItem): void;
error(message: string): void;
log(message: string): void;
setAsIncomplete(): void;
}
/**
* BAS: Was simple so I wrote it :)
*/
namespace TextEdit {
export function replace(range: Range, text: string):monaco.editor.ISingleEditOperation{
const result: monaco.editor.ISingleEditOperation = {
range: range,
text: text
};
return result;
}
}
export class JSONCompletion {
private promise = Promise;
constructor() {
}
public doComplete(document: TextDocument, position: Position, doc: Parser.JSONDocument): Thenable<CompletionList> {
let offset = document.getOffsetAt(position);
let node = doc.getNodeFromOffsetEndInclusive(offset);
let currentWord = this.getCurrentWord(document, offset);
let overwriteRange: Range = null;
let filterText = void 0;
let result: CompletionList = {
items: [],
isIncomplete: false
};
if (node && (node.type === 'string' || node.type === 'number' || node.type === 'boolean' || node.type === 'null')) {
const start = document.getPositionAt(node.start);
const end = document.getPositionAt(node.end);
overwriteRange = new Range(start.lineNumber,start.column,end.lineNumber,end.column);
filterText = document.getValue().substring(node.start, offset);
} else {
const start = document.getPositionAt(offset - currentWord.length);
const end = position;
overwriteRange = new Range(start.lineNumber,start.column,end.lineNumber,end.column);
filterText = document.getValue().substring(offset - currentWord.length, offset);
}
let proposed: { [key: string]: boolean } = {};
let collector: CompletionsCollector = {
add: (suggestion: CompletionItem) => {
if (!proposed[suggestion.label]) {
proposed[suggestion.label] = true;
if (overwriteRange) {
suggestion.textEdit = TextEdit.replace(overwriteRange, suggestion.insertText.toString());
suggestion.filterText = filterText;
}
result.items.push(suggestion);
}
},
setAsIncomplete: () => {
result.isIncomplete = true;
},
error: (message: string) => {
console.error(message);
},
log: (message: string) => {
console.log(message);
}
};
return schemaService.getSchemaForResource(document.filePath).then((schema) => {
let collectionPromises: Thenable<any>[] = [];
let addValue = true;
let currentKey = '';
let currentProperty: Parser.PropertyASTNode = null;
if (node) {
if (node.type === 'string') {
let stringNode = <Parser.StringASTNode>node;
if (stringNode.isKey) {
addValue = !(node.parent && ((<Parser.PropertyASTNode>node.parent).value));
currentProperty = node.parent ? <Parser.PropertyASTNode>node.parent : null;
currentKey = document.getValue().substring(node.start + 1, node.end - 1);
if (node.parent) {
node = node.parent.parent;
}
}
}
}
// proposals for properties
if (node && node.type === 'object') {
// don't suggest keys when the cursor is just before the opening curly brace
if (node.start === offset) {
return result;
}
// don't suggest properties that are already present
let properties = (<Parser.ObjectASTNode>node).properties;
properties.forEach(p => {
if (!currentProperty || currentProperty !== p) {
proposed[p.key.value] = true;
}
});
let isLast = properties.length === 0 || offset >= properties[properties.length - 1].start;
if (schema) {
// property proposals with schema
this.getPropertySuggestions(schema, doc, node, addValue, isLast, collector);
} else {
// property proposals without schema
this.getSchemaLessPropertySuggestions(doc, node, currentKey, currentWord, isLast, collector);
}
}
// proposals for values
if (node && (node.type === 'string' || node.type === 'number' || node.type === 'boolean' || node.type === 'null')) {
node = node.parent;
}
if (schema) {
// value proposals with schema
this.getValueSuggestions(schema, doc, node, offset, collector);
} else {
// value proposals without schema
this.getSchemaLessValueSuggestions(doc, node, offset, document, collector);
}
if (!node) {
} else {
if ((node.type === 'property') && offset > (<Parser.PropertyASTNode> node).colonOffset) {
let parentKey = (<Parser.PropertyASTNode>node).key.value;
let valueNode = (<Parser.PropertyASTNode> node).value;
if (!valueNode || offset <= valueNode.end) {
}
}
}
return this.promise.all(collectionPromises).then(() => result );
});
}
private getPropertySuggestions(schema: SchemaService.ResolvedSchema, doc: Parser.JSONDocument, node: Parser.ASTNode, addValue: boolean, isLast: boolean, collector: CompletionsCollector): void {
let matchingSchemas: Parser.IApplicableSchema[] = [];
doc.validate(schema.schema, matchingSchemas, node.start);
matchingSchemas.forEach((s) => {
if (s.node === node && !s.inverted) {
let schemaProperties = s.schema.properties;
if (schemaProperties) {
Object.keys(schemaProperties).forEach((key: string) => {
let propertySchema = schemaProperties[key];
collector.add({ kind: CompletionItemKind.Property, label: key, insertText: this.getTextForProperty(key, propertySchema, addValue, isLast), documentation: propertySchema.description || '' });
});
}
}
});
}
private getSchemaLessPropertySuggestions(doc: Parser.JSONDocument, node: Parser.ASTNode, currentKey: string, currentWord: string, isLast: boolean, collector: CompletionsCollector): void {
let collectSuggestionsForSimilarObject = (obj: Parser.ObjectASTNode) => {
obj.properties.forEach((p) => {
let key = p.key.value;
collector.add({ kind: CompletionItemKind.Property, label: key, insertText: this.getTextForSimilarProperty(key, p.value), documentation: '' });
});
};
if (node.parent) {
if (node.parent.type === 'property') {
// if the object is a property value, check the tree for other objects that hang under a property of the same name
let parentKey = (<Parser.PropertyASTNode>node.parent).key.value;
doc.visit((n) => {
if (n.type === 'property' && (<Parser.PropertyASTNode>n).key.value === parentKey && (<Parser.PropertyASTNode>n).value && (<Parser.PropertyASTNode>n).value.type === 'object') {
collectSuggestionsForSimilarObject(<Parser.ObjectASTNode>(<Parser.PropertyASTNode>n).value);
}
return true;
});
} else if (node.parent.type === 'array') {
// if the object is in an array, use all other array elements as similar objects
(<Parser.ArrayASTNode>node.parent).items.forEach((n) => {
if (n.type === 'object' && n !== node) {
collectSuggestionsForSimilarObject(<Parser.ObjectASTNode>n);
}
});
}
}
if (!currentKey && currentWord.length > 0) {
collector.add({ kind: CompletionItemKind.Property, label: this.getLabelForValue(currentWord), insertText: this.getTextForProperty(currentWord, null, true, isLast), documentation: '' });
}
}
private getSchemaLessValueSuggestions(doc: Parser.JSONDocument, node: Parser.ASTNode, offset: number, document: TextDocument, collector: CompletionsCollector): void {
let collectSuggestionsForValues = (value: Parser.ASTNode) => {
if (!value.contains(offset)) {
let content = this.getTextForMatchingNode(value, document);
collector.add({ kind: this.getSuggestionKind(value.type), label: content, insertText: content, documentation: '' });
}
if (value.type === 'boolean') {
this.addBooleanSuggestion(!value.getValue(), collector);
}
};
if (!node) {
collector.add({ kind: this.getSuggestionKind('object'), label: 'Empty object', insertText: '{\n\t{{}}\n}', documentation: '' });
collector.add({ kind: this.getSuggestionKind('array'), label: 'Empty array', insertText: '[\n\t{{}}\n]', documentation: '' });
} else {
if (node.type === 'property' && offset > (<Parser.PropertyASTNode>node).colonOffset) {
let valueNode = (<Parser.PropertyASTNode>node).value;
if (valueNode && offset > valueNode.end) {
return;
}
// suggest values at the same key
let parentKey = (<Parser.PropertyASTNode>node).key.value;
doc.visit((n) => {
if (n.type === 'property' && (<Parser.PropertyASTNode>n).key.value === parentKey && (<Parser.PropertyASTNode>n).value) {
collectSuggestionsForValues((<Parser.PropertyASTNode>n).value);
}
return true;
});
}
if (node.type === 'array') {
if (node.parent && node.parent.type === 'property') {
// suggest items of an array at the same key
let parentKey = (<Parser.PropertyASTNode>node.parent).key.value;
doc.visit((n) => {
if (n.type === 'property' && (<Parser.PropertyASTNode>n).key.value === parentKey && (<Parser.PropertyASTNode>n).value && (<Parser.PropertyASTNode>n).value.type === 'array') {
((<Parser.ArrayASTNode>(<Parser.PropertyASTNode>n).value).items).forEach((n) => {
collectSuggestionsForValues(<Parser.ObjectASTNode>n);
});
}
return true;
});
} else {
// suggest items in the same array
(<Parser.ArrayASTNode>node).items.forEach((n) => {
collectSuggestionsForValues(<Parser.ObjectASTNode>n);
});
}
}
}
}
private getValueSuggestions(schema: SchemaService.ResolvedSchema, doc: Parser.JSONDocument, node: Parser.ASTNode, offset: number, collector: CompletionsCollector): void {
if (!node) {
this.addDefaultSuggestion(schema.schema, collector);
} else {
let parentKey: string = null;
if (node && (node.type === 'property') && offset > (<Parser.PropertyASTNode>node).colonOffset) {
let valueNode = (<Parser.PropertyASTNode>node).value;
if (valueNode && offset > valueNode.end) {
return; // we are past the value node
}
parentKey = (<Parser.PropertyASTNode>node).key.value;
node = node.parent;
}
if (node && (parentKey !== null || node.type === 'array')) {
let matchingSchemas: Parser.IApplicableSchema[] = [];
doc.validate(schema.schema, matchingSchemas, node.start);
matchingSchemas.forEach((s) => {
if (s.node === node && !s.inverted && s.schema) {
if (s.schema.items) {
this.addDefaultSuggestion(s.schema.items as any, collector);
this.addEnumSuggestion(s.schema.items as any, collector);
}
if (s.schema.properties) {
let propertySchema = s.schema.properties[parentKey];
if (propertySchema) {
this.addDefaultSuggestion(propertySchema, collector);
this.addEnumSuggestion(propertySchema, collector);
}
}
}
});
}
}
}
private addBooleanSuggestion(value: boolean, collector: CompletionsCollector): void {
collector.add({ kind: this.getSuggestionKind('boolean'), label: value ? 'true' : 'false', insertText: this.getTextForValue(value), documentation: '' });
}
private addNullSuggestion(collector: CompletionsCollector): void {
collector.add({ kind: this.getSuggestionKind('null'), label: 'null', insertText: 'null', documentation: '' });
}
private addEnumSuggestion(schema: JSONSchema, collector: CompletionsCollector): void {
if (Array.isArray(schema.enum)) {
schema.enum.forEach((enm) => collector.add({ kind: this.getSuggestionKind(schema.type), label: this.getLabelForValue(enm), insertText: this.getTextForValue(enm), documentation: '' }));
} else {
if (this.isType(schema, 'boolean')) {
this.addBooleanSuggestion(true, collector);
this.addBooleanSuggestion(false, collector);
}
if (this.isType(schema, 'null')) {
this.addNullSuggestion(collector);
}
}
if (Array.isArray(schema.allOf)) {
schema.allOf.forEach((s) => this.addEnumSuggestion(s, collector));
}
if (Array.isArray(schema.anyOf)) {
schema.anyOf.forEach((s) => this.addEnumSuggestion(s, collector));
}
if (Array.isArray(schema.oneOf)) {
schema.oneOf.forEach((s) => this.addEnumSuggestion(s, collector));
}
}
private isType(schema: JSONSchema, type: string) {
if (Array.isArray(schema.type)) {
return schema.type.indexOf(type) !== -1;
}
return schema.type === type;
}
private addDefaultSuggestion(schema: JSONSchema, collector: CompletionsCollector): void {
if (schema.default) {
collector.add({
kind: this.getSuggestionKind(schema.type),
label: this.getLabelForValue(schema.default),
insertText: this.getTextForValue(schema.default),
detail: localize('json.suggest.default', 'Default value'),
});
}
if (Array.isArray(schema.defaultSnippets)) {
schema.defaultSnippets.forEach(s => {
collector.add({
kind: CompletionItemKind.Snippet,
label: this.getLabelForSnippetValue(s.body),
insertText: this.getTextForSnippetValue(s.body)
});
});
}
if (Array.isArray(schema.allOf)) {
schema.allOf.forEach((s) => this.addDefaultSuggestion(s, collector));
}
if (Array.isArray(schema.anyOf)) {
schema.anyOf.forEach((s) => this.addDefaultSuggestion(s, collector));
}
if (Array.isArray(schema.oneOf)) {
schema.oneOf.forEach((s) => this.addDefaultSuggestion(s, collector));
}
}
private getLabelForValue(value: any): string {
let label = JSON.stringify(value);
if (label.length > 57) {
return label.substr(0, 57).trim() + '...';
}
return label;
}
private getLabelForSnippetValue(value: any): string {
let label = JSON.stringify(value);
label = label.replace(/\{\{|\}\}/g, '');
if (label.length > 57) {
return label.substr(0, 57).trim() + '...';
}
return label;
}
private getTextForValue(value: any): string {
var text = JSON.stringify(value, null, '\t');
text = text.replace(/[\\\{\}]/g, '\\$&');
return text;
}
private getTextForSnippetValue(value: any): string {
return JSON.stringify(value, null, '\t');
}
private getTextForEnumValue(value: any): string {
let snippet = this.getTextForValue(value);
switch (typeof value) {
case 'object':
if (value === null) {
return '{{null}}';
}
return snippet;
case 'string':
return '"{{' + snippet.substr(1, snippet.length - 2) + '}}"';
case 'number':
case 'boolean':
return '{{' + snippet + '}}';
}
return snippet;
}
private getSuggestionKind(type: any): CompletionItemKind {
if (Array.isArray(type)) {
let array = <any[]>type;
type = array.length > 0 ? array[0] : null;
}
if (!type) {
return CompletionItemKind.Value;
}
switch (type) {
case 'string': return CompletionItemKind.Value;
case 'object': return CompletionItemKind.Module;
case 'property': return CompletionItemKind.Property;
default: return CompletionItemKind.Value;
}
}
private getTextForMatchingNode(node: Parser.ASTNode, document: TextDocument): string {
switch (node.type) {
case 'array':
return '[]';
case 'object':
return '{}';
default:
let content = document.getValue().substr(node.start, node.end - node.start);
return content;
}
}
private getTextForProperty(key: string, propertySchema: JSONSchema, addValue: boolean, isLast: boolean): string {
let result = this.getTextForValue(key);
if (!addValue) {
return result;
}
result += ': ';
if (propertySchema) {
let defaultVal = propertySchema.default;
if (typeof defaultVal !== 'undefined') {
result = result + this.getTextForEnumValue(defaultVal);
} else if (propertySchema.enum && propertySchema.enum.length > 0) {
result = result + this.getTextForEnumValue(propertySchema.enum[0]);
} else {
var type = Array.isArray(propertySchema.type) ? propertySchema.type[0] : propertySchema.type;
switch (type) {
case 'boolean':
result += '{{false}}';
break;
case 'string':
result += '"{{}}"';
break;
case 'object':
result += '{\n\t{{}}\n}';
break;
case 'array':
result += '[\n\t{{}}\n]';
break;
case 'number':
result += '{{0}}';
break;
case 'null':
result += '{{null}}';
break;
default:
return result;
}
}
} else {
result += '{{0}}';
}
if (!isLast) {
result += ',';
}
return result;
}
private getTextForSimilarProperty(key: string, templateValue: Parser.ASTNode): string {
return this.getTextForValue(key);
}
private getCurrentWord(document: TextDocument, offset: number) {
var i = offset - 1;
var text = document.getValue();
while (i >= 0 && ' \t\n\r\v":{[,'.indexOf(text.charAt(i)) === -1) {
i--;
}
return text.substring(i+1, offset);
}
}