vscode-json-languageservice 4.1.8

package/lib/esm/services/jsonDocumentSymbols.js

@@ -0,0 +1,278 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import * as Parser from '../parser/jsonParser';
+import * as Strings from '../utils/strings';
+import { colorFromHex } from '../utils/colors';
+import { Range, TextEdit, SymbolKind, Location } from "../jsonLanguageTypes";
+var JSONDocumentSymbols = /** @class */ (function () {
+    function JSONDocumentSymbols(schemaService) {
+        this.schemaService = schemaService;
+    }
+    JSONDocumentSymbols.prototype.findDocumentSymbols = function (document, doc, context) {
+        var _this = this;
+        if (context === void 0) { context = { resultLimit: Number.MAX_VALUE }; }
+        var root = doc.root;
+        if (!root) {
+            return [];
+        }
+        var limit = context.resultLimit || Number.MAX_VALUE;
+        // special handling for key bindings
+        var resourceString = document.uri;
+        if ((resourceString === 'vscode://defaultsettings/keybindings.json') || Strings.endsWith(resourceString.toLowerCase(), '/user/keybindings.json')) {
+            if (root.type === 'array') {
+                var result_1 = [];
+                for (var _i = 0, _a = root.items; _i < _a.length; _i++) {
+                    var item = _a[_i];
+                    if (item.type === 'object') {
+                        for (var _b = 0, _c = item.properties; _b < _c.length; _b++) {
+                            var property = _c[_b];
+                            if (property.keyNode.value === 'key' && property.valueNode) {
+                                var location = Location.create(document.uri, getRange(document, item));
+                                result_1.push({ name: Parser.getNodeValue(property.valueNode), kind: SymbolKind.Function, location: location });
+                                limit--;
+                                if (limit <= 0) {
+                                    if (context && context.onResultLimitExceeded) {
+                                        context.onResultLimitExceeded(resourceString);
+                                    }
+                                    return result_1;
+                                }
+                            }
+                        }
+                    }
+                }
+                return result_1;
+            }
+        }
+        var toVisit = [
+            { node: root, containerName: '' }
+        ];
+        var nextToVisit = 0;
+        var limitExceeded = false;
+        var result = [];
+        var collectOutlineEntries = function (node, containerName) {
+            if (node.type === 'array') {
+                node.items.forEach(function (node) {
+                    if (node) {
+                        toVisit.push({ node: node, containerName: containerName });
+                    }
+                });
+            }
+            else if (node.type === 'object') {
+                node.properties.forEach(function (property) {
+                    var valueNode = property.valueNode;
+                    if (valueNode) {
+                        if (limit > 0) {
+                            limit--;
+                            var location = Location.create(document.uri, getRange(document, property));
+                            var childContainerName = containerName ? containerName + '.' + property.keyNode.value : property.keyNode.value;
+                            result.push({ name: _this.getKeyLabel(property), kind: _this.getSymbolKind(valueNode.type), location: location, containerName: containerName });
+                            toVisit.push({ node: valueNode, containerName: childContainerName });
+                        }
+                        else {
+                            limitExceeded = true;
+                        }
+                    }
+                });
+            }
+        };
+        // breath first traversal
+        while (nextToVisit < toVisit.length) {
+            var next = toVisit[nextToVisit++];
+            collectOutlineEntries(next.node, next.containerName);
+        }
+        if (limitExceeded && context && context.onResultLimitExceeded) {
+            context.onResultLimitExceeded(resourceString);
+        }
+        return result;
+    };
+    JSONDocumentSymbols.prototype.findDocumentSymbols2 = function (document, doc, context) {
+        var _this = this;
+        if (context === void 0) { context = { resultLimit: Number.MAX_VALUE }; }
+        var root = doc.root;
+        if (!root) {
+            return [];
+        }
+        var limit = context.resultLimit || Number.MAX_VALUE;
+        // special handling for key bindings
+        var resourceString = document.uri;
+        if ((resourceString === 'vscode://defaultsettings/keybindings.json') || Strings.endsWith(resourceString.toLowerCase(), '/user/keybindings.json')) {
+            if (root.type === 'array') {
+                var result_2 = [];
+                for (var _i = 0, _a = root.items; _i < _a.length; _i++) {
+                    var item = _a[_i];
+                    if (item.type === 'object') {
+                        for (var _b = 0, _c = item.properties; _b < _c.length; _b++) {
+                            var property = _c[_b];
+                            if (property.keyNode.value === 'key' && property.valueNode) {
+                                var range = getRange(document, item);
+                                var selectionRange = getRange(document, property.keyNode);
+                                result_2.push({ name: Parser.getNodeValue(property.valueNode), kind: SymbolKind.Function, range: range, selectionRange: selectionRange });
+                                limit--;
+                                if (limit <= 0) {
+                                    if (context && context.onResultLimitExceeded) {
+                                        context.onResultLimitExceeded(resourceString);
+                                    }
+                                    return result_2;
+                                }
+                            }
+                        }
+                    }
+                }
+                return result_2;
+            }
+        }
+        var result = [];
+        var toVisit = [
+            { node: root, result: result }
+        ];
+        var nextToVisit = 0;
+        var limitExceeded = false;
+        var collectOutlineEntries = function (node, result) {
+            if (node.type === 'array') {
+                node.items.forEach(function (node, index) {
+                    if (node) {
+                        if (limit > 0) {
+                            limit--;
+                            var range = getRange(document, node);
+                            var selectionRange = range;
+                            var name = String(index);
+                            var symbol = { name: name, kind: _this.getSymbolKind(node.type), range: range, selectionRange: selectionRange, children: [] };
+                            result.push(symbol);
+                            toVisit.push({ result: symbol.children, node: node });
+                        }
+                        else {
+                            limitExceeded = true;
+                        }
+                    }
+                });
+            }
+            else if (node.type === 'object') {
+                node.properties.forEach(function (property) {
+                    var valueNode = property.valueNode;
+                    if (valueNode) {
+                        if (limit > 0) {
+                            limit--;
+                            var range = getRange(document, property);
+                            var selectionRange = getRange(document, property.keyNode);
+                            var children = [];
+                            var symbol = { name: _this.getKeyLabel(property), kind: _this.getSymbolKind(valueNode.type), range: range, selectionRange: selectionRange, children: children, detail: _this.getDetail(valueNode) };
+                            result.push(symbol);
+                            toVisit.push({ result: children, node: valueNode });
+                        }
+                        else {
+                            limitExceeded = true;
+                        }
+                    }
+                });
+            }
+        };
+        // breath first traversal
+        while (nextToVisit < toVisit.length) {
+            var next = toVisit[nextToVisit++];
+            collectOutlineEntries(next.node, next.result);
+        }
+        if (limitExceeded && context && context.onResultLimitExceeded) {
+            context.onResultLimitExceeded(resourceString);
+        }
+        return result;
+    };
+    JSONDocumentSymbols.prototype.getSymbolKind = function (nodeType) {
+        switch (nodeType) {
+            case 'object':
+                return SymbolKind.Module;
+            case 'string':
+                return SymbolKind.String;
+            case 'number':
+                return SymbolKind.Number;
+            case 'array':
+                return SymbolKind.Array;
+            case 'boolean':
+                return SymbolKind.Boolean;
+            default: // 'null'
+                return SymbolKind.Variable;
+        }
+    };
+    JSONDocumentSymbols.prototype.getKeyLabel = function (property) {
+        var name = property.keyNode.value;
+        if (name) {
+            name = name.replace(/[\n]/g, '↵');
+        }
+        if (name && name.trim()) {
+            return name;
+        }
+        return "\"" + name + "\"";
+    };
+    JSONDocumentSymbols.prototype.getDetail = function (node) {
+        if (!node) {
+            return undefined;
+        }
+        if (node.type === 'boolean' || node.type === 'number' || node.type === 'null' || node.type === 'string') {
+            return String(node.value);
+        }
+        else {
+            if (node.type === 'array') {
+                return node.children.length ? undefined : '[]';
+            }
+            else if (node.type === 'object') {
+                return node.children.length ? undefined : '{}';
+            }
+        }
+        return undefined;
+    };
+    JSONDocumentSymbols.prototype.findDocumentColors = function (document, doc, context) {
+        return this.schemaService.getSchemaForResource(document.uri, doc).then(function (schema) {
+            var result = [];
+            if (schema) {
+                var limit = context && typeof context.resultLimit === 'number' ? context.resultLimit : Number.MAX_VALUE;
+                var matchingSchemas = doc.getMatchingSchemas(schema.schema);
+                var visitedNode = {};
+                for (var _i = 0, matchingSchemas_1 = matchingSchemas; _i < matchingSchemas_1.length; _i++) {
+                    var s = matchingSchemas_1[_i];
+                    if (!s.inverted && s.schema && (s.schema.format === 'color' || s.schema.format === 'color-hex') && s.node && s.node.type === 'string') {
+                        var nodeId = String(s.node.offset);
+                        if (!visitedNode[nodeId]) {
+                            var color = colorFromHex(Parser.getNodeValue(s.node));
+                            if (color) {
+                                var range = getRange(document, s.node);
+                                result.push({ color: color, range: range });
+                            }
+                            visitedNode[nodeId] = true;
+                            limit--;
+                            if (limit <= 0) {
+                                if (context && context.onResultLimitExceeded) {
+                                    context.onResultLimitExceeded(document.uri);
+                                }
+                                return result;
+                            }
+                        }
+                    }
+                }
+            }
+            return result;
+        });
+    };
+    JSONDocumentSymbols.prototype.getColorPresentations = function (document, doc, color, range) {
+        var result = [];
+        var red256 = Math.round(color.red * 255), green256 = Math.round(color.green * 255), blue256 = Math.round(color.blue * 255);
+        function toTwoDigitHex(n) {
+            var r = n.toString(16);
+            return r.length !== 2 ? '0' + r : r;
+        }
+        var label;
+        if (color.alpha === 1) {
+            label = "#" + toTwoDigitHex(red256) + toTwoDigitHex(green256) + toTwoDigitHex(blue256);
+        }
+        else {
+            label = "#" + toTwoDigitHex(red256) + toTwoDigitHex(green256) + toTwoDigitHex(blue256) + toTwoDigitHex(Math.round(color.alpha * 255));
+        }
+        result.push({ label: label, textEdit: TextEdit.replace(range, JSON.stringify(label)) });
+        return result;
+    };
+    return JSONDocumentSymbols;
+}());
+export { JSONDocumentSymbols };
+function getRange(document, node) {
+    return Range.create(document.positionAt(node.offset), document.positionAt(node.offset + node.length));
+}

