vscode-json-languageservice 3.9.1 → 3.10.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+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,52 @@ 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
------------
+## Development
 
+    git clone https://github.com/microsoft/vscode-json-languageservice
+    cd vscode-json-languageservice
+    yarn
 
-- clone this repo, run yarn
-- `yarn test` to compile and run tests
+Use `yarn test` to compile and run tests
 
-How can I run and debug the service?
+### 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) {

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/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) {

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vscode-json-languageservice",
-  "version": "3.9.1",
+  "version": "3.10.0",
   "description": "Language service for JSON",
   "main": "./lib/umd/jsonLanguageService.js",
   "typings": "./lib/umd/jsonLanguageService",