Add sdl-lsp as template in LSP4IJ

[angelozerr]

To avoid filling at hand the LSP server configuration, I suggest that you contribute to LSP4IJ like

• https://github.com/redhat-developer/lsp4ij/tree/main/src/main/resources/templates/typescript-language-server with several JSON files.
• https://github.com/redhat-developer/lsp4ij/blob/main/docs/user-defined-ls/typescript-language-server.md for the doc.

I'm working on redhat-developer/lsp4ij#999 to provide the capability to install the language server by declaring the steps to install with JSON file installer.json.

[angelozerr]

@dsalathe first in my current PR which support installer redhat-developer/lsp4ij#1047 I have added the sdl-lsp template and the sdl-lsp installer.

I need to clean my code and you will available to install https://github.com/redhat-developer/lsp4ij?tab=readme-ov-file#testing-nightly-builds when the PR will be merged or if you want test now, you can install at hand the build zip, see
https://github.com/redhat-developer/lsp4ij?tab=readme-ov-file#testing-the-ci-builds

It means that user will need just to install LSP4IJ and sdl-lsp will be available without doing some configuration.

At this step, command is java -jar XXX-jar-with-dependencies.jar which is invalid.

When you click on OK button, you will see this dialog:

if you click on OK:

• it will download the JAR
• update the start command to use the downloaded JAR

You can see this process in a task which shows the downloaded JAR progress (that you can cancel if you wish):

When installation is finished, it will update the start command:

and sld-lsp language server will be available without some configuration!

This installation process is managed with a JSON content:

{
  "id": "sdl-lsp",
  "name": "sdl-lsp",
  "check": {
  },
  "run": {
    "download": {
      "name": "Download sdl-lsp",
      "url": "https://oss.sonatype.org/content/repositories/snapshots/io/smartdatalake/sdl-lsp/1.0-SNAPSHOT/sdl-lsp-1.0-20250503.111518-23-jar-with-dependencies.jar",
      "output": {
        "dir": "$USER_HOME$/.lsp4ij/lsp/sdl-lsp"
      },
      "onSuccess": {
        "configureServer": {
          "name": "Configure sdl-lsp server command",
          "command": "java -jar ${output.dir}/${output.file.name}",
          "update": true
        }
      }
    }
  }
}

that you can see in the Installer tab:

You can click on Run Installation hyperlink to re-execute the installation.

As you can notice the download url is hard coded which is bad.

I have managed other language servers like rust, clangd et even DAP server (vscode-js-debug) which uses this installer.json feature and those language servers provide github releases that I can use to guess the last release.

Here a sample with clangd:

{
  "id": "clangd-installer",
  "name": "clangd",
  "check": {
  },
  "run": {
    "download": {
      "name": "Download clangd",
      "github": {
        "owner": "clangd",
        "repository": "clangd",
        "prerelease": true,
        "asset": {
          "windows": "clangd-windows*.zip",
          "linux": "clangd-linux*.zip",
          "mac": "clangd-mac*.zip"
        }
      },
      "url": {
        "windows": "https://github.com/clangd/clangd/releases/download/snapshot_20250518/clangd-windows-snapshot_20250518.zip",
        "linux": "https://github.com/clangd/clangd/releases/download/snapshot_20250518/clangd-linux-snapshot_20250518.zip",
        "mac": " https://github.com/clangd/clangd/releases/download/snapshot_20250518/clangd-mac-snapshot_20250518.zip"
      },
      "output": {
        "dir": "$USER_HOME$/.lsp4ij/lsp",
        "file": {
          "name": {
            "windows": "bin/clangd.exe",
            "linux": "bin/clangd",
            "mac": "bin/clangd"
          },
          "executable": true
        }
      },
      "onSuccess": {
        "configureServer": {
          "name": "Configure Clangd server command",
          "command": "${output.dir}/${output.file.name}",
          "update": true
        }
      }
    }
  }
}

When install is done it uses github section:

"github": {
        "owner": "clangd",
        "repository": "clangd",
        "prerelease": true,
        "asset": {
          "windows": "clangd-windows*.zip",
          "linux": "clangd-linux*.zip",
          "mac": "clangd-mac*.zip"
        }
      }

It call the url https://api.github.com/repos/" + owner + "/" + repository + "/releases, for instance for clangd https://api.github.com/repos/clangd/clangd/releases which returns JSON files with assets.

according the OS it search the first asset with proper name (ex : for windows clangd-windows*.zip) * is used here because asset contains some date.

In your case you don't need os, and it could be:

"github": {
        "owner": "smart-data-lake",
        "repository": "sdl-lsp",
        "prerelease": false,
        "asset": "sdl-lsp-*-jar-with-dependencies.jar"
      }

And in this case you don't need to declare url (or declare it if this asset strategy doesn't work).

It means that if you want to do that, your sdl-lsp should provide releases on github.

I wanted to do the same thing for maven by using a JSON API but as you are using sonatype which is based on Nexus2, it doesn't provide some nice JSON api to know available artifacts.

It seems Nexus3 provides that but I have never found that.

It seems that it exists https://central.sonatype.com/api-doc but I have not found your artifact.

In other words you have 2 choices:

• deploy your JAR as releases in github
• deploy your artifacts in https://central.sonatype.com and I could implement a maven JSON section like I did for github.

[angelozerr]

We could use this JSON url https://search.maven.org/solrsearch/select?q=g:io.smartdatalake&rows=20&wt=json when sdl-lsp will work on it https://search.maven.org/solrsearch/select?q=g:io.smartdatalake+AND+a:sdl-lsp&rows=1&core=gav&wt=json&sort=version+desc should return something

[angelozerr]

Yiu can now install https://github.com/redhat-developer/lsp4ij?tab=readme-ov-file#testing-nightly-builds to test the template with install.

I changed the lzbel for the template

Plezse give me feedback.

[dsalathe]

Hi @angelozerr , huge thanks for this new feature, it really looks awesome!
I need to find some spare time to try this out but I will definitely be excited to do so.
Concerning the release part, @zzeekk I would be interested in your thoughts, but personally switching to github release sounds good to me.

[angelozerr]

Hi @angelozerr , huge thanks for this new feature, it really looks awesome!

You are welcome!

I need to find some spare time to try this out but I will definitely be excited to do so. Concerning the release part, @zzeekk I would be interested in your thoughts, but personally switching to github release sounds good to me.

If you can to switch to github, it will be easy, see doc at https://github.com/redhat-developer/lsp4ij/blob/main/docs/UserDefinedLanguageServerTemplate.md#github-asset-download and do a PR to update https://github.com/redhat-developer/lsp4ij/blob/main/src/main/resources/templates/lsp/sdl-lsp/installer.json

I repeat me, but if you like LSP4IJ please add a review in JetBrains marketplace to help us to promote LSP4IJ. Thanks!