Add code action to open json schema (redhat-developer#395)

* add code action to open json schema Signed-off-by: Yevhen Vydolob <[email protected]> * Fix eslint warning, fix review comments Signed-off-by: Yevhen Vydolob <[email protected]> * Fix tests Signed-off-by: Yevhen Vydolob <[email protected]> * simplify code actions implementation Signed-off-by: Yevhen Vydolob <[email protected]> * add code action to open schema only if 'showDocument' supported Signed-off-by: Yevhen Vydolob <[email protected]> * Fix tests Signed-off-by: Yevhen Vydolob <[email protected]> * fix test Signed-off-by: Yevhen Vydolob <[email protected]> * Add supported protocol version in readme Signed-off-by: Yevhen Vydolob <[email protected]>
bleach31 · Feb 12, 2021 · b241d78 · b241d78
1 parent 19df4f0
commit b241d78
Show file tree

Hide file tree

Showing 29 changed files with 581 additions and 107 deletions.
diff --git a/README.md b/README.md
@@ -234,6 +234,10 @@ To run the image you can use:
 docker run -it quay.io/redhat-developer/yaml-language-server:latest
 ```
 
+## Language Server Protocol version
+
+`yaml-language-server` use `[email protected]` which implements [LSP 3.16](https://github.com/Microsoft/language-server-protocol/blob/gh-pages/_specifications/specification-3-16.md)
+
 ## Clients
 
 This repository only contains the server implementation. Here are some known clients consuming this server:

diff --git a/package.json b/package.json
@@ -40,9 +40,9 @@
     "jsonc-parser": "^2.2.1",
     "request-light": "^0.2.4",
     "vscode-json-languageservice": "^3.10.0",
-    "vscode-languageserver": "^5.2.1",
+    "vscode-languageserver": "^7.0.0",
     "vscode-languageserver-textdocument": "^1.0.1",
-    "vscode-languageserver-types": "^3.15.1",
+    "vscode-languageserver-types": "^3.16.0",
     "vscode-nls": "^4.1.2",
     "vscode-uri": "^2.1.1",
     "yaml-language-server-parser": "next"
@@ -53,6 +53,7 @@
     "@types/node": "^12.11.7",
     "@types/prettier": "2.0.2",
     "@types/sinon": "^9.0.5",
+    "@types/sinon-chai": "^3.2.5",
     "@typescript-eslint/eslint-plugin": "^3.2.0",
     "@typescript-eslint/parser": "^3.2.0",
     "chai": "^4.2.0",

diff --git a/src/commands.ts b/src/commands.ts
@@ -0,0 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export enum YamlCommands {
+  JUMP_TO_SCHEMA = 'jumpToSchema',
+}
diff --git a/src/languageserver/commandExecutor.ts b/src/languageserver/commandExecutor.ts
@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ExecuteCommandParams } from 'vscode-languageserver';
+
+export interface CommandHandler {
+  (...args: unknown[]): void;
+}
+
+export class CommandExecutor {
+  private commands = new Map<string, CommandHandler>();
+  executeCommand(params: ExecuteCommandParams): void {
+    if (this.commands.has(params.command)) {
+      const handler = this.commands.get(params.command);
+      return handler(...params.arguments);
+    }
+    throw new Error(`Command '${params.command}' not found`);
+  }
+
+  registerCommand(commandId: string, handler: CommandHandler): void {
+    this.commands.set(commandId, handler);
+  }
+}
+
+export const commandExecutor = new CommandExecutor();
diff --git a/src/languageserver/handlers/languageHandlers.ts b/src/languageserver/handlers/languageHandlers.ts
@@ -4,6 +4,8 @@
  *--------------------------------------------------------------------------------------------*/
 import { FoldingRange } from 'vscode-json-languageservice';
 import {
+  CodeAction,
+  CodeActionParams,
   CompletionList,
   DidChangeWatchedFilesParams,
   DocumentFormattingParams,
@@ -12,7 +14,7 @@ import {
   DocumentOnTypeFormattingParams,
   DocumentSymbolParams,
   FoldingRangeParams,
-  IConnection,
+  Connection,
   TextDocumentPositionParams,
 } from 'vscode-languageserver';
 import { DocumentSymbol, Hover, SymbolInformation, TextEdit } from 'vscode-languageserver-types';
@@ -27,7 +29,7 @@ export class LanguageHandlers {
   private validationHandler: ValidationHandler;
 
   constructor(
-    private readonly connection: IConnection,
+    private readonly connection: Connection,
     languageService: LanguageService,
     yamlSettings: SettingsState,
     validationHandler: ValidationHandler
@@ -45,6 +47,7 @@ export class LanguageHandlers {
     this.connection.onCompletion((textDocumentPosition) => this.completionHandler(textDocumentPosition));
     this.connection.onDidChangeWatchedFiles((change) => this.watchedFilesHandler(change));
     this.connection.onFoldingRanges((params) => this.foldingRangeHandler(params));
+    this.connection.onCodeAction((params) => this.codeActionHandler(params));
     this.connection.onDocumentOnTypeFormatting((params) => this.formatOnTypeHandler(params));
   }
 
@@ -165,4 +168,13 @@ export class LanguageHandlers {
 
     return this.languageService.getFoldingRanges(textDocument, this.yamlSettings.capabilities.textDocument.foldingRange);
   }
+
+  codeActionHandler(params: CodeActionParams): CodeAction[] | undefined {
+    const textDocument = this.yamlSettings.documents.get(params.textDocument.uri);
+    if (!textDocument) {
+      return;
+    }
+
+    return this.languageService.getCodeAction(textDocument, params);
+  }
 }
diff --git a/src/languageserver/handlers/notificationHandlers.ts b/src/languageserver/handlers/notificationHandlers.ts
@@ -2,7 +2,7 @@
  *  Copyright (c) Red Hat, Inc. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { IConnection } from 'vscode-languageserver';
+import { Connection } from 'vscode-languageserver';
 import { CustomSchemaProvider } from '../../languageservice/services/yamlSchemaService';
 import { LanguageService, SchemaConfiguration } from '../../languageservice/yamlLanguageService';
 import {
@@ -20,7 +20,7 @@ export class NotificationHandlers {
   private settingsHandler: SettingsHandler;
 
   constructor(
-    private readonly connection: IConnection,
+    private readonly connection: Connection,
     languageService: LanguageService,
     yamlSettings: SettingsState,
     settingsHandler: SettingsHandler

diff --git a/src/languageserver/handlers/requestHandlers.ts b/src/languageserver/handlers/requestHandlers.ts
@@ -2,14 +2,14 @@
  *  Copyright (c) Red Hat, Inc. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { IConnection } from 'vscode-languageserver';
+import { Connection } from 'vscode-languageserver';
 import { MODIFICATION_ACTIONS, SchemaAdditions, SchemaDeletions } from '../../languageservice/services/yamlSchemaService';
 import { LanguageService } from '../../languageservice/yamlLanguageService';
 import { SchemaModificationNotification } from '../../requestTypes';
 
 export class RequestHandlers {
   private languageService: LanguageService;
-  constructor(private readonly connection: IConnection, languageService: LanguageService) {
+  constructor(private readonly connection: Connection, languageService: LanguageService) {
     this.languageService = languageService;
   }
 

diff --git a/src/languageserver/handlers/settingsHandlers.ts b/src/languageserver/handlers/settingsHandlers.ts
@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 import { xhr, configure as configureHttpRequests } from 'request-light';
-import { DidChangeConfigurationParams, DocumentFormattingRequest, IConnection } from 'vscode-languageserver';
+import { DidChangeConfigurationParams, DocumentFormattingRequest, Connection } from 'vscode-languageserver';
 import { isRelativePath, relativeToAbsolutePath } from '../../languageservice/utils/paths';
 import { checkSchemaURI, JSON_SCHEMASTORE_URL, KUBERNETES_SCHEMA_URL } from '../../languageservice/utils/schemaUrls';
 import { LanguageService, LanguageSettings } from '../../languageservice/yamlLanguageService';
@@ -12,7 +12,7 @@ import { ValidationHandler } from './validationHandlers';
 
 export class SettingsHandler {
   constructor(
-    private readonly connection: IConnection,
+    private readonly connection: Connection,
     private readonly languageService: LanguageService,
     private readonly yamlSettings: SettingsState,
     private readonly validationHandler: ValidationHandler

diff --git a/src/languageserver/handlers/validationHandlers.ts b/src/languageserver/handlers/validationHandlers.ts
@@ -2,7 +2,7 @@
  *  Copyright (c) Red Hat, Inc. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { IConnection } from 'vscode-languageserver';
+import { Connection } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { Diagnostic } from 'vscode-languageserver-types';
 import { isKubernetesAssociatedDocument } from '../../languageservice/parser/isKubernetes';
@@ -14,7 +14,7 @@ export class ValidationHandler {
   private languageService: LanguageService;
   private yamlSettings: SettingsState;
 
-  constructor(private readonly connection: IConnection, languageService: LanguageService, yamlSettings: SettingsState) {
+  constructor(private readonly connection: Connection, languageService: LanguageService, yamlSettings: SettingsState) {
     this.languageService = languageService;
     this.yamlSettings = yamlSettings;
 

diff --git a/src/languageserver/handlers/workspaceHandlers.ts b/src/languageserver/handlers/workspaceHandlers.ts
@@ -0,0 +1,19 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ExecuteCommandParams, Connection } from 'vscode-languageserver';
+import { CommandExecutor } from '../commandExecutor';
+
+export class WorkspaceHandlers {
+  constructor(private readonly connection: Connection, private readonly commandExecutor: CommandExecutor) {}
+
+  registerHandlers(): void {
+    this.connection.onExecuteCommand((params) => this.executeCommand(params));
+  }
+
+  private executeCommand(params: ExecuteCommandParams): void {
+    return this.commandExecutor.executeCommand(params);
+  }
+}