vscode-json-languageservice 3.8.5 → 3.11.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+3.11.0 / 2020-11-30
+================
+ * new API `FormattingOptions.insertFinalNewline`
+
+3.10.0 / 2020-11-03
+================
+ * new API `findLinks` return links for local `$ref` links. Replaces `findDefinition` which no longer returns results ( kept for API compatibility)
+
 3.9.0 / 2020-09-28
 =================
  * new API `DocumentLanguageSettings.schemaValidation`. The severity of problems from schema validation. If set to 'ignore', schema validation will be skipped. If not set, 'warning' is used.

package/README.md

@@ -1,4 +1,5 @@
 # vscode-json-languageservice
+
 JSON language service extracted from VSCode to be reused, e.g in the Monaco editor.
 
 [![npm Package](https://img.shields.io/npm/v/vscode-json-languageservice.svg?style=flat-square)](https://www.npmjs.org/package/vscode-json-languageservice)
@@ -6,52 +7,59 @@ JSON language service extracted from VSCode to be reused, e.g in the Monaco edit
 [![Build Status](https://travis-ci.org/Microsoft/vscode-json-languageservice.svg?branch=master)](https://travis-ci.org/Microsoft/vscode-json-languageservice)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Why?
-----
+## Why?
+
 The _vscode-json-languageservice_ contains the language smarts behind the JSON editing experience of Visual Studio Code
 and the Monaco editor.
- - *doValidation* analyses an input string and returns syntax and lint errors.
- - *doComplete* provides completion proposals for a given location. *doResolve* resolves a completion proposal
- - *doResolve* resolves a completion proposals.
- - *doHover* provides a hover text for a given location.
- - *findDocumentSymbols* provides all symbols in the given document
- - *findDocumentColors* provides all color symbols in the given document, *getColorPresentations* returns available color formats for a color symbol.
- - *format* formats the code at the given range.
- - *getFoldingRanges* gets folding ranges for the given document
- - *getSelectionRanges* gets selection ranges for a given location.
- - *getMatchingSchemas* matches a document against its schema and returns all AST nodes along with the matching sub schemas
 
- - use *parseJSONDocument* create a JSON document from source code, or *newJSONDocument* to create the document from an AST.
+- _doValidation_ analyses an input string and returns syntax and lint errors.
+- _doComplete_ provides completion proposals for a given location.
+- _doResolve_ resolves a completion proposals.
+- _doHover_ provides a hover text for a given location.
+- _findDocumentSymbols_ provides all symbols in the given document.
+- _findDocumentColors_ provides all color symbols in the given document.
+- _getColorPresentations_ returns available color formats for a color symbol.
+- _format_ formats the code at the given range.
+- _getFoldingRanges_ gets folding ranges for the given document.
+- _getSelectionRanges_ gets selection ranges for a given location.
+- _getMatchingSchemas_ matches a document against its schema and returns all AST nodes along with the matching sub schemas.
+- _parseJSONDocument_ creates a JSON document from source code.
+- _newJSONDocument_ creates a JSON document from an AST.
 
-For the complete API see [jsonLanguageService.ts](./src/jsonLanguageService.ts) and [jsonLanguageTypes.ts](./src/jsonLanguageTypes.ts) 
+For the complete API see [jsonLanguageService.ts](./src/jsonLanguageService.ts) and [jsonLanguageTypes.ts](./src/jsonLanguageTypes.ts)
 
-
-Installation
-------------
+## Installation
 
     npm install --save vscode-json-languageservice
 
-Development
------------
+## Sample usage
+
+See [sample.ts](./src/example/sample.ts) for an example on how to use the JSON language service.
 
+To run the sample use `yarn sample`
 
-- clone this repo, run yarn
-- `yarn test` to compile and run tests
+## Development
 
-How can I run and debug the service?
+    git clone https://github.com/microsoft/vscode-json-languageservice
+    cd vscode-json-languageservice
+    yarn
+
+Use `yarn test` to compile and run tests
+
+
+### How can I run and debug the service?
 
 - open the folder in VSCode.
 - set breakpoints, e.g. in `jsonCompletion.ts`
 - run the Unit tests from the run viewlet and wait until a breakpoint is hit:
-![image](https://user-images.githubusercontent.com/6461412/94239202-bdad4e80-ff11-11ea-99c3-cb9dbeb1c0b2.png)
-
+  ![image](https://user-images.githubusercontent.com/6461412/94239202-bdad4e80-ff11-11ea-99c3-cb9dbeb1c0b2.png)
 
-How can I run and debug the service inside an instance of VSCode?
+### How can I run and debug the service inside an instance of VSCode?
 
 - run VSCode out of sources setup as described here: https://github.com/Microsoft/vscode/wiki/How-to-Contribute
 - use `yarn link vscode-json-languageservice` in `vscode/extensions/json-language-features/server` to run VSCode with the latest changes from `vscode-json-languageservice`
 - run VSCode out of source (`vscode/scripts/code.sh|bat`) and open a `.json` file
 - in VSCode window that is open on the `vscode-json-languageservice` sources, run command `Debug: Attach to Node process` and pick the `code-oss` process with the `json-language-features` path
-![image](https://user-images.githubusercontent.com/6461412/94242925-061b3b00-ff17-11ea-8c17-8da15268f1a1.png)
+  ![image](https://user-images.githubusercontent.com/6461412/94242925-061b3b00-ff17-11ea-8c17-8da15268f1a1.png)
 - set breakpoints, e.g. in `jsonCompletion.ts`
 - in the instance run from sources, invoke code completion in the `.json` file

package/lib/esm/jsonLanguageService.d.ts

@@ -1,4 +1,5 @@
 import { Thenable, ASTNode, Color, ColorInformation, ColorPresentation, LanguageServiceParams, LanguageSettings, DocumentLanguageSettings, FoldingRange, JSONSchema, SelectionRange, FoldingRangesContext, DocumentSymbolsContext, ColorInformationContext as DocumentColorsContext, TextDocument, Position, CompletionItem, CompletionList, Hover, Range, SymbolInformation, Diagnostic, TextEdit, FormattingOptions, DocumentSymbol, DefinitionLink, MatchingSchema } from './jsonLanguageTypes';
+import { DocumentLink } from 'vscode-languageserver-types';
 export declare type JSONDocument = {
     root: ASTNode | undefined;
     getNodeFromOffset(offset: number, includeRightBound?: boolean): ASTNode | undefined;
@@ -24,5 +25,6 @@ export interface LanguageService {
     getFoldingRanges(document: TextDocument, context?: FoldingRangesContext): FoldingRange[];
     getSelectionRanges(document: TextDocument, positions: Position[], doc: JSONDocument): SelectionRange[];
     findDefinition(document: TextDocument, position: Position, doc: JSONDocument): Thenable<DefinitionLink[]>;
+    findLinks(document: TextDocument, doc: JSONDocument): Thenable<DocumentLink[]>;
 }
 export declare function getLanguageService(params: LanguageServiceParams): LanguageService;

package/lib/esm/jsonLanguageService.js

@@ -13,7 +13,7 @@ import { getFoldingRanges } from './services/jsonFolding';
 import { getSelectionRanges } from './services/jsonSelectionRanges';
 import { format as formatJSON } from 'jsonc-parser';
 import { Range, TextEdit } from './jsonLanguageTypes';
-import { findDefinition } from './services/jsonDefinition';
+import { findLinks } from './services/jsonLinks';
 export * from './jsonLanguageTypes';
 export function getLanguageService(params) {
     var promise = params.promiseConstructor || Promise;
@@ -48,7 +48,8 @@ export function getLanguageService(params) {
         doHover: jsonHover.doHover.bind(jsonHover),
         getFoldingRanges: getFoldingRanges,
         getSelectionRanges: getSelectionRanges,
-        findDefinition: findDefinition,
+        findDefinition: function () { return Promise.resolve([]); },
+        findLinks: findLinks,
         format: function (d, r, o) {
             var range = undefined;
             if (r) {
@@ -56,7 +57,7 @@ export function getLanguageService(params) {
                 var length = d.offsetAt(r.end) - offset;
                 range = { offset: offset, length: length };
             }
-            var options = { tabSize: o ? o.tabSize : 4, insertSpaces: o ? o.insertSpaces : true, eol: '\n' };
+            var options = { tabSize: o ? o.tabSize : 4, insertSpaces: (o === null || o === void 0 ? void 0 : o.insertSpaces) === true, insertFinalNewline: (o === null || o === void 0 ? void 0 : o.insertFinalNewline) === true, eol: '\n' };
             return formatJSON(d.getText(), range, options).map(function (e) {
                 return TextEdit.replace(Range.create(d.positionAt(e.offset), d.positionAt(e.offset + e.length)), e.content);
             });

package/lib/esm/jsonLanguageTypes.d.ts

@@ -1,8 +1,8 @@
 import { JSONWorkerContribution, JSONPath, Segment, CompletionsCollector } from './jsonContributions';
 import { JSONSchema } from './jsonSchema';
-import { Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, MarkupKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions, DefinitionLink } from 'vscode-languageserver-types';
+import { Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, MarkupKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions as LSPFormattingOptions, DefinitionLink } from 'vscode-languageserver-types';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-export { TextDocument, Range, TextEdit, JSONSchema, JSONWorkerContribution, JSONPath, Segment, CompletionsCollector, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, MarkupKind, DefinitionLink, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions };
+export { TextDocument, Range, TextEdit, JSONSchema, JSONWorkerContribution, JSONPath, Segment, CompletionsCollector, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, MarkupKind, DefinitionLink, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString };
 /**
  * Error codes used by diagnostics
  */
@@ -129,8 +129,8 @@ export interface WorkspaceContextService {
     resolveRelativePath(relativePath: string, resource: string): string;
 }
 /**
- * The schema request service is used to fetch schemas. The result should the schema file comment, or,
- * in case of an error, a displayable error string
+ * The schema request service is used to fetch schemas. If successful, returns a resolved promise with the content of the schema.
+ * In case of an error, returns a rejected promise with a displayable error string.
  */
 export interface SchemaRequestService {
     (uri: string): Thenable<string>;
@@ -142,7 +142,7 @@ export interface PromiseConstructor {
      * a resolve callback used resolve the promise with a value or the result of another promise,
      * and a reject callback used to reject the promise with a provided reason or error.
      */
-    new <T>(executor: (resolve: (value?: T | Thenable<T>) => void, reject: (reason?: any) => void) => void): Thenable<T>;
+    new <T>(executor: (resolve: (value?: T | Thenable<T | undefined>) => void, reject: (reason?: any) => void) => void): Thenable<T | undefined>;
     /**
      * Creates a Promise that is resolved with an array of results when all of the provided Promises
      * resolve, or rejected when any Promise is rejected.
@@ -269,3 +269,6 @@ export interface ColorInformationContext {
      */
     onResultLimitExceeded?: (uri: string) => void;
 }
+export interface FormattingOptions extends LSPFormattingOptions {
+    insertFinalNewline?: boolean;
+}

package/lib/esm/jsonLanguageTypes.js

@@ -2,9 +2,9 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, MarkupKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions } from 'vscode-languageserver-types';
+import { Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, MarkupKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString } from 'vscode-languageserver-types';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-export { TextDocument, Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, MarkupKind, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions };
+export { TextDocument, Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, MarkupKind, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString };
 /**
  * Error codes used by diagnostics
  */

package/lib/esm/services/jsonCompletion.js

@@ -89,8 +89,13 @@ var JSONCompletion = /** @class */ (function () {
                     proposed[label] = suggestion;
                     result.items.push(suggestion);
                 }
-                else if (!existing.documentation) {
-                    existing.documentation = suggestion.documentation;
+                else {
+                    if (!existing.documentation) {
+                        existing.documentation = suggestion.documentation;
+                    }
+                    if (!existing.detail) {
+                        existing.detail = suggestion.detail;
+                    }
                 }
             },
             setAsIncomplete: function () {

package/lib/esm/services/jsonDocumentSymbols.js

@@ -156,9 +156,10 @@ var JSONDocumentSymbols = /** @class */ (function () {
                             limit--;
                             var range = getRange(document, property);
                             var selectionRange = getRange(document, property.keyNode);
-                            var symbol = { name: _this.getKeyLabel(property), kind: _this.getSymbolKind(valueNode.type), range: range, selectionRange: selectionRange, children: [] };
+                            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: symbol.children, node: valueNode });
+                            toVisit.push({ result: children, node: valueNode });
                         }
                         else {
                             limitExceeded = true;
@@ -203,6 +204,23 @@ var JSONDocumentSymbols = /** @class */ (function () {
         }
         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 = [];

package/lib/esm/services/{jsonDefinition.js → jsonLinks.js}

@@ -3,37 +3,27 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 import { Range } from '../jsonLanguageTypes';
-export function findDefinition(document, position, doc) {
-    var offset = document.offsetAt(position);
-    var node = doc.getNodeFromOffset(offset, true);
-    if (!node || !isRef(node)) {
-        return Promise.resolve([]);
-    }
-    var propertyNode = node.parent;
-    var valueNode = propertyNode.valueNode;
-    var path = valueNode.value;
-    var targetNode = findTargetNode(doc, path);
-    if (!targetNode) {
-        return Promise.resolve([]);
-    }
-    var definition = {
-        targetUri: document.uri,
-        originSelectionRange: createRange(document, valueNode),
-        targetRange: createRange(document, targetNode),
-        targetSelectionRange: createRange(document, targetNode)
-    };
-    return Promise.resolve([definition]);
+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), document.positionAt(node.offset + node.length));
-}
-function isRef(node) {
-    return node.type === 'string' &&
-        node.parent &&
-        node.parent.type === 'property' &&
-        node.parent.valueNode === node &&
-        node.parent.keyNode.value === "$ref" ||
-        false;
+    return Range.create(document.positionAt(node.offset + 1), document.positionAt(node.offset + node.length - 1));
 }
 function findTargetNode(doc, path) {
     var tokens = parseJSONPointer(path);

package/lib/esm/services/jsonSchemaService.js

@@ -331,6 +331,7 @@ var JSONSchemaService = /** @class */ (function () {
                     var loc = refSegment ? uri + '#' + refSegment : uri;
                     resolveErrors.push(localize('json.schema.problemloadingref', 'Problems loading reference \'{0}\': {1}', loc, unresolvedSchema.errors[0]));
                 }
+                delete node.$ref;
                 merge(node, unresolvedSchema.schema, uri, refSegment);
                 return resolveRefs(node, unresolvedSchema.schema, uri, referencedHandle.dependencies);
             });
@@ -394,14 +395,14 @@ var JSONSchemaService = /** @class */ (function () {
                 while (next.$ref) {
                     var ref = next.$ref;
                     var segments = ref.split('#', 2);
-                    delete next.$ref;
                     if (segments[0].length > 0) {
                         openPromises.push(resolveExternalLink(next, segments[0], segments[1], parentSchemaURL, parentSchemaDependencies));
                         return;
                     }
                     else {
+                        delete next.$ref;
                         if (seenRefs.indexOf(ref) === -1) {
-                            merge(next, parentSchema, parentSchemaURL, segments[1]); // can set next.$ref again, use seenRefs to avoid circle
+                            merge(next, parentSchema, parentSchemaURL, segments[1]); // will remove $ref, can set next.$ref again, use seenRefs to avoid circle
                             seenRefs.push(ref);
                         }
                     }
@@ -445,9 +446,10 @@ var JSONSchemaService = /** @class */ (function () {
         }
         var seen = Object.create(null);
         var schemas = [];
+        var normalizedResource = normalizeResourceForMatching(resource);
         for (var _i = 0, _a = this.filePatternAssociations; _i < _a.length; _i++) {
             var entry = _a[_i];
-            if (entry.matchesPattern(resource)) {
+            if (entry.matchesPattern(normalizedResource)) {
                 for (var _b = 0, _c = entry.getURIs(); _b < _c.length; _b++) {
                     var schemaId = _c[_b];
                     if (!seen[schemaId]) {
@@ -500,6 +502,15 @@ function normalizeId(id) {
         return id;
     }
 }
+function normalizeResourceForMatching(resource) {
+    // remove querues and fragments, normalize drive capitalization
+    try {
+        return URI.parse(resource).with({ fragment: null, query: null }).toString();
+    }
+    catch (e) {
+        return resource;
+    }
+}
 function toDisplayString(url) {
     try {
         var uri = URI.parse(url);

package/lib/esm/services/jsonValidation.js

@@ -15,7 +15,7 @@ var JSONValidation = /** @class */ (function () {
     }
     JSONValidation.prototype.configure = function (raw) {
         if (raw) {
-            this.validationEnabled = raw.validate;
+            this.validationEnabled = raw.validate !== false;
             this.commentSeverity = raw.allowComments ? undefined : DiagnosticSeverity.Error;
         }
     };

package/lib/umd/jsonLanguageService.d.ts

@@ -1,4 +1,5 @@
 import { Thenable, ASTNode, Color, ColorInformation, ColorPresentation, LanguageServiceParams, LanguageSettings, DocumentLanguageSettings, FoldingRange, JSONSchema, SelectionRange, FoldingRangesContext, DocumentSymbolsContext, ColorInformationContext as DocumentColorsContext, TextDocument, Position, CompletionItem, CompletionList, Hover, Range, SymbolInformation, Diagnostic, TextEdit, FormattingOptions, DocumentSymbol, DefinitionLink, MatchingSchema } from './jsonLanguageTypes';
+import { DocumentLink } from 'vscode-languageserver-types';
 export declare type JSONDocument = {
     root: ASTNode | undefined;
     getNodeFromOffset(offset: number, includeRightBound?: boolean): ASTNode | undefined;
@@ -24,5 +25,6 @@ export interface LanguageService {
     getFoldingRanges(document: TextDocument, context?: FoldingRangesContext): FoldingRange[];
     getSelectionRanges(document: TextDocument, positions: Position[], doc: JSONDocument): SelectionRange[];
     findDefinition(document: TextDocument, position: Position, doc: JSONDocument): Thenable<DefinitionLink[]>;
+    findLinks(document: TextDocument, doc: JSONDocument): Thenable<DocumentLink[]>;
 }
 export declare function getLanguageService(params: LanguageServiceParams): LanguageService;

package/lib/umd/jsonLanguageService.js

@@ -18,7 +18,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "./services/jsonCompletion", "./services/jsonHover", "./services/jsonValidation", "./services/jsonDocumentSymbols", "./parser/jsonParser", "./services/configuration", "./services/jsonSchemaService", "./services/jsonFolding", "./services/jsonSelectionRanges", "jsonc-parser", "./jsonLanguageTypes", "./services/jsonDefinition", "./jsonLanguageTypes"], factory);
+        define(["require", "exports", "./services/jsonCompletion", "./services/jsonHover", "./services/jsonValidation", "./services/jsonDocumentSymbols", "./parser/jsonParser", "./services/configuration", "./services/jsonSchemaService", "./services/jsonFolding", "./services/jsonSelectionRanges", "jsonc-parser", "./jsonLanguageTypes", "./services/jsonLinks", "./jsonLanguageTypes"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -35,7 +35,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     var jsonSelectionRanges_1 = require("./services/jsonSelectionRanges");
     var jsonc_parser_1 = require("jsonc-parser");
     var jsonLanguageTypes_1 = require("./jsonLanguageTypes");
-    var jsonDefinition_1 = require("./services/jsonDefinition");
+    var jsonLinks_1 = require("./services/jsonLinks");
     __exportStar(require("./jsonLanguageTypes"), exports);
     function getLanguageService(params) {
         var promise = params.promiseConstructor || Promise;
@@ -70,7 +70,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
             doHover: jsonHover.doHover.bind(jsonHover),
             getFoldingRanges: jsonFolding_1.getFoldingRanges,
             getSelectionRanges: jsonSelectionRanges_1.getSelectionRanges,
-            findDefinition: jsonDefinition_1.findDefinition,
+            findDefinition: function () { return Promise.resolve([]); },
+            findLinks: jsonLinks_1.findLinks,
             format: function (d, r, o) {
                 var range = undefined;
                 if (r) {
@@ -78,7 +79,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
                     var length = d.offsetAt(r.end) - offset;
                     range = { offset: offset, length: length };
                 }
-                var options = { tabSize: o ? o.tabSize : 4, insertSpaces: o ? o.insertSpaces : true, eol: '\n' };
+                var options = { tabSize: o ? o.tabSize : 4, insertSpaces: (o === null || o === void 0 ? void 0 : o.insertSpaces) === true, insertFinalNewline: (o === null || o === void 0 ? void 0 : o.insertFinalNewline) === true, eol: '\n' };
                 return jsonc_parser_1.format(d.getText(), range, options).map(function (e) {
                     return jsonLanguageTypes_1.TextEdit.replace(jsonLanguageTypes_1.Range.create(d.positionAt(e.offset), d.positionAt(e.offset + e.length)), e.content);
                 });

package/lib/umd/jsonLanguageTypes.d.ts

@@ -1,8 +1,8 @@
 import { JSONWorkerContribution, JSONPath, Segment, CompletionsCollector } from './jsonContributions';
 import { JSONSchema } from './jsonSchema';
-import { Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, MarkupKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions, DefinitionLink } from 'vscode-languageserver-types';
+import { Range, TextEdit, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, MarkupKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions as LSPFormattingOptions, DefinitionLink } from 'vscode-languageserver-types';
 import { TextDocument } from 'vscode-languageserver-textdocument';
-export { TextDocument, Range, TextEdit, JSONSchema, JSONWorkerContribution, JSONPath, Segment, CompletionsCollector, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, MarkupKind, DefinitionLink, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString, FormattingOptions };
+export { TextDocument, Range, TextEdit, JSONSchema, JSONWorkerContribution, JSONPath, Segment, CompletionsCollector, Color, ColorInformation, ColorPresentation, FoldingRange, FoldingRangeKind, SelectionRange, Diagnostic, DiagnosticSeverity, CompletionItem, CompletionItemKind, CompletionList, Position, InsertTextFormat, MarkupContent, MarkupKind, DefinitionLink, SymbolInformation, SymbolKind, DocumentSymbol, Location, Hover, MarkedString };
 /**
  * Error codes used by diagnostics
  */
@@ -129,8 +129,8 @@ export interface WorkspaceContextService {
     resolveRelativePath(relativePath: string, resource: string): string;
 }
 /**
- * The schema request service is used to fetch schemas. The result should the schema file comment, or,
- * in case of an error, a displayable error string
+ * The schema request service is used to fetch schemas. If successful, returns a resolved promise with the content of the schema.
+ * In case of an error, returns a rejected promise with a displayable error string.
  */
 export interface SchemaRequestService {
     (uri: string): Thenable<string>;
@@ -142,7 +142,7 @@ export interface PromiseConstructor {
      * a resolve callback used resolve the promise with a value or the result of another promise,
      * and a reject callback used to reject the promise with a provided reason or error.
      */
-    new <T>(executor: (resolve: (value?: T | Thenable<T>) => void, reject: (reason?: any) => void) => void): Thenable<T>;
+    new <T>(executor: (resolve: (value?: T | Thenable<T | undefined>) => void, reject: (reason?: any) => void) => void): Thenable<T | undefined>;
     /**
      * Creates a Promise that is resolved with an array of results when all of the provided Promises
      * resolve, or rejected when any Promise is rejected.
@@ -269,3 +269,6 @@ export interface ColorInformationContext {
      */
     onResultLimitExceeded?: (uri: string) => void;
 }
+export interface FormattingOptions extends LSPFormattingOptions {
+    insertFinalNewline?: boolean;
+}

package/lib/umd/jsonLanguageTypes.js

@@ -13,7 +13,7 @@
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.ClientCapabilities = exports.ErrorCode = exports.FormattingOptions = exports.MarkedString = exports.Hover = exports.Location = exports.DocumentSymbol = exports.SymbolKind = exports.SymbolInformation = exports.MarkupKind = exports.MarkupContent = exports.InsertTextFormat = exports.Position = exports.CompletionList = exports.CompletionItemKind = exports.CompletionItem = exports.DiagnosticSeverity = exports.Diagnostic = exports.SelectionRange = exports.FoldingRangeKind = exports.FoldingRange = exports.ColorPresentation = exports.ColorInformation = exports.Color = exports.TextEdit = exports.Range = exports.TextDocument = void 0;
+    exports.ClientCapabilities = exports.ErrorCode = exports.MarkedString = exports.Hover = exports.Location = exports.DocumentSymbol = exports.SymbolKind = exports.SymbolInformation = exports.MarkupKind = exports.MarkupContent = exports.InsertTextFormat = exports.Position = exports.CompletionList = exports.CompletionItemKind = exports.CompletionItem = exports.DiagnosticSeverity = exports.Diagnostic = exports.SelectionRange = exports.FoldingRangeKind = exports.FoldingRange = exports.ColorPresentation = exports.ColorInformation = exports.Color = exports.TextEdit = exports.Range = exports.TextDocument = void 0;
     var vscode_languageserver_types_1 = require("vscode-languageserver-types");
     Object.defineProperty(exports, "Range", { enumerable: true, get: function () { return vscode_languageserver_types_1.Range; } });
     Object.defineProperty(exports, "TextEdit", { enumerable: true, get: function () { return vscode_languageserver_types_1.TextEdit; } });
@@ -38,7 +38,6 @@
     Object.defineProperty(exports, "Location", { enumerable: true, get: function () { return vscode_languageserver_types_1.Location; } });
     Object.defineProperty(exports, "Hover", { enumerable: true, get: function () { return vscode_languageserver_types_1.Hover; } });
     Object.defineProperty(exports, "MarkedString", { enumerable: true, get: function () { return vscode_languageserver_types_1.MarkedString; } });
-    Object.defineProperty(exports, "FormattingOptions", { enumerable: true, get: function () { return vscode_languageserver_types_1.FormattingOptions; } });
     var vscode_languageserver_textdocument_1 = require("vscode-languageserver-textdocument");
     Object.defineProperty(exports, "TextDocument", { enumerable: true, get: function () { return vscode_languageserver_textdocument_1.TextDocument; } });
     /**

package/lib/umd/services/jsonCompletion.js

@@ -101,8 +101,13 @@
                         proposed[label] = suggestion;
                         result.items.push(suggestion);
                     }
-                    else if (!existing.documentation) {
-                        existing.documentation = suggestion.documentation;
+                    else {
+                        if (!existing.documentation) {
+                            existing.documentation = suggestion.documentation;
+                        }
+                        if (!existing.detail) {
+                            existing.detail = suggestion.detail;
+                        }
                     }
                 },
                 setAsIncomplete: function () {

package/lib/umd/services/jsonDocumentSymbols.js

@@ -168,9 +168,10 @@
                                 limit--;
                                 var range = getRange(document, property);
                                 var selectionRange = getRange(document, property.keyNode);
-                                var symbol = { name: _this.getKeyLabel(property), kind: _this.getSymbolKind(valueNode.type), range: range, selectionRange: selectionRange, children: [] };
+                                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: symbol.children, node: valueNode });
+                                toVisit.push({ result: children, node: valueNode });
                             }
                             else {
                                 limitExceeded = true;
@@ -215,6 +216,23 @@
             }
             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 = [];

package/lib/umd/services/{jsonDefinition.js → jsonLinks.js}

@@ -13,40 +13,30 @@
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.findDefinition = void 0;
+    exports.findLinks = void 0;
     var jsonLanguageTypes_1 = require("../jsonLanguageTypes");
-    function findDefinition(document, position, doc) {
-        var offset = document.offsetAt(position);
-        var node = doc.getNodeFromOffset(offset, true);
-        if (!node || !isRef(node)) {
-            return Promise.resolve([]);
-        }
-        var propertyNode = node.parent;
-        var valueNode = propertyNode.valueNode;
-        var path = valueNode.value;
-        var targetNode = findTargetNode(doc, path);
-        if (!targetNode) {
-            return Promise.resolve([]);
-        }
-        var definition = {
-            targetUri: document.uri,
-            originSelectionRange: createRange(document, valueNode),
-            targetRange: createRange(document, targetNode),
-            targetSelectionRange: createRange(document, targetNode)
-        };
-        return Promise.resolve([definition]);
+    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);
     }
-    exports.findDefinition = findDefinition;
+    exports.findLinks = findLinks;
     function createRange(document, node) {
-        return jsonLanguageTypes_1.Range.create(document.positionAt(node.offset), document.positionAt(node.offset + node.length));
-    }
-    function isRef(node) {
-        return node.type === 'string' &&
-            node.parent &&
-            node.parent.type === 'property' &&
-            node.parent.valueNode === node &&
-            node.parent.keyNode.value === "$ref" ||
-            false;
+        return jsonLanguageTypes_1.Range.create(document.positionAt(node.offset + 1), document.positionAt(node.offset + node.length - 1));
     }
     function findTargetNode(doc, path) {
         var tokens = parseJSONPointer(path);

package/lib/umd/services/jsonSchemaService.js

@@ -343,6 +343,7 @@
                         var loc = refSegment ? uri + '#' + refSegment : uri;
                         resolveErrors.push(localize('json.schema.problemloadingref', 'Problems loading reference \'{0}\': {1}', loc, unresolvedSchema.errors[0]));
                     }
+                    delete node.$ref;
                     merge(node, unresolvedSchema.schema, uri, refSegment);
                     return resolveRefs(node, unresolvedSchema.schema, uri, referencedHandle.dependencies);
                 });
@@ -406,14 +407,14 @@
                     while (next.$ref) {
                         var ref = next.$ref;
                         var segments = ref.split('#', 2);
-                        delete next.$ref;
                         if (segments[0].length > 0) {
                             openPromises.push(resolveExternalLink(next, segments[0], segments[1], parentSchemaURL, parentSchemaDependencies));
                             return;
                         }
                         else {
+                            delete next.$ref;
                             if (seenRefs.indexOf(ref) === -1) {
-                                merge(next, parentSchema, parentSchemaURL, segments[1]); // can set next.$ref again, use seenRefs to avoid circle
+                                merge(next, parentSchema, parentSchemaURL, segments[1]); // will remove $ref, can set next.$ref again, use seenRefs to avoid circle
                                 seenRefs.push(ref);
                             }
                         }
@@ -457,9 +458,10 @@
             }
             var seen = Object.create(null);
             var schemas = [];
+            var normalizedResource = normalizeResourceForMatching(resource);
             for (var _i = 0, _a = this.filePatternAssociations; _i < _a.length; _i++) {
                 var entry = _a[_i];
-                if (entry.matchesPattern(resource)) {
+                if (entry.matchesPattern(normalizedResource)) {
                     for (var _b = 0, _c = entry.getURIs(); _b < _c.length; _b++) {
                         var schemaId = _c[_b];
                         if (!seen[schemaId]) {
@@ -512,6 +514,15 @@
             return id;
         }
     }
+    function normalizeResourceForMatching(resource) {
+        // remove querues and fragments, normalize drive capitalization
+        try {
+            return vscode_uri_1.URI.parse(resource).with({ fragment: null, query: null }).toString();
+        }
+        catch (e) {
+            return resource;
+        }
+    }
     function toDisplayString(url) {
         try {
             var uri = vscode_uri_1.URI.parse(url);

package/lib/umd/services/jsonValidation.js

@@ -27,7 +27,7 @@
         }
         JSONValidation.prototype.configure = function (raw) {
             if (raw) {
-                this.validationEnabled = raw.validate;
+                this.validationEnabled = raw.validate !== false;
                 this.commentSeverity = raw.allowComments ? undefined : jsonLanguageTypes_1.DiagnosticSeverity.Error;
             }
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vscode-json-languageservice",
-  "version": "3.8.5",
+  "version": "3.11.0",
   "description": "Language service for JSON",
   "main": "./lib/umd/jsonLanguageService.js",
   "typings": "./lib/umd/jsonLanguageService",
@@ -15,18 +15,17 @@
     "url": "https://github.com/Microsoft/vscode-json-languageservice"
   },
   "devDependencies": {
-    "@types/mocha": "^8.0.3",
+    "@types/mocha": "^8.0.4",
     "@types/node": "^10.12.21",
-    "@typescript-eslint/eslint-plugin": "^4.1.1",
-    "@typescript-eslint/parser": "^4.1.1",
-    "eslint": "^7.9.0",
-    "mocha": "^8.1.3",
-    "nyc": "^15.1.0",
+    "@typescript-eslint/eslint-plugin": "^4.8.2",
+    "@typescript-eslint/parser": "^4.8.2",
+    "eslint": "^7.14.0",
+    "mocha": "^8.2.1",
     "rimraf": "^3.0.2",
-    "typescript": "^4.0.2"
+    "typescript": "^4.1.2"
   },
   "dependencies": {
-    "jsonc-parser": "^2.3.1",
+    "jsonc-parser": "^3.0.0",
     "vscode-languageserver-textdocument": "^1.0.1",
     "vscode-languageserver-types": "3.16.0-next.2",
     "vscode-nls": "^5.0.0",
@@ -43,10 +42,11 @@
     "pretest": "npm run compile",
     "test": "mocha",
     "posttest": "npm run lint",
-    "coverage": "nyc -r lcov npm run test",
+    "coverage": "npx nyc -r lcov npm run test",
     "lint": "eslint src/**/*.ts",
     "install-types-next": "npm install vscode-languageserver-types@next -f -S && npm install vscode-languageserver-textdocument@next -f -S",
     "preversion": "npm test",
-    "postversion": "git push && git push --tags"
+    "postversion": "git push && git push --tags",
+    "sample": "npm run compile && node ./lib/umd/example/sample.js"
   }
 }