feat: Support new oxlint --lsp flag (#327)

Author: nrayburn-tech

CHANGELOG.md

@@ -4,6 +4,13 @@
 
 ## [Unreleased]
 
+### Added
+
+- Added support for the upcoming 1.29.0 version of Oxlint which allows executing the language server through
+  `oxlint --lsp`. When using automatic configuration, this will be accommodated without change when updating to
+  a newer version of Oxlint. When using a manual configuration with a custom path to the language server, there is
+  a new checkbox that will need to be checked after updating.
+
 ## [0.0.19] - 2025-11-02
 
 ### Changed

sandbox/custom-config/.idea/OxcSettings.xml

@@ -7,6 +7,7 @@ import com.intellij.javascript.nodejs.util.NodePackage
 import com.intellij.javascript.nodejs.util.NodePackageDescriptor
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.util.text.SemVer
 import java.nio.file.Paths
 
 class OxcPackage(private val project: Project) {
@@ -59,22 +60,60 @@ class OxcPackage(private val project: Project) {
         }
     }
 
+    fun binaryParameters(virtualFile: VirtualFile): List<ProcessCommandParameter> {
+        val settings = OxcSettings.getInstance(project)
+        val configurationMode = settings.configurationMode
+
+        return when (configurationMode) {
+            ConfigurationMode.DISABLED -> emptyList()
+            ConfigurationMode.AUTOMATIC -> {
+                findOxcParameters(virtualFile)
+            }
+            ConfigurationMode.MANUAL -> {
+                if (settings.binaryPath.isBlank()) {
+                    findOxcParameters(virtualFile)
+                } else {
+                    settings.binaryParameters.map { ProcessCommandParameter.Value(it) }
+                }
+            }
+        }
+    }
+
     fun isEnabled(): Boolean {
         val settings = OxcSettings.getInstance(project)
         return settings.configurationMode != ConfigurationMode.DISABLED
     }
 
-    private fun findOxcExecutable(virtualFile: VirtualFile?): String? {
-        val path = getPackage(virtualFile)?.getAbsolutePackagePathToRequire(project)
+    private fun findOxcExecutable(virtualFile: VirtualFile): String? {
+        val oxlintPackage = getPackage(virtualFile) ?: return null
+        val path = oxlintPackage.getAbsolutePackagePathToRequire(project)
         if (path != null) {
-            return Paths.get(path, "bin/oxc_language_server").toString()
+            val version = oxlintPackage.getVersion(project)
+
+            return if (version?.isGreaterOrEqualThan(OXLINT_FIRST_LSP_VERSION) == true) {
+                Paths.get(path, "bin/oxlint").toString()
+            } else {
+                Paths.get(path, "bin/oxc_language_server").toString()
+            }
         }
 
         return null
     }
 
+    private fun findOxcParameters(virtualFile: VirtualFile): List<ProcessCommandParameter> {
+        val oxlintPackage = getPackage(virtualFile) ?: return emptyList()
+        val version = oxlintPackage.getVersion(project)
+
+        return if (version?.isGreaterOrEqualThan(OXLINT_FIRST_LSP_VERSION) == true) {
+            listOf(ProcessCommandParameter.Value("--lsp"))
+        } else {
+            emptyList()
+        }
+    }
+
     companion object {
         const val CONFIG_NAME = ".oxlintrc"
+        val OXLINT_FIRST_LSP_VERSION = SemVer("1.29.0", 1, 29, 0)
         val configValidExtensions = listOf("json")
     }
 }

src/main/kotlin/com/github/oxc/project/oxcintellijplugin/OxcPackage.kt

@@ -3,6 +3,7 @@ package com.github.oxc.project.oxcintellijplugin.lsp
 import com.github.oxc.project.oxcintellijplugin.OxcPackage
 import com.github.oxc.project.oxcintellijplugin.OxcTargetRun
 import com.github.oxc.project.oxcintellijplugin.OxcTargetRunBuilder
+import com.github.oxc.project.oxcintellijplugin.ProcessCommandParameter
 import com.github.oxc.project.oxcintellijplugin.settings.OxcSettings
 import com.intellij.execution.configurations.GeneralCommandLine
 import com.intellij.execution.process.OSProcessHandler
@@ -19,9 +20,10 @@ class OxcLspServerDescriptor(
     project: Project,
     root: VirtualFile,
     executable: String,
+    executableParameters: List<ProcessCommandParameter>,
 ) : LspServerDescriptor(project, "Oxc", root) {
     private val targetRun: OxcTargetRun = run {
-        val builder = OxcTargetRunBuilder(project).getBuilder(executable).setWorkingDirectory(root.path)
+        val builder = OxcTargetRunBuilder(project).getBuilder(executable).setWorkingDirectory(root.path).addParameters(executableParameters)
 
         builder.build()
     }

src/main/kotlin/com/github/oxc/project/oxcintellijplugin/lsp/OxcLspServerDescriptor.kt

@@ -36,7 +36,7 @@ class OxcLspServerSupportProvider : LspServerSupportProvider {
             ProjectRootManager.getInstance(project).fileIndex.getContentRootForFile(file) ?: return
         }
 
-        serverStarter.ensureServerStarted(OxcLspServerDescriptor(project, root, executable))
+        serverStarter.ensureServerStarted(OxcLspServerDescriptor(project, root, executable, oxc.binaryParameters(file)))
     }
 
     override fun createLspServerWidgetItem(lspServer: LspServer,

src/main/kotlin/com/github/oxc/project/oxcintellijplugin/lsp/OxcLspServerSupportProvider.kt

@@ -101,6 +101,25 @@ class OxcConfigurable(private val project: Project) :
                             project,
                         ) { it.path }.align(AlignX.FILL).bindText(settings::configPath)
                     }.visibleIf(manualConfiguration.selected)
+
+                    row {
+                        checkBox(OxcBundle.message("oxc.manual.add.lsp.argument")).bindSelected(
+                            { settings.binaryParameters.contains("--lsp") },
+                            { isChecked ->
+                                if (isChecked) {
+                                    if (!settings.binaryParameters.contains("--lsp")) {
+                                        settings.binaryParameters.add("--lsp")
+                                    }
+                                } else {
+                                    settings.binaryParameters.removeIf({ it == "--lsp" })
+                                }
+                            },
+                        )
+
+                        val helpLabel = ContextHelpLabel.create(OxcBundle.message("oxc.manual.add.lsp.argument.help"))
+                        helpLabel.border = JBUI.Borders.emptyLeft(UIUtil.DEFAULT_HGAP)
+                        cell(helpLabel)
+                    }.visibleIf(manualConfiguration.selected)
                 }
             }
 

src/main/kotlin/com/github/oxc/project/oxcintellijplugin/settings/OxcConfigurable.kt

@@ -38,6 +38,13 @@ class OxcSettings(private val project: Project) :
             state.binaryPath = value
         }
 
+    var binaryParameters: MutableList<String>
+        get() = state.binaryParameters
+        set(value) {
+            state.binaryParameters.clear()
+            state.binaryParameters.addAll(value)
+        }
+
     var configPath: String
         get() = state.configPath ?: ""
         set(value) {

src/main/kotlin/com/github/oxc/project/oxcintellijplugin/settings/OxcSettings.kt

@@ -17,6 +17,9 @@ class OxcSettingsState : BaseState() {
     @get:Attribute("binaryPath")
     var binaryPath by string()
 
+    @get:Attribute("binaryParameters")
+    var binaryParameters by list<String>()
+
     @get:Attribute("runTrigger")
     var runTrigger by enum(OxlintRunTrigger.ON_TYPE)
 

src/main/kotlin/com/github/oxc/project/oxcintellijplugin/settings/OxcSettingsState.kt

@@ -30,3 +30,5 @@ oxc.type.aware.label=Enable type aware rules
 oxc.diagnostic.unknown.code=Unknown Code
 oxc.disable.nested.config.label=Disable nested config lookups
 oxc.fix.kind.label=Fix Kind
+oxc.manual.add.lsp.argument=Add --lsp CLI argument
+oxc.manual.add.lsp.argument.help=Oxlint 1.29.0 or newer had a change in architecture. As a result when manually configuring the LSP path to the `oxlint` executable (not the `oxc_language_server` executable), the IDE needs to know when to supply the new required --lsp flag. Checking this box will cause that flag to be supplied.