package/lib/esm/services/jsonFolding.js

@@ -0,0 +1,121 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { createScanner } from 'jsonc-parser';
+import { FoldingRangeKind, Position } from '../jsonLanguageTypes';
+export function getFoldingRanges(document, context) {
+    var ranges = [];
+    var nestingLevels = [];
+    var stack = [];
+    var prevStart = -1;
+    var scanner = createScanner(document.getText(), false);
+    var token = scanner.scan();
+    function addRange(range) {
+        ranges.push(range);
+        nestingLevels.push(stack.length);
+    }
+    while (token !== 17 /* EOF */) {
+        switch (token) {
+            case 1 /* OpenBraceToken */:
+            case 3 /* OpenBracketToken */: {
+                var startLine = document.positionAt(scanner.getTokenOffset()).line;
+                var range = { startLine: startLine, endLine: startLine, kind: token === 1 /* OpenBraceToken */ ? 'object' : 'array' };
+                stack.push(range);
+                break;
+            }
+            case 2 /* CloseBraceToken */:
+            case 4 /* CloseBracketToken */: {
+                var kind = token === 2 /* CloseBraceToken */ ? 'object' : 'array';
+                if (stack.length > 0 && stack[stack.length - 1].kind === kind) {
+                    var range = stack.pop();
+                    var line = document.positionAt(scanner.getTokenOffset()).line;
+                    if (range && line > range.startLine + 1 && prevStart !== range.startLine) {
+                        range.endLine = line - 1;
+                        addRange(range);
+                        prevStart = range.startLine;
+                    }
+                }
+                break;
+            }
+            case 13 /* BlockCommentTrivia */: {
+                var startLine = document.positionAt(scanner.getTokenOffset()).line;
+                var endLine = document.positionAt(scanner.getTokenOffset() + scanner.getTokenLength()).line;
+                if (scanner.getTokenError() === 1 /* UnexpectedEndOfComment */ && startLine + 1 < document.lineCount) {
+                    scanner.setPosition(document.offsetAt(Position.create(startLine + 1, 0)));
+                }
+                else {
+                    if (startLine < endLine) {
+                        addRange({ startLine: startLine, endLine: endLine, kind: FoldingRangeKind.Comment });
+                        prevStart = startLine;
+                    }
+                }
+                break;
+            }
+            case 12 /* LineCommentTrivia */: {
+                var text = document.getText().substr(scanner.getTokenOffset(), scanner.getTokenLength());
+                var m = text.match(/^\/\/\s*#(region\b)|(endregion\b)/);
+                if (m) {
+                    var line = document.positionAt(scanner.getTokenOffset()).line;
+                    if (m[1]) { // start pattern match
+                        var range = { startLine: line, endLine: line, kind: FoldingRangeKind.Region };
+                        stack.push(range);
+                    }
+                    else {
+                        var i = stack.length - 1;
+                        while (i >= 0 && stack[i].kind !== FoldingRangeKind.Region) {
+                            i--;
+                        }
+                        if (i >= 0) {
+                            var range = stack[i];
+                            stack.length = i;
+                            if (line > range.startLine && prevStart !== range.startLine) {
+                                range.endLine = line;
+                                addRange(range);
+                                prevStart = range.startLine;
+                            }
+                        }
+                    }
+                }
+                break;
+            }
+        }
+        token = scanner.scan();
+    }
+    var rangeLimit = context && context.rangeLimit;
+    if (typeof rangeLimit !== 'number' || ranges.length <= rangeLimit) {
+        return ranges;
+    }
+    if (context && context.onRangeLimitExceeded) {
+        context.onRangeLimitExceeded(document.uri);
+    }
+    var counts = [];
+    for (var _i = 0, nestingLevels_1 = nestingLevels; _i < nestingLevels_1.length; _i++) {
+        var level = nestingLevels_1[_i];
+        if (level < 30) {
+            counts[level] = (counts[level] || 0) + 1;
+        }
+    }
+    var entries = 0;
+    var maxLevel = 0;
+    for (var i = 0; i < counts.length; i++) {
+        var n = counts[i];
+        if (n) {
+            if (n + entries > rangeLimit) {
+                maxLevel = i;
+                break;
+            }
+            entries += n;
+        }
+    }
+    var result = [];
+    for (var i = 0; i < ranges.length; i++) {
+        var level = nestingLevels[i];
+        if (typeof level === 'number') {
+            if (level < maxLevel || (level === maxLevel && entries++ < rangeLimit)) {
+                result.push(ranges[i]);
+            }
+        }
+    }
+    return result;
+}

package/lib/esm/services/jsonHover.js

@@ -0,0 +1,112 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import * as Parser from '../parser/jsonParser';
+import { Range } from '../jsonLanguageTypes';
+var JSONHover = /** @class */ (function () {
+    function JSONHover(schemaService, contributions, promiseConstructor) {
+        if (contributions === void 0) { contributions = []; }
+        this.schemaService = schemaService;
+        this.contributions = contributions;
+        this.promise = promiseConstructor || Promise;
+    }
+    JSONHover.prototype.doHover = function (document, position, doc) {
+        var offset = document.offsetAt(position);
+        var 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);
+        }
+        var hoverRangeNode = node;
+        // use the property description when hovering over an object key
+        if (node.type === 'string') {
+            var parent = node.parent;
+            if (parent && parent.type === 'property' && parent.keyNode === node) {
+                node = parent.valueNode;
+                if (!node) {
+                    return this.promise.resolve(null);
+                }
+            }
+        }
+        var hoverRange = Range.create(document.positionAt(hoverRangeNode.offset), document.positionAt(hoverRangeNode.offset + hoverRangeNode.length));
+        var createHover = function (contents) {
+            var result = {
+                contents: contents,
+                range: hoverRange
+            };
+            return result;
+        };
+        var location = Parser.getNodePath(node);
+        for (var i = this.contributions.length - 1; i >= 0; i--) {
+            var contribution = this.contributions[i];
+            var promise = contribution.getInfoContribution(document.uri, location);
+            if (promise) {
+                return promise.then(function (htmlContent) { return createHover(htmlContent); });
+            }
+        }
+        return this.schemaService.getSchemaForResource(document.uri, doc).then(function (schema) {
+            if (schema && node) {
+                var matchingSchemas = doc.getMatchingSchemas(schema.schema, node.offset);
+                var title_1 = undefined;
+                var markdownDescription_1 = undefined;
+                var markdownEnumValueDescription_1 = undefined, enumValue_1 = undefined;
+                matchingSchemas.every(function (s) {
+                    if (s.node === node && !s.inverted && s.schema) {
+                        title_1 = title_1 || s.schema.title;
+                        markdownDescription_1 = markdownDescription_1 || s.schema.markdownDescription || toMarkdown(s.schema.description);
+                        if (s.schema.enum) {
+                            var idx = s.schema.enum.indexOf(Parser.getNodeValue(node));
+                            if (s.schema.markdownEnumDescriptions) {
+                                markdownEnumValueDescription_1 = s.schema.markdownEnumDescriptions[idx];
+                            }
+                            else if (s.schema.enumDescriptions) {
+                                markdownEnumValueDescription_1 = toMarkdown(s.schema.enumDescriptions[idx]);
+                            }
+                            if (markdownEnumValueDescription_1) {
+                                enumValue_1 = s.schema.enum[idx];
+                                if (typeof enumValue_1 !== 'string') {
+                                    enumValue_1 = JSON.stringify(enumValue_1);
+                                }
+                            }
+                        }
+                    }
+                    return true;
+                });
+                var result = '';
+                if (title_1) {
+                    result = toMarkdown(title_1);
+                }
+                if (markdownDescription_1) {
+                    if (result.length > 0) {
+                        result += "\n\n";
+                    }
+                    result += markdownDescription_1;
+                }
+                if (markdownEnumValueDescription_1) {
+                    if (result.length > 0) {
+                        result += "\n\n";
+                    }
+                    result += "`" + toMarkdownCodeBlock(enumValue_1) + "`: " + markdownEnumValueDescription_1;
+                }
+                return createHover([result]);
+            }
+            return null;
+        });
+    };
+    return JSONHover;
+}());
+export { JSONHover };
+function toMarkdown(plain) {
+    if (plain) {
+        var res = plain.replace(/([^\n\r])(\r?\n)([^\n\r])/gm, '$1\n\n$3'); // single new lines to \n\n (Markdown paragraph)
+        return res.replace(/[\\`*_{}[\]()#+\-.!]/g, "\\$&"); // escape markdown syntax tokens: http://daringfireball.net/projects/markdown/syntax#backslash
+    }
+    return undefined;
+}
+function toMarkdownCodeBlock(content) {
+    // see https://daringfireball.net/projects/markdown/syntax#precode
+    if (content.indexOf('`') !== -1) {
+        return '`` ' + content + ' ``';
+    }
+    return content;
+}

package/lib/esm/services/jsonLinks.js

@@ -0,0 +1,73 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { Range } from '../jsonLanguageTypes';
+export function findLinks(document, doc) {
+    var links = [];
+    doc.visit(function (node) {
+        var _a;
+        if (node.type === "property" && node.keyNode.value === "$ref" && ((_a = node.valueNode) === null || _a === void 0 ? void 0 : _a.type) === 'string') {
+            var path = node.valueNode.value;
+            var targetNode = findTargetNode(doc, path);
+            if (targetNode) {
+                var targetPos = document.positionAt(targetNode.offset);
+                links.push({
+                    target: document.uri + "#" + (targetPos.line + 1) + "," + (targetPos.character + 1),
+                    range: createRange(document, node.valueNode)
+                });
+            }
+        }
+        return true;
+    });
+    return Promise.resolve(links);
+}
+function createRange(document, node) {
+    return Range.create(document.positionAt(node.offset + 1), document.positionAt(node.offset + node.length - 1));
+}
+function findTargetNode(doc, path) {
+    var tokens = parseJSONPointer(path);
+    if (!tokens) {
+        return null;
+    }
+    return findNode(tokens, doc.root);
+}
+function findNode(pointer, node) {
+    if (!node) {
+        return null;
+    }
+    if (pointer.length === 0) {
+        return node;
+    }
+    var token = pointer.shift();
+    if (node && node.type === 'object') {
+        var propertyNode = node.properties.find(function (propertyNode) { return propertyNode.keyNode.value === token; });
+        if (!propertyNode) {
+            return null;
+        }
+        return findNode(pointer, propertyNode.valueNode);
+    }
+    else if (node && node.type === 'array') {
+        if (token.match(/^(0|[1-9][0-9]*)$/)) {
+            var index = Number.parseInt(token);
+            var arrayItem = node.items[index];
+            if (!arrayItem) {
+                return null;
+            }
+            return findNode(pointer, arrayItem);
+        }
+    }
+    return null;
+}
+function parseJSONPointer(path) {
+    if (path === "#") {
+        return [];
+    }
+    if (path[0] !== '#' || path[1] !== '/') {
+        return null;
+    }
+    return path.substring(2).split(/\//).map(unescape);
+}
+function unescape(str) {
+    return str.replace(/~1/g, '/').replace(/~0/g, '~');
+}