Implement Ruff LSP

Author: theCapypara

build-aux/modules/python-pyflakes.json

@@ -44,7 +44,6 @@
     "modules/GTKCssLanguageServer.json",
     "modules/icon-development-kit.json",
     "modules/python-rope.json",
-    "modules/python-pyflakes.json",
     "modules/python-python-lsp-server.json",
     "modules/python-ruff.json",
     "modules/python-ruff-lsp.json",

build-aux/re.sonny.Workbench.Devel.json

@@ -44,7 +44,6 @@
     "modules/GTKCssLanguageServer.json",
     "modules/icon-development-kit.json",
     "modules/python-rope.json",
-    "modules/python-pyflakes.json",
     "modules/python-python-lsp-server.json",
     "modules/python-ruff.json",
     "modules/python-ruff-lsp.json",

build-aux/re.sonny.Workbench.json

@@ -7,7 +7,7 @@ project('Workbench', ['vala', 'c', 'rust'],
 gnome = import('gnome')
 
 if get_option('profile') == 'development'
-	app_id = 're.sonny.Workbench.Devel'
+  app_id = 're.sonny.Workbench.Devel'
   vcs_tag = run_command('git', 'rev-parse', '--short', 'HEAD').stdout().strip()
   if vcs_tag == ''
     version_suffix = '-devel'
@@ -27,6 +27,9 @@ pkgdatadir = join_paths(datadir, app_id)
 subdir('data')
 subdir('src')
 
+# Needed for the Ruff Python LSP
+install_data('ruff.toml', install_dir: pkgdatadir)
+
 gnome.post_install(
   glib_compile_schemas: true,
   gtk_update_icon_cache: true,

meson.build

@@ -19,7 +19,7 @@ export const languages = [
     types: [],
     document: null,
     default_file: "main.blp",
-    language_server: ["blueprint-compiler", "lsp"],
+    language_server: [["blueprint-compiler", "lsp"]],
     formatting_options: {
       ...formatting_options,
       tabSize: 2,
@@ -44,12 +44,14 @@ export const languages = [
     default_file: "main.js",
     index: 0,
     language_server: [
-      "biome",
-      "lsp-proxy",
-      // src/meson.build installs biome.json there
-      GLib.getenv("FLATPAK_ID")
-        ? `--config-path=${pkg.pkgdatadir}`
-        : `--config-path=src/langs/javascript`,
+      [
+        "biome",
+        "lsp-proxy",
+        // src/meson.build installs biome.json there
+        GLib.getenv("FLATPAK_ID")
+          ? `--config-path=${pkg.pkgdatadir}`
+          : `--config-path=src/langs/javascript`,
+      ],
     ],
     formatting_options: {
       ...formatting_options,
@@ -64,7 +66,7 @@ export const languages = [
     types: ["text/css"],
     document: null,
     default_file: "main.css",
-    language_server: ["gtkcsslanguageserver"],
+    language_server: [["gtkcsslanguageserver"]],
     formatting_options: {
       ...formatting_options,
       tabSize: 2,
@@ -79,7 +81,7 @@ export const languages = [
     document: null,
     default_file: "main.vala",
     index: 1,
-    language_server: ["vala-language-server"],
+    language_server: [["vala-language-server"]],
     formatting_options: {
       ...formatting_options,
       tabSize: 4,
@@ -94,7 +96,7 @@ export const languages = [
     document: null,
     default_file: "code.rs",
     index: 2,
-    language_server: ["rust-analyzer"],
+    language_server: [["rust-analyzer"]],
     formatting_options: {
       ...formatting_options,
       tabSize: 4,
@@ -109,7 +111,17 @@ export const languages = [
     document: null,
     default_file: "main.py",
     index: 3,
-    language_server: ["pylsp", "-v"],
+    language_server: [
+      ["pylsp", "-v"],
+      {
+        argv: ["ruff-lsp"],
+        initializationOptions: {
+          settings: {
+            args: ["--config", `${pkg.pkgdatadir}/ruff.toml`],
+          },
+        },
+      },
+    ],
     formatting_options: {
       ...formatting_options,
       tabSize: 4,
@@ -123,27 +135,52 @@ export function getLanguage(id) {
   );
 }
 
+/**
+ * Returns a LSPClient for the given langauge.
+ * If multiple are defined, returns an array of LSPClients instead.
+ */
 export function createLSPClient({ lang, root_uri, quiet = true }) {
   const language_id = lang.id;
 
-  const lspc = new LSPClient(lang.language_server, {
-    rootUri: root_uri,
-    languageId: language_id,
-    quiet,
-  });
-  lspc.connect("exit", () => {
-    console.debug(`${language_id} language server exit`);
-  });
-  lspc.connect("output", (_self, message) => {
-    console.debug(
-      `${language_id} language server OUT:\n${JSON.stringify(message)}`,
-    );
-  });
-  lspc.connect("input", (_self, message) => {
-    console.debug(
-      `${language_id} language server IN:\n${JSON.stringify(message)}`,
-    );
-  });
+  const lspcs = [];
+
+  for (const language_server of lang.language_server) {
+    // language_server is either an array (then it's just argv) or an object with more info.
+    let argv,
+      initializationOptions = undefined;
+
+    if (Array.isArray(language_server)) {
+      argv = language_server;
+    } else {
+      argv = language_server.argv;
+      initializationOptions = language_server.initializationOptions;
+    }
+
+    const lspc = new LSPClient(argv, {
+      rootUri: root_uri,
+      languageId: language_id,
+      quiet,
+      initializationOptions,
+    });
+    lspc.connect("exit", () => {
+      console.debug(`${language_id} language server exit`);
+    });
+    lspc.connect("output", (_self, message) => {
+      console.debug(
+        `${language_id} language server OUT:\n${JSON.stringify(message)}`,
+      );
+    });
+    lspc.connect("input", (_self, message) => {
+      console.debug(
+        `${language_id} language server IN:\n${JSON.stringify(message)}`,
+      );
+    });
+    lspcs.push(lspc);
+  }
 
-  return lspc;
+  // If the language has only one language server, return it
+  if (lspcs.length === 1) {
+    return lspcs[0];
+  }
+  return lspcs;
 }

src/common.js

@@ -7,7 +7,7 @@ export class PythonDocument extends Document {
   constructor(...args) {
     super(...args);
 
-    this.lspc = setup({ document: this });
+    this.lspcs = setup({ document: this });
   }
 
   async format() {
@@ -17,18 +17,18 @@ export class PythonDocument extends Document {
 }
 
 function formatPythonCode(text) {
-  const blackLauncher = Gio.SubprocessLauncher.new(
+  const ruffLauncher = Gio.SubprocessLauncher.new(
     Gio.SubprocessFlags.STDIN_PIPE |
       Gio.SubprocessFlags.STDOUT_PIPE |
       Gio.SubprocessFlags.STDERR_PIPE,
   );
 
-  const blackProcess = blackLauncher.spawnv(["black", "--quiet", "-"]);
+  const ruffProcess = ruffLauncher.spawnv(["ruff", "format", "--quiet", "-"]);
 
-  const [success, stdout, stderr] = blackProcess.communicate_utf8(text, null);
+  const [success, stdout, stderr] = ruffProcess.communicate_utf8(text, null);
 
   if (!success || stderr !== "") {
-    console.error(`Error running black: ${stderr}`);
+    console.error(`Error running ruff format: ${stderr}`);
     return text;
   }
 

src/langs/python/PythonDocument.js

@@ -4,29 +4,41 @@ import { getLanguage } from "../../util.js";
 export function setup({ document }) {
   const { file, buffer, code_view } = document;
 
-  const lspc = createLSPClient({
+  const lspcs = createLSPClient({
     lang: getLanguage("python"),
     root_uri: file.get_parent().get_uri(),
     quiet: false,
   });
-  lspc.buffer = buffer;
-  lspc.uri = file.get_uri();
-  lspc.connect(
-    "notification::textDocument/publishDiagnostics",
-    (_self, params) => {
-      if (params.uri !== file.get_uri()) {
-        return;
-      }
-      code_view.handleDiagnostics(params.diagnostics);
-    },
-  );
-
-  lspc.start().catch(console.error);
-
-  buffer.connect("modified-changed", () => {
-    if (!buffer.get_modified()) return;
-    lspc.didChange().catch(console.error);
-  });
 
-  return lspc;
+  const combinedDiagnostics = {};
+
+  for (const lspc of lspcs) {
+    lspc.buffer = buffer;
+    lspc.uri = file.get_uri();
+    lspc.connect(
+      "notification::textDocument/publishDiagnostics",
+      (self, params) => {
+        if (params.uri !== file.get_uri()) {
+          return;
+        }
+        combinedDiagnostics[self.argv[0]] = params.diagnostics;
+
+        let totalDiagnostics = [];
+        for (const d of Object.values(combinedDiagnostics)) {
+          totalDiagnostics = totalDiagnostics.concat(...d);
+        }
+
+        code_view.handleDiagnostics(totalDiagnostics);
+      },
+    );
+
+    lspc.start().catch(console.error);
+
+    buffer.connect("modified-changed", () => {
+      if (!buffer.get_modified()) return;
+      lspc.didChange().catch(console.error);
+    });
+  }
+
+  return lspcs;
 }

src/langs/python/python.js

@@ -22,7 +22,15 @@ const clientInfo = {
 export default class LSPClient {
   constructor(
     argv,
-    { rootUri, uri, languageId, buffer, env = {}, quiet = true },
+    {
+      rootUri,
+      uri,
+      languageId,
+      buffer,
+      env = {},
+      quiet = true,
+      initializationOptions = undefined,
+    },
   ) {
     this.ready = false;
     this.started = false;
@@ -36,6 +44,7 @@ export default class LSPClient {
     this.buffer = buffer;
     this.env = env;
     this.quiet = quiet;
+    this.initializationOptions = initializationOptions;
 
     // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#clientCapabilities
     this.capabilities = {
@@ -75,6 +84,7 @@ export default class LSPClient {
       capabilities,
       rootUri,
       locale: "en",
+      initializationOptions: this.initializationOptions,
     });
 
     // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initialized