feat: add statusBar of rslint (#253)

Author: hardfist

internal/lsp/server.go

@@ -2,7 +2,6 @@ package lsp
 
 import (
 	"context"
-	"encoding/json"
 	"errors"
 	"fmt"
 	"io"
@@ -12,6 +11,7 @@ import (
 	"strings"
 	"sync"
 
+	"github.com/go-json-experiment/json"
 	"github.com/microsoft/typescript-go/shim/ast"
 	"github.com/microsoft/typescript-go/shim/bundled"
 	"github.com/microsoft/typescript-go/shim/core"
@@ -266,10 +266,9 @@ func (s *LSPServer) handleCodeAction(ctx context.Context, req *jsonrpc2.Request)
 	if err := json.Unmarshal(*req.Params, &params); err != nil {
 		return nil, &jsonrpc2.Error{
 			Code:    jsonrpc2.CodeParseError,
-			Message: "Failed to parse code action params",
+			Message: fmt.Sprintf("Failed to parse code action params %v", err),
 		}
 	}
-
 	uri := params.TextDocument.Uri
 
 	// Get stored diagnostics for this document

packages/vscode-extension/src/Extension.ts

@@ -4,10 +4,14 @@ import {
   workspace,
   WorkspaceFolder,
   ExtensionMode,
+  OutputChannel,
+  window,
 } from 'vscode';
 import { State } from 'vscode-languageclient/node';
 import { LogLevel, Logger } from './logger';
 import { Rslint } from './Rslint';
+import { setupStatusBar } from './statusBar';
+import { RegisterCommands } from './commands';
 
 export class Extension implements Disposable {
   private rslintInstances: Map<string, Rslint> = new Map();
@@ -25,12 +29,26 @@ export class Extension implements Disposable {
     this.logger.info('Rslint extension activating...');
 
     const folders = workspace.workspaceFolders ?? [];
+    const outputChannel = window.createOutputChannel(
+      'Rslint Language Server',
+      'log',
+    );
+    const lspOutputChannel = window.createOutputChannel(
+      'Rslint Language Server(LSP)',
+    );
+
     for (const folder of folders) {
-      const workspaceRslint = this.createRslintInstance(folder.name, folder);
+      const workspaceRslint = this.createRslintInstance(
+        folder.name,
+        folder,
+        outputChannel,
+        lspOutputChannel,
+      );
       await workspaceRslint.start();
       this.setupStateChangeMonitoring(workspaceRslint, folder.name);
     }
-
+    setupStatusBar(this.context);
+    RegisterCommands(this.context, outputChannel, lspOutputChannel);
     this.logger.info('Rslint extension activated successfully');
   }
 
@@ -55,14 +73,21 @@ export class Extension implements Disposable {
   public createRslintInstance(
     id: string,
     workspaceFolder: WorkspaceFolder,
+    outputChannel: OutputChannel,
+    lspOutputChannel: OutputChannel,
   ): Rslint {
     if (this.rslintInstances.has(id)) {
       this.logger.warn(`Rslint instance with id '${id}' already exists`);
       return this.rslintInstances.get(id)!;
     }
 
     // TODO: single file mode
-    const rslint = new Rslint(this, workspaceFolder);
+    const rslint = new Rslint(
+      this,
+      workspaceFolder,
+      outputChannel,
+      lspOutputChannel,
+    );
     this.rslintInstances.set(id, rslint);
     this.logger.debug(`Created Rslint instance with id: ${id}`);
     return rslint;

packages/vscode-extension/src/Rslint.ts

@@ -25,11 +25,19 @@ export class Rslint implements Disposable {
   private readonly extension: Extension;
   private readonly workspaceFolder: WorkspaceFolder;
   private lspOutputChannel: OutputChannel | undefined;
-
-  constructor(extension: Extension, workspaceFolder: WorkspaceFolder) {
+  private outputChannel: OutputChannel | undefined;
+
+  constructor(
+    extension: Extension,
+    workspaceFolder: WorkspaceFolder,
+    outputChannel: OutputChannel,
+    lspOutputChannel: OutputChannel,
+  ) {
     this.extension = extension;
     this.workspaceFolder = workspaceFolder;
     this.logger = new Logger('Rslint (workspace)').useDefaultLogLevel();
+    this.lspOutputChannel = lspOutputChannel;
+    this.outputChannel = outputChannel;
   }
 
   public async start(): Promise<void> {
@@ -69,10 +77,10 @@ export class Rslint implements Disposable {
           '**/{rslint.{json,jsonc},package-lock.json,pnpm-lock.yaml,yarn.lock}',
         ),
       },
+      outputChannel: this.outputChannel,
     };
 
     if (traceEnabled) {
-      this.lspOutputChannel = window.createOutputChannel('Rslint LSP trace');
       clientOptions.traceOutputChannel = this.lspOutputChannel;
       this.logger.info(
         'LSP tracing enabled, output will be logged to "Rslint LSP trace" channel',

packages/vscode-extension/src/commands.ts

@@ -0,0 +1,57 @@
+import * as vscode from 'vscode';
+export function RegisterCommands(
+  context: vscode.ExtensionContext,
+  outputChannel: vscode.OutputChannel,
+  traceOutputChannel: vscode.OutputChannel,
+) {
+  context.subscriptions.push(
+    vscode.commands.registerCommand('rslint.showMenu', showCommands),
+  );
+  // context.subscriptions.push(vscode.commands.registerCommand('rslint.restart', async () => {
+  //     await vscode.commands.executeCommand('rslint.restart');
+  // }));
+  context.subscriptions.push(
+    vscode.commands.registerCommand('rslint.output.focus', () => {
+      outputChannel.show();
+    }),
+  );
+  context.subscriptions.push(
+    vscode.commands.registerCommand('rslint.lsp-trace.focus', () => {
+      traceOutputChannel.show();
+    }),
+  );
+}
+
+async function showCommands(): Promise<void> {
+  const commands: readonly {
+    label: string;
+    description: string;
+    command: string;
+  }[] = [
+    // {
+    //     label: "$(refresh) RestartRslint Server",
+    //     description: "Restart the Rslint language server",
+    //     command: "rslint.restart",
+    // },
+    {
+      label: '$(output) Show Rslint Server Log',
+      description: 'Show the Rslint server log',
+      command: 'rslint.output.focus',
+    },
+    {
+      label: '$(debug-console) Show Rslint LSP Messages',
+      description: 'Show the LSP communication trace',
+      command: 'rslint.lsp-trace.focus',
+    },
+  ];
+
+  // eslint-disable-next-line @typescript-eslint/await-thenable
+  const selected = await vscode.window.showQuickPick(commands, {
+    placeHolder: 'Rslint Commands',
+  });
+
+  if (selected) {
+    // eslint-disable-next-line
+    await vscode.commands.executeCommand(selected.command);
+  }
+}

packages/vscode-extension/src/statusBar.ts

@@ -0,0 +1,16 @@
+import * as vscode from 'vscode';
+export function setupStatusBar(context: vscode.ExtensionContext) {
+  const statusBar = vscode.window.createStatusBarItem(
+    vscode.StatusBarAlignment.Right,
+    100,
+  );
+  statusBar.text = '$(beaker) rslint';
+  statusBar.tooltip = 'Rslint Language Server';
+  statusBar.command = 'rslint.showMenu';
+  statusBar.backgroundColor = new vscode.ThemeColor(
+    'statusBarItem.warningBackground',
+  );
+  statusBar.show();
+
+  context.subscriptions.push(statusBar);
+}