Skip to content

Commit 35aba4e

Browse files
gselzerclaude
andcommitted
code-lsp: a package for each purpose, exported as a module
The module does several things, each now in a package of its own: - org.scijava.code.lsp: brokering between scripts and servers (the service, plugins, script sessions, environments), plus SciJava's additions to LSP (updating completion lists, rated signatures). - .launch: running language server processes. - .script: SciJava scripts as plain code (#@ parameters declared). - .jvm: a toolkit for in-process servers of JVM languages. - .impl: the implementation, not exported. The specialized packages depend only on the base package, never on each other. A module-info exports the four public packages; it is open, for SciJava Common's reflection. Package infos say what each is for. To keep the implementation internal, clients get sessions via ScriptSession.owning, the service no longer offers its servers directly (LanguageServerService.server), and data is no longer assumed to be Gson's (the module no longer reads Gson). Tests run on the classpath, not the module path, where the tests' plugin index would shadow the module's own. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 66b0612 commit 35aba4e

35 files changed

Lines changed: 450 additions & 91 deletions

‎code-lsp/pom.xml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,18 @@
135135
</annotationProcessorPaths>
136136
</configuration>
137137
</plugin>
138+
<plugin>
139+
<artifactId>maven-surefire-plugin</artifactId>
140+
<configuration>
141+
<!--
142+
NB: On the module path, the tests' plugin index would shadow the
143+
module's own (both are META-INF/json/org.scijava.plugin.Plugin),
144+
hiding its services from SciJava Common. On the classpath, as in
145+
Fiji, both are found.
146+
-->
147+
<useModulePath>false</useModulePath>
148+
</configuration>
149+
</plugin>
138150
</plugins>
139151
</build>
140152
</project>
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
/*-
2+
* #%L
3+
* Language Server Protocol bridge for SciJava code intelligence.
4+
* %%
5+
* Copyright (C) 2026 SciJava developers.
6+
* %%
7+
* Redistribution and use in source and binary forms, with or without
8+
* modification, are permitted provided that the following conditions are met:
9+
*
10+
* 1. Redistributions of source code must retain the above copyright notice,
11+
* this list of conditions and the following disclaimer.
12+
* 2. Redistributions in binary form must reproduce the above copyright notice,
13+
* this list of conditions and the following disclaimer in the documentation
14+
* and/or other materials provided with the distribution.
15+
*
16+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
20+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26+
* POSSIBILITY OF SUCH DAMAGE.
27+
* #L%
28+
*/
29+
30+
31+
// NB: Open, so that SciJava Common can create its plugins and services, and
32+
// inject their parameters, reflectively.
33+
open module org.scijava.code.lsp {
34+
exports org.scijava.code.lsp;
35+
exports org.scijava.code.lsp.jvm;
36+
exports org.scijava.code.lsp.launch;
37+
exports org.scijava.code.lsp.script;
38+
39+
// NB: SciJava Common, whose plugins and services these are.
40+
requires transitive org.scijava;
41+
requires transitive org.eclipse.lsp4j;
42+
requires transitive org.eclipse.lsp4j.jsonrpc;
43+
requires java.scripting;
44+
}

‎code-lsp/src/main/java/org/scijava/code/lsp/LanguageServerService.java‎

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public interface LanguageServerService extends SciJavaService {
6161
* As {@link #session(ScriptLanguage)}, for code typed into a running
6262
* interpreter: its state reaches the servers via their
6363
* {@link Environment#live()}. For a language no plugin serves, the
64-
* interpreter's variables are completed (see {@link BindingsLanguageServer}).
64+
* interpreter's variables are completed.
6565
*/
6666
ScriptSession session(ScriptLanguage language, ScriptContext live);
6767

@@ -72,23 +72,6 @@ public interface LanguageServerService extends SciJavaService {
7272
*/
7373
ScriptSession session(File file) throws IOException;
7474

75-
/**
76-
* Gets a server for scripts of the given language, standing for all the
77-
* servers plugins offer for it: it opens, changes and closes each document
78-
* on every server for that script, and merges their answers. Each call
79-
* gets its own (e.g. one per editor), sharing the servers behind it. For
80-
* clients speaking the protocol themselves (e.g. via JSON-RPC); others
81-
* use a {@link #session}.
82-
*/
83-
MergedLanguageServer server(ScriptLanguage language);
84-
85-
/**
86-
* As {@link #server(ScriptLanguage)}, for code typed into a running
87-
* interpreter: its state reaches the servers via their
88-
* {@link Environment#live()}.
89-
*/
90-
MergedLanguageServer server(ScriptLanguage language, ScriptContext live);
91-
9275
/**
9376
* Tells the servers that where scripts run may have changed without the
9477
* scripts changing, e.g. as an environment finished building, or packages
@@ -103,8 +86,9 @@ public interface LanguageServerService extends SciJavaService {
10386

10487
/**
10588
* Starts (or reuses) a server process for an LSP language (e.g.
106-
* {@code python}), as a plugin offers it (see {@link LspServerPlugin}), for
107-
* scripts running in the given environment; or returns null if no plugin
89+
* {@code python}), as a plugin offers it (see
90+
* {@link org.scijava.code.lsp.launch.LspServerPlugin}), for scripts running
91+
* in the given environment; or returns null if no plugin
10892
* offers one. For {@link LanguageServerPlugin}s whose servers are
10993
* processes.
11094
*/
@@ -132,8 +116,9 @@ default List<Diagnostic> diagnose(final ScriptLanguage language,
132116
* Gets the variables a script's parameters ({@code #@} lines, and old-style
133117
* {@code // @} lines in its header) define before it runs, by name, with
134118
* their Java types ({@code Object} if unresolvable); in declaration order.
135-
* For servers to know them (see {@link ScriptDocument}). Half-typed
136-
* declarations are expected, and parsed quietly.
119+
* For servers to know them (see
120+
* {@link org.scijava.code.lsp.script.ScriptDocument}). Half-typed declarations
121+
* are expected, and parsed quietly.
137122
*/
138123
Map<String, Class<?>> scriptParameters(String text);
139124
}

‎code-lsp/src/main/java/org/scijava/code/lsp/ScriptSession.java‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,24 @@ public class ScriptSession implements AutoCloseable {
134134
public static ScriptSession owning(final LanguageServer server,
135135
final ScriptLanguage language)
136136
{
137-
return new ScriptSession(server, language, null).connect();
137+
return owning(server, language, null);
138+
}
139+
140+
/**
141+
* As {@link #owning(LanguageServer, ScriptLanguage)}, for a server that
142+
* stands for several (e.g. one per plugin), which report each version's
143+
* problems separately.
144+
*
145+
* @param server The server, which the session owns.
146+
* @param language The script's language, or null if unknown.
147+
* @param allReported Gets the problems in a document once all its servers
148+
* reported them; or null if the server reports them at once.
149+
*/
150+
public static ScriptSession owning(final LanguageServer server,
151+
final ScriptLanguage language,
152+
final Function<String, CompletableFuture<List<Diagnostic>>> allReported)
153+
{
154+
return new ScriptSession(server, language, allReported).connect();
138155
}
139156

140157
/** Becomes the client of its server. */

code-lsp/src/main/java/org/scijava/code/lsp/BindingsLanguageServer.java renamed to code-lsp/src/main/java/org/scijava/code/lsp/impl/BindingsLanguageServer.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* #L%
2828
*/
2929

30-
package org.scijava.code.lsp;
30+
package org.scijava.code.lsp.impl;
3131

3232
import java.util.ArrayList;
3333
import java.util.Comparator;
@@ -44,12 +44,16 @@
4444
import org.eclipse.lsp4j.CompletionItem;
4545
import org.eclipse.lsp4j.CompletionItemKind;
4646
import org.eclipse.lsp4j.CompletionList;
47+
import org.scijava.code.lsp.Environment;
48+
import org.scijava.code.lsp.jvm.Members;
49+
import org.scijava.code.lsp.jvm.ScriptLanguageServer;
4750

4851
/**
4952
* A language server knowing only the variables of a running interpreter (see
5053
* {@link Environment#live()}): their names, and the members of their values'
5154
* classes. For code typed into an interpreter whose language has no servers
52-
* of its own (see {@link LanguageServerService#supports}).
55+
* of its own (see
56+
* {@link org.scijava.code.lsp.LanguageServerService#supports}).
5357
*
5458
* @author Gabriel Selzer
5559
*/

code-lsp/src/main/java/org/scijava/code/lsp/DefaultLanguageServerService.java renamed to code-lsp/src/main/java/org/scijava/code/lsp/impl/DefaultLanguageServerService.java

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* #L%
2828
*/
2929

30-
package org.scijava.code.lsp;
30+
package org.scijava.code.lsp.impl;
3131

3232
import java.io.File;
3333
import java.io.IOException;
@@ -56,6 +56,10 @@
5656
import org.eclipse.lsp4j.services.LanguageClient;
5757
import org.eclipse.lsp4j.services.LanguageClientAware;
5858
import org.eclipse.lsp4j.services.LanguageServer;
59+
import org.scijava.code.lsp.Environment;
60+
import org.scijava.code.lsp.LanguageServerPlugin;
61+
import org.scijava.code.lsp.LanguageServerService;
62+
import org.scijava.code.lsp.ScriptSession;
5963
import org.scijava.log.LogService;
6064
import org.scijava.plugin.Parameter;
6165
import org.scijava.plugin.Plugin;
@@ -116,14 +120,15 @@ public ScriptSession session(final ScriptLanguage language,
116120
{
117121
final ScriptSession session;
118122
if (live != null && !supports(language)) {
119-
session = new ScriptSession(new BindingsLanguageServer(live), language,
120-
null);
123+
session = ScriptSession.owning(new BindingsLanguageServer(live),
124+
language);
121125
}
122126
else {
123127
final MergedLanguageServer server = server(language, live);
124-
session = new ScriptSession(server, language, server::allDiagnostics);
128+
session = ScriptSession.owning(server, language,
129+
server::allDiagnostics);
125130
}
126-
return session.connect().setLogger(log);
131+
return session.setLogger(log);
127132
}
128133

129134
@Override
@@ -145,13 +150,22 @@ public void environmentsChanged() {
145150
}
146151
}
147152

148-
@Override
149-
public MergedLanguageServer server(final ScriptLanguage language) {
153+
/**
154+
* Gets a server for scripts of the given language, standing for all the
155+
* servers plugins offer for it: it opens, changes and closes each document
156+
* on every server for that script, and merges their answers. Each call
157+
* gets its own (e.g. one per session), sharing the servers behind it.
158+
*/
159+
MergedLanguageServer server(final ScriptLanguage language) {
150160
return server(language, null);
151161
}
152162

153-
@Override
154-
public MergedLanguageServer server(final ScriptLanguage language,
163+
/**
164+
* As {@link #server(ScriptLanguage)}, for code typed into a running
165+
* interpreter: its state reaches the servers via their
166+
* {@link Environment#live()}.
167+
*/
168+
MergedLanguageServer server(final ScriptLanguage language,
155169
final ScriptContext live)
156170
{
157171
return new MergedLanguageServer(this, language, plugins(language), live);

code-lsp/src/main/java/org/scijava/code/lsp/DefaultLspService.java renamed to code-lsp/src/main/java/org/scijava/code/lsp/impl/DefaultLspService.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,12 @@
2727
* #L%
2828
*/
2929

30-
package org.scijava.code.lsp;
30+
package org.scijava.code.lsp.impl;
3131

3232
import java.util.HashMap;
3333
import java.util.Map;
3434

35+
import org.scijava.code.lsp.launch.LspServerPlugin;
3536
import org.scijava.log.LogService;
3637
import org.scijava.plugin.Parameter;
3738
import org.scijava.plugin.Plugin;

code-lsp/src/main/java/org/scijava/code/lsp/LaunchedLanguageServer.java renamed to code-lsp/src/main/java/org/scijava/code/lsp/impl/LaunchedLanguageServer.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* #L%
2828
*/
2929

30-
package org.scijava.code.lsp;
30+
package org.scijava.code.lsp.impl;
3131

3232
import java.util.List;
3333
import java.util.Map;
@@ -62,6 +62,7 @@
6262
import org.eclipse.lsp4j.services.LanguageServer;
6363
import org.eclipse.lsp4j.services.TextDocumentService;
6464
import org.eclipse.lsp4j.services.WorkspaceService;
65+
import org.scijava.code.lsp.Environment;
6566

6667
/**
6768
* A language server process (see {@link LspServers}), seen as a

code-lsp/src/main/java/org/scijava/code/lsp/LspServer.java renamed to code-lsp/src/main/java/org/scijava/code/lsp/impl/LspServer.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* #L%
2828
*/
2929

30-
package org.scijava.code.lsp;
30+
package org.scijava.code.lsp.impl;
3131

3232
import java.util.ArrayList;
3333
import java.util.Collections;
@@ -44,9 +44,9 @@
4444
import org.eclipse.lsp4j.ClientCapabilities;
4545
import org.eclipse.lsp4j.CompletionCapabilities;
4646
import org.eclipse.lsp4j.CompletionItemCapabilities;
47+
import org.eclipse.lsp4j.Diagnostic;
4748
import org.eclipse.lsp4j.DidChangeTextDocumentParams;
4849
import org.eclipse.lsp4j.DidCloseTextDocumentParams;
49-
import org.eclipse.lsp4j.Diagnostic;
5050
import org.eclipse.lsp4j.DidOpenTextDocumentParams;
5151
import org.eclipse.lsp4j.HoverCapabilities;
5252
import org.eclipse.lsp4j.InitializeParams;
@@ -71,6 +71,9 @@
7171
import org.eclipse.lsp4j.services.LanguageClient;
7272
import org.eclipse.lsp4j.services.LanguageServer;
7373
import org.eclipse.lsp4j.services.TextDocumentService;
74+
import org.scijava.code.lsp.Environment;
75+
import org.scijava.code.lsp.launch.LspConnection;
76+
import org.scijava.code.lsp.launch.LspServerSpec;
7477
import org.scijava.log.Logger;
7578

7679
/**

code-lsp/src/main/java/org/scijava/code/lsp/LspServers.java renamed to code-lsp/src/main/java/org/scijava/code/lsp/impl/LspServers.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* #L%
2828
*/
2929

30-
package org.scijava.code.lsp;
30+
package org.scijava.code.lsp.impl;
3131

3232
import java.util.ArrayList;
3333
import java.util.Iterator;
@@ -43,6 +43,8 @@
4343
import java.util.function.Consumer;
4444
import java.util.function.LongSupplier;
4545

46+
import org.scijava.code.lsp.Environment;
47+
import org.scijava.code.lsp.launch.LspServerSpec;
4648
import org.scijava.log.Logger;
4749

4850
/**

0 commit comments

Comments
 (0)