vscode-json-languageservice
Version:
Language service for JSON
126 lines (125 loc) • 6.2 kB
JavaScript
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
(function (factory) {
if (typeof module === "object" && typeof module.exports === "object") {
var v = factory(require, exports);
if (v !== undefined) module.exports = v;
}
else if (typeof define === "function" && define.amd) {
define(["require", "exports", "../parser/jsonParser", "../jsonLanguageTypes"], factory);
}
})(function (require, exports) {
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.JSONHover = void 0;
const Parser = require("../parser/jsonParser");
const jsonLanguageTypes_1 = require("../jsonLanguageTypes");
class JSONHover {
constructor(schemaService, contributions = [], promiseConstructor) {
this.schemaService = schemaService;
this.contributions = contributions;
this.promise = promiseConstructor || Promise;
}
doHover(document, position, doc) {
const offset = document.offsetAt(position);
let node = doc.getNodeFromOffset(offset);
if (!node || (node.type === 'object' || node.type === 'array') && offset > node.offset + 1 && offset < node.offset + node.length - 1) {
return this.promise.resolve(null);
}
const hoverRangeNode = node;
// use the property description when hovering over an object key
if (node.type === 'string') {
const parent = node.parent;
if (parent && parent.type === 'property' && parent.keyNode === node) {
node = parent.valueNode;
if (!node) {
return this.promise.resolve(null);
}
}
}
const hoverRange = jsonLanguageTypes_1.Range.create(document.positionAt(hoverRangeNode.offset), document.positionAt(hoverRangeNode.offset + hoverRangeNode.length));
const createHover = (contents) => {
const result = {
contents: contents,
range: hoverRange
};
return result;
};
const location = Parser.getNodePath(node);
for (let i = this.contributions.length - 1; i >= 0; i--) {
const contribution = this.contributions[i];
const promise = contribution.getInfoContribution(document.uri, location);
if (promise) {
return promise.then(htmlContent => createHover(htmlContent));
}
}
return this.schemaService.getSchemaForResource(document.uri, doc).then((schema) => {
if (!schema) {
return null;
}
let title = undefined;
let markdownDescription = undefined;
let markdownEnumValueDescription = undefined, enumValue = undefined;
const matchingSchemas = doc.getMatchingSchemas(schema.schema, node.offset).filter((s) => s.node === node && !s.inverted).map((s) => s.schema);
for (const schema of matchingSchemas) {
title = title || schema.title;
markdownDescription = markdownDescription || schema.markdownDescription || toMarkdown(schema.description);
if (schema.enum) {
const idx = schema.enum.indexOf(Parser.getNodeValue(node));
if (schema.markdownEnumDescriptions) {
markdownEnumValueDescription = schema.markdownEnumDescriptions[idx];
}
else if (schema.enumDescriptions) {
markdownEnumValueDescription = toMarkdown(schema.enumDescriptions[idx]);
}
if (markdownEnumValueDescription) {
enumValue = schema.enum[idx];
if (typeof enumValue !== 'string') {
enumValue = JSON.stringify(enumValue);
}
}
}
}
let result = '';
if (title) {
result = toMarkdown(title);
}
if (markdownDescription) {
if (result.length > 0) {
result += "\n\n";
}
result += markdownDescription;
}
if (markdownEnumValueDescription) {
if (result.length > 0) {
result += "\n\n";
}
result += `\`${toMarkdownCodeBlock(enumValue)}\`: ${markdownEnumValueDescription}`;
}
return createHover([result]);
});
}
}
exports.JSONHover = JSONHover;
function toMarkdown(plain) {
if (plain) {
return plain
.trim()
.replace(/[\\`*_{}[\]()<>#+\-.!]/g, '\\$&') // escape markdown syntax tokens: http://daringfireball.net/projects/markdown/syntax#backslash
.replace(/(^ +)/mg, (_match, g1) => ' '.repeat(g1.length)) // escape leading spaces on each line
.replace(/( {2,})/g, (_match, g1) => ' ' + ' '.repeat(g1.length - 1)) // escape consecutive spaces
.replace(/(\t+)/g, (_match, g1) => ' '.repeat(g1.length * 4)) // escape tabs
.replace(/\n/g, '\\\n'); // escape new lines
}
return undefined;
}
function toMarkdownCodeBlock(content) {
// see https://daringfireball.net/projects/markdown/syntax#precode
if (content.indexOf('`') !== -1) {
return '`` ' + content + ' ``';
}
return content;
}
});