Expose Fix Imports command to LSP Clients by shivam71 · Pull Request #9062 · apache/netbeans

shivam71 · 2025-12-03T09:37:03Z

Fix Imports Code action for LSP Client

Fix Imports command in netbeans helps to add missing imports.
Currently each missing import was shown as quick fix suggestions to LSP Clients.
This change explicitly add Fix Imports... as a source code action to add all missing imports in one command.
Further the HTML Dialog allows user to choose among the possible import candidates for each missing import.

Click to collapse/expand PR instructions

By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -

are all your own work, and you have the right to contribute them.
are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).

Please make sure (eg. git log) that all commits have a valid name and email address for you in the Author field.

If you're a first time contributor, see the Contributing guidelines for more information.

If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.

PR approval and merge checklist:

Was this PR correctly labeled, did the right tests run? When did they run?
Is this PR squashed?
Are author name / email address correct? Are co-authors correctly listed? Do the commit messages need updates?
Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?

If this PR targets the delivery branch: don't merge. (full wiki article)

lahodaj

Overall seems reasonable to me, with some suggestions for small cleanups inline.

lahodaj · 2025-12-15T08:28:02Z

java/java.editor/src/org/netbeans/modules/java/editor/imports/JavaFixAllImports.java

    /** Creates a new instance of JavaFixAllImports */
    private JavaFixAllImports() {
    }
-


Nit: revert this removal.

lahodaj · 2025-12-15T08:28:44Z

java/java.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/CodeActionsProvider.java

 */
 public abstract class CodeActionsProvider {
-
+    public static final String FIX_IMPORTS_KIND = "source.fixImports";


I suspect this should be moved to java/java.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/FixImportsCodeAction.java? (I think that's consistent with what is being done for other ordinary implementations of CodeActionsProviders.

Hmm , done !

lahodaj · 2025-12-15T08:29:35Z

....lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/OrganizeImportsCodeAction.java

 import org.eclipse.lsp4j.CodeActionKind;
 import org.eclipse.lsp4j.CodeActionParams;
 import org.eclipse.lsp4j.TextEdit;
 import org.eclipse.lsp4j.WorkspaceEdit;


The changes in this file do not seem to be necessary - these can be removed.

lahodaj

Overall, looks reasonable to me, with some comments for consideration. Thanks for doing this!

lahodaj · 2026-01-27T10:03:16Z

.../java.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/FixImportsCodeAction.java

+                        codeAction.setEdit(new WorkspaceEdit(Collections.singletonMap(uri, edits)));
+                    }
+                } catch (IOException ex) {
+                    Exceptions.printStackTrace(ex);


Not sure if this is intentional, but unless there's a good reason, I would simply let the exception be thrown from thenApply, which should complete the CompletableFuture exceptionally. E.g. throw new IllegalStateException(ex);. That way, the UI may have an opportunity to show a sensible error to the user.

lahodaj · 2026-01-27T10:03:55Z

.../java.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/FixImportsCodeAction.java

+                    }
+                } catch (IOException ex) {
+                    Exceptions.printStackTrace(ex);
+


Nit: I would suggest to delete this empty line. (I guess more generally, empty lines before closing braces, esp. inside methods.)

lahodaj · 2026-01-27T10:06:42Z

.../java.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/FixImportsCodeAction.java

+        @Function
+        void completeSelectedCandidates(FixImportsUI ui) {
+            List<ImportDataUI> imports = ui.getImports();
+            CandidateDescription[] choosen = IntStream.range(0, imports.size())


Nit: choosen -> chosen

lahodaj · 2026-01-27T10:07:18Z

.../java.lsp.server/src/org/netbeans/modules/java/lsp/server/protocol/FixImportsCodeAction.java

+        @Property(name = "simpleName", type = String.class),
+        @Property(name = "selectedCandidateFQN", type = String.class),
+        @Property(name = "candidatesFQN", type = String.class, array = true)
+


Nit: I would remove this empty line.

lahodaj · 2026-01-27T10:07:48Z

.../java.lsp.server/test/unit/src/org/netbeans/modules/java/lsp/server/protocol/ServerTest.java

+        src.getParentFile().mkdirs();
+        try (Writer w = new FileWriter(new File(src.getParentFile().getParentFile(), ".test-project"))) {
+        }
+        String code = "package a;\n"


Nit: java.lsp.server can use JDK 17 features now, could be replaced with text blocks, for better readability.

shivam71 · 2026-01-27T11:56:16Z

Thanks again @lahodaj !!
I have tried to address all the comments , please let me know if anything else is required .

mbien · 2026-01-27T18:30:25Z

CI found something, looks like a test doesn't compile anymore:

 [nb-javac] /home/runner/work/netbeans/netbeans/java/java.lsp.server/test/unit/src/org/netbeans/modules/java/lsp/server/protocol/ServerTest.java:3821: error: no suitable constructor found for WorkspaceFolder(String)
   [nb-javac]         initParams.setWorkspaceFolders(List.of(new WorkspaceFolder(getWorkDir().toURI().toString())));

shivam71 · 2026-01-28T11:28:29Z

Thanks @mbien !! , for pointing this one out . It was due to the upgrade of lsp4j where the old constructor was removed . Have fixed it now.

lahodaj

Looks OK to me, thanks!

lahodaj · 2026-02-02T08:34:09Z

I there are no objections, I'll merge later today or tomorrow.

lahodaj reviewed Dec 15, 2025

View reviewed changes

shivam71 force-pushed the cmd_fix_imports branch from fe4b915 to 322b794 Compare December 15, 2025 08:55

lahodaj reviewed Jan 27, 2026

View reviewed changes

shivam71 force-pushed the cmd_fix_imports branch from 322b794 to 750044c Compare January 27, 2026 11:53

mbien added Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) LSP [ci] enable Language Server Protocol tests labels Jan 27, 2026

apache locked and limited conversation to collaborators Jan 27, 2026

apache unlocked this conversation Jan 27, 2026

Added a new code action for fix imports cmd

1baf2f4

shivam71 force-pushed the cmd_fix_imports branch from 750044c to 1baf2f4 Compare January 28, 2026 11:26

mbien added this to the NB30 milestone Jan 28, 2026

lahodaj approved these changes Jan 29, 2026

View reviewed changes

lahodaj merged commit 2dc2800 into apache:master Feb 6, 2026
35 checks passed

Conversation

shivam71 commented Dec 3, 2025

Fix Imports Code action for LSP Client

PR approval and merge checklist:

Uh oh!

lahodaj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lahodaj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shivam71 commented Jan 27, 2026

Uh oh!

mbien commented Jan 27, 2026

Uh oh!

shivam71 commented Jan 28, 2026

Uh oh!

lahodaj left a comment

Choose a reason for hiding this comment

Uh oh!

lahodaj commented Feb 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants