Initial start of implementing a LSP for integrity checks (#13612)

* init lsp in multi module build

* changes to build logic

* fix

* fix lsp server
Co-authored-by: Oliver Kopp <[email protected]>

* fix jbang and tests

* refactor to jabls as a new module

* fix jbang and modernizer

* remove typo

* requested changes

* swap

* add NULL_RANGE

* fix README and add comments

* remove --help

* add npx to jabsrv

* remove --help from jabkit

Author: palukku

.jbang/JabLsLauncher.java

@@ -0,0 +1,45 @@
+///usr/bin/env jbang "$0" "$@" ; exit $?
+
+//DESCRIPTION jabls - start a bibtex languageserver
+
+//JAVA 24
+//RUNTIME_OPTIONS --enable-native-access=ALL-UNNAMED
+
+//SOURCES ../jabls-cli/src/main/java/org/jabref/languageserver/cli/ServerCli.java
+//FILES tinylog.properties=../jabls-cli/src/main/resources/tinylog.properties
+
+//SOURCES ../jabls/src/main/java/org/jabref/languageserver/BibtexTextDocumentService.java
+//SOURCES ../jabls/src/main/java/org/jabref/languageserver/BibtexWorkspaceService.java
+//SOURCES ../jabls/src/main/java/org/jabref/languageserver/LSPLauncher.java
+//SOURCES ../jabls/src/main/java/org/jabref/languageserver/LSPServer.java
+
+// REPOS mavencentral,snapshots=https://central.sonatype.com/repository/maven-snapshots/
+// REPOS mavencentral,mavencentralsnapshots=https://central.sonatype.com/repository/maven-snapshots/,s01oss=https://s01.oss.sonatype.org/content/repositories/snapshots/,oss=https://oss.sonatype.org/content/repositories,jitpack=https://jitpack.io,oss2=https://oss.sonatype.org/content/groups/public,ossrh=https://oss.sonatype.org/content/repositories/snapshots
+//REPOS mavencentral,mavencentralsnapshots=https://central.sonatype.com/repository/maven-snapshots/,s01oss=https://s01.oss.sonatype.org/content/repositories/snapshots/,oss=https://oss.sonatype.org/content/repositories,jitpack=https://jitpack.io,oss2=https://oss.sonatype.org/content/groups/public,ossrh=https://oss.sonatype.org/content/repositories/snapshots,raw=https://raw.githubusercontent.com/JabRef/jabref/refs/heads/main/jablib/lib/
+// REPOS mavencentral,jitpack=https://jitpack.io
+
+// Choose one - both should work
+// https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/org/jabref/jablib/
+//DEPS org.jabref:jablib:6.0-SNAPSHOT
+// https://jitpack.io/#jabref/jabref/main-SNAPSHOT
+// DEPS com.github.jabref:jabref:main-SNAPSHOT
+
+//DEPS info.picocli:picocli:4.7.7
+//DEPS org.jspecify:jspecify:1.0.0
+
+// from jabls
+//DEPS org.slf4j:slf4j-api:2.0.17
+//DEPS org.tinylog:slf4j-tinylog:2.7.0
+//DEPS org.tinylog:tinylog-impl:2.7.0
+//DEPS org.slf4j:jul-to-slf4j:2.0.17
+//DEPS org.apache.logging.log4j:log4j-to-slf4j:2.25.1
+//DEPS info.picocli:picocli:4.7.7
+//DEPS org.jabref:afterburner.fx:2.0.0
+//DEPS com.github.eclipse:lsp4j:0.24.0
+
+/// This class is required for [jbang](https://www.jbang.dev/)
+public class JabLsLauncher {
+    public static void main(String[] args) throws Exception {
+        org.jabref.languageserver.cli.ServerCli.main(args);
+    }
+}

.jbang/README.md

@@ -3,10 +3,11 @@
 This directory contains JBang scripts for JabRef.
 [JBang](https://www.jbang.dev/) allows for running Java applications without having a JDK installed (before).
 
-Three use cases:
+Four use cases:
 
 - Try out any pull request with minimal installation. See [our blog entry](https://blog.jabref.org/2025/05/31/run-pr/) for details.
 - Run JabKit - JabRef's CLI tool.
+- Run JabLs - JabRef's Language Server.
 - Run JabSrv - JabRef's HTTP server.
 
 ## Running JabKit without installation
@@ -16,8 +17,8 @@ By using [gg.cmd](https://github.com/eirikb/gg#ggcmd) you can "just run" JabKit
 1. Download `gg.cmd` from: <https://github.com/eirikb/gg#ggcmd>. `gg.cmd` is a "binary" running on macOS, Linux, and Windows. No need for different binaries on different operating systems.
 2. Run `gg.cmd`. This will download and use JBang as wrapper around running JabKit:
 
-    - Linux/macOS: Run `sh ./gg.cmd jbang jabkit@jabref --help`.
-    - Windows: Run `gg.cmd jbang jabkit@jabref --help`.
+    - Linux/macOS: Run `sh ./gg.cmd jbang jabkit@jabref`.
+    - Windows: Run `gg.cmd jbang jabkit@jabref`.
 
 You can also put `gg.cmd` on your `PATH` and make it executable.
 Then you enable `alias jabkit='gg.cmd jbang jabkit@jabref`.
@@ -27,27 +28,57 @@ Then you enable `alias jabkit='gg.cmd jbang jabkit@jabref`.
 If you have JBang installed, just run
 
 ```terminal
-jbang jabkit@jabref --help
+jbang jabkit@jabref
 ```
 
 You can also install `jabkit` permanently in your `PATH`:
 
 1. [Install JBang](https://www.jbang.dev/download/). E.g., by `brew install jbangdev/tap/jbang` or `choco install jbang`
 2. Make `jabkit` available on the command line: `jbang app install jabkit@jabref`
-3. Run `jabkit --help`
+3. Run `jabkit`
 
 [JBang takes care about updating JabKit automatically](https://github.com/orgs/jbangdev/discussions/1636#discussioncomment-6150992).
 
+## Running JabLs
+
+If you have JBang installed, just run following command
+
+```terminal
+jbang jabls@jabref
+```
+
+With `gg.cmd`:
+
+```terminal
+sh ./gg.cmd jbang jabls@jabref
+```
+
+With `npx`:
+
+```terminal
+npx @jbangdev/jbang jabls@jabref
+```
+
+One can add `--help` to see available options.
+
 ## Running JabSrv
 
 If you have JBang installed, just run following command
 
 ```terminal
-jbang jabsrv@jabref --help
+jbang jabsrv@jabref
 ```
 
 With `gg.cmd`:
 
 ```terminal
-sh ./gg.cmd jbang jabsrv@jabref --help
+sh ./gg.cmd jbang jabsrv@jabref
 ```
+
+With `npx`:
+
+```terminal
+npx @jbangdev/jbang jabsrv@jabref
+```
+
+One can add `--help` to see available options. E.g., how to set another port and how to specify served libraries.

build-logic/src/main/kotlin/org.jabref.gradle.base.dependency-rules.gradle.kts

@@ -285,6 +285,70 @@ extraJavaModuleInfo {
     module("com.github.javaparser:javaparser-symbol-solver-core", "com.github.javaparser.symbolsolver.core")
     module("net.sf.jopt-simple:jopt-simple", "jopt.simple")
 
+    // "com.github.eclipse:org.eclipse.lsp4j", "lsp4j"
+    //   - The name 'org.eclipse.lsp4j' is different than the name derived from the Jar file name 'lsp4j'; turn off 'failOnModifiedDerivedModuleNames' or explicitly allow override via 'overrideModuleName()'
+    //   - Not a module and no mapping defined: lsp4j-0.24.0.jar
+    module("com.github.eclipse.lsp4j:org.eclipse.lsp4j", "lsp4j") {
+        overrideModuleName()
+        exportAllPackages()
+        requireAllDefinedDependencies()
+        // Note the missing "lsp4j" at the group
+        mergeJar("com.github.eclipse:lsp4j")
+        requires("com.google.gson")
+
+    }
+    module("com.github.eclipse.lsp4j:org.eclipse.lsp4j.debug", "lsp4j.debug") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+    module("com.github.eclipse.lsp4j:org.eclipse.lsp4j.generator", "lsp4j.generator") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+    module("com.github.eclipse.lsp4j:org.eclipse.lsp4j.jsonrpc", "lsp4j.jsonrpc") {
+        overrideModuleName()
+        exportAllPackages()
+        requires("com.google.gson")
+        requires("java.logging")
+    }
+    module("com.github.eclipse.lsp4j:org.eclipse.lsp4j.jsonrpc.debug", "lsp4j.jsonrpc.debug") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+    module("com.github.eclipse.lsp4j:org.eclipse.lsp4j.websocket", "lsp4j.websocket") {
+        overrideModuleName()
+        exportAllPackages()
+        requireAllDefinedDependencies()
+    }
+    module("com.github.eclipse.lsp4j:org.eclipse.lsp4j.websocket.jakarta", "lsp4j.websocket.jakarta") {
+        overrideModuleName()
+        exportAllPackages()
+        requireAllDefinedDependencies()
+    }
+    module("jakarta.websocket:jakarta.websocket-api", "jakarta.websocket") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+    module("javax.websocket:javax.websocket-api", "javax.websocket") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+    module("org.eclipse.xtend:org.eclipse.xtend", "xtend") {
+        exportAllPackages()
+    }
+    module("org.eclipse.xtend:org.eclipse.xtend.lib", "xtend.lib") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+    module("org.eclipse.xtend:org.eclipse.xtend.lib.macro", "xtend.lib.macro") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+    module("org.eclipse.xtext:org.eclipse.xtext.xbase.lib", "xtext.xbase.lib") {
+        overrideModuleName()
+        exportAllPackages()
+    }
+
     module("com.tngtech.archunit:archunit-junit5-api", "com.tngtech.archunit.junit5.api") {
         exportAllPackages()
         requireAllDefinedDependencies()

build.gradle.kts

@@ -37,6 +37,7 @@ rewrite {
 requirementTracing {
     inputDirectories.setFrom(files("docs",
             "jablib/src/main/java", "jablib/src/test/java",
+            "jabls/src/main/java", "jabls/src/test/java",
             "jabkit/src/main/java", "jabkit/src/test/java",
             "jabgui/src/main/java", "jabgui/src/test/java",
             "jabsrv/src/main/java", "jabsrv/src/test/java"

jabls-cli/build.gradle.kts

@@ -0,0 +1,78 @@
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+
+plugins {
+    id("org.jabref.gradle.module")
+    id("application")
+}
+
+application{
+    mainClass.set("org.jabref.languageserver.cli.ServerCli")
+    mainModule.set("org.jabref.jabls.cli")
+
+    applicationDefaultJvmArgs = listOf(
+        // Enable JEP 450: Compact Object Headers
+        "-XX:+UnlockExperimentalVMOptions", "-XX:+UseCompactObjectHeaders",
+
+        "-XX:+UseZGC", "-XX:+ZUncommit",
+        "-XX:+UseStringDeduplication",
+
+        "--enable-native-access=com.sun.jna,org.apache.lucene.core"
+    )
+}
+
+dependencies {
+    implementation(project(":jablib"))
+    implementation(project(":jabls"))
+
+    implementation("org.openjfx:javafx-controls")
+    implementation("org.openjfx:javafx-fxml")
+    implementation("org.jabref:afterburner.fx")
+
+    implementation("org.slf4j:slf4j-api")
+    implementation("org.tinylog:slf4j-tinylog")
+    implementation("org.tinylog:tinylog-impl")
+    // route all requests to java.util.logging to SLF4J (which in turn routes to tinylog)
+    implementation("org.slf4j:jul-to-slf4j")
+    // route all requests to log4j to SLF4J
+    implementation("org.apache.logging.log4j:log4j-to-slf4j")
+    implementation("info.picocli:picocli")
+    annotationProcessor("info.picocli:picocli-codegen")
+}
+
+tasks.test {
+    testLogging {
+        // set options for log level LIFECYCLE
+        events("FAILED")
+        exceptionFormat = TestExceptionFormat.FULL
+    }
+    maxParallelForks = 1
+}
+
+tasks.named<JavaExec>("run") {
+    doFirst {
+        application.applicationDefaultJvmArgs =
+            listOf(
+                "--enable-native-access=com.sun.jna"
+            )
+    }
+}
+
+javaModulePackaging {
+    applicationName = "jabös"
+    vendor = "JabRef"
+
+    // All targets have to have "app-image" as sole target, since we do not distribute an installer
+    targetsWithOs("windows") {
+        appImageOptions.addAll("--win-console")
+        packageTypes = listOf("app-image")
+    }
+    targetsWithOs("linux") {
+        options.addAll(
+            "--icon", "$projectDir/../jabgui/src/main/resources/icons/JabRef-linux-icon-64.png",
+        )
+        packageTypes = listOf("app-image")
+    }
+    targetsWithOs("macos") {
+        packageTypes = listOf("app-image")
+    }
+}

jabls-cli/src/main/java/module-info.java

@@ -0,0 +1,13 @@
+module org.jabref.jabls.cli {
+    opens org.jabref.languageserver.cli to info.picocli;
+
+    requires transitive org.jabref.jablib;
+    requires transitive org.jabref.jabls;
+
+    requires afterburner.fx;
+
+    requires org.slf4j;
+    requires jul.to.slf4j;
+
+    requires info.picocli;
+}

jabls-cli/src/main/java/org/jabref/languageserver/cli/JabRefResourceLocator.java

@@ -0,0 +1,22 @@
+package org.jabref.languageserver.cli;
+
+import java.util.ResourceBundle;
+
+import org.jabref.logic.l10n.Localization;
+
+import com.airhacks.afterburner.views.ResourceLocator;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+// TODO: Code duplication of org.jabref.gui.util.JabRefResourceLocator - should be streamlined
+// Reason for duplication: The CLI does not depend on the GUI module, so it cannot use the GUI's JabRefResourceLocator directly.
+public class JabRefResourceLocator implements ResourceLocator {
+    private static final Logger LOGGER = LoggerFactory.getLogger(JabRefResourceLocator.class);
+
+    @Override
+    public ResourceBundle getResourceBundle(String s) {
+        LOGGER.debug("Requested bundle for '{}'.", s);
+
+        return Localization.getMessages();
+    }
+}

jabls-cli/src/main/java/org/jabref/languageserver/cli/ServerCli.java

@@ -0,0 +1,36 @@
+package org.jabref.languageserver.cli;
+
+import java.util.concurrent.Callable;
+
+import org.jabref.architecture.AllowedToUseStandardStreams;
+import org.jabref.languageserver.LSPLauncher;
+import org.jabref.logic.preferences.JabRefCliPreferences;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.bridge.SLF4JBridgeHandler;
+import picocli.CommandLine;
+
+@AllowedToUseStandardStreams("This is a CLI application. It resides in the package languageserver.server to be close to the other languageserver related classes.")
+@CommandLine.Command(name = "languageserver", mixinStandardHelpOptions = true, description = "JabLS - JabRef LanguageServer")
+public class ServerCli implements Callable<Void> {
+    private static final Logger LOGGER = LoggerFactory.getLogger(ServerCli.class);
+
+    public static void main(final String[] args) throws InterruptedException {
+        SLF4JBridgeHandler.removeHandlersForRootLogger();
+        SLF4JBridgeHandler.install();
+
+        new CommandLine(new ServerCli()).execute(args);
+    }
+
+    @Override
+    public Void call() throws InterruptedException {
+        LSPLauncher lspLauncher = new LSPLauncher();
+        lspLauncher.run(JabRefCliPreferences.getInstance());
+
+        // Keep the server running until user kills the process (e.g., presses Ctrl+C)
+        Thread.currentThread().join();
+
+        return null;
+    }
+}

jabls-cli/src/main/resources/tinylog.properties

@@ -0,0 +1,15 @@
+level = info
+writerConsole = console
+
+# More shrunk exception logs. See https://tinylog.org/v2/configuration/#strip-stack-trace-elements for details
+exception = strip: jdk.internal
+
+[email protected] = debug
+[email protected] = debug
+
+[email protected] = error
+[email protected] = error
+[email protected] = warn
+[email protected] = warn
+[email protected] = info
+[email protected] = warn