feat: Language server config UX improvements #645

SCWells72 · 2024-11-29T18:25:50Z

This is not yet intended for merge but rather for early feedback. It currently includes the following changes:

The JSON text fields for the language server config and init options are now JSON editor text fields. They do not yet specify any type of JSON schema for completion/validation, but they do provide a proper editor experience for JSON files including grammar-based validation, syntax highlighting, formatting, etc.
Fixed several issues with the layouts of the tabbed settings editor so that things fill the available vertical space properly.
When a row is added to any of the language server mappings tables, the first cell in the new row is immediately selected and the table is given focus. The user only needs to press F2 to set the value for that cell (or start typing in the case of a text field-based cell editor). I could instead start editing immediately, but that seemed a bit intrusive for the file type combo-box cell editors.

Feel free to provide any feedback on these changes before I move into a next phase that would include:

Making the Configuration tab include sub-tabs for server-side (i.e., existing) config and client-side config.
Trying to add some level of support for JSON schema-based validation/completion for the JSON config editors.

…ppings tables.

…lds are now JSON editor text fields. I also fixed some layout issues that were keeping those text fields from stretching vertically to fill the available space.

SCWells72 · 2024-11-29T18:27:07Z

src/main/java/com/redhat/devtools/lsp4ij/settings/LanguageServerView.java

@@ -287,9 +287,7 @@ private JPanel createSettings(JComponent description, boolean launchingServerDef
                launchingServerDefinition ? LanguageServerPanel.EditionMode.EDIT_USER_DEFINED :
                        LanguageServerPanel.EditionMode.EDIT_EXTENSION, project);
        this.mappingPanel = languageServerPanel.getMappingsPanel();
-        return builder
-                .addComponentFillVertically(new JPanel(), 50)


I'm not sure why this was added originally, but it was resulting in a significant unusable "padding" in the bottom half (or so) of all tabbed editors. I don't see any negative side-effects of removing it, and it allows the two JSON text editors to expand vertically to fill the available space in the Configuration tab.

@SCWells72 this panel is also used in the standard préférences of IJ with Language Servers entre.

If remember I did that to have a correct UI in this preference.

Please check that.

Yep, it all looks fine there as well:

SCWells72 · 2024-11-29T18:27:37Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/AbstractServerMappingTablePanel.java

@@ -44,6 +44,7 @@ public AbstractServerMappingTablePanel(ColumnInfo<ServerMappingSettings, String>
                new ArrayList<>(),
                0);
        table = new TableView<>(model);
+        table.setColumnSelectionAllowed(true);


Provides a better experience (IMO) when selecting a specific cell for editing after adding a new row.

SCWells72 · 2024-11-29T18:28:26Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/AbstractServerMappingTablePanel.java

+            // Immediately select the first cell in the new row
+            ApplicationManager.getApplication().invokeLater(() -> {
+                int newRowIndex = table.getRowCount() - 1;
+                table.getSelectionModel().setSelectionInterval(newRowIndex, newRowIndex);


As mentioned in the PR itself, this could instead just start editing the first cell in the new row. I tried that and felt like it was a little too aggressive, but I'm open to other opinions, of course.

SCWells72 · 2024-11-29T18:28:46Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/AbstractServerMappingTablePanel.java

-                table.getListTableModel().removeRow(table.getSelectedRow());
-                fireStateChanged();
-            }
+        return anActionButton -> {


This was just changing an anonymous inner class into a lambda.

SCWells72 · 2024-11-29T18:30:04Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/JsonTextField.java

+
+    public JsonTextField(@NotNull Project project) {
+        // Create and initialize the editor text field
+        EditorTextFieldProvider service = ApplicationManager.getApplication().getService(EditorTextFieldProvider.class);


I tried just having this be a LanguageTextField, but it wasn't behaving properly at all. I remember having to "wrap" one created by EditorTextFieldProvider in this manner in my own plugin to get the desired results, and it does so here as well.

No skills about that. I trust you.

SCWells72 · 2024-11-29T18:30:19Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/JsonTextField.java

+        ));
+        Language jsonLanguage = Language.findLanguageByID(JSON_LANGUAGE_NAME);
+        if (jsonLanguage == null) {
+            jsonLanguage = PlainTextFileType.INSTANCE.getLanguage();


This should never happen, but being defensive.

It can happen if Jetbrains product (perhaps CLion?) have no JSON plugin. So it is very good to do that.

LSP4IJ should not have s tron dependency to JSON plugin. If you need to add JSON dependency (ex: when you will add JSON Shcme support) it should be done as optional.

From what I understand having discussed this in the intellij-platform Slack channel with the JetBrains folks recently, it should be safe to assume that JSON is always available even though it's broken out into a separate plugin now. It's more a logical separation for JetBrains than a phyiscal one at runtime. They're even fixing an issue in the plugin verifier where it doesn't currently "find" the JSON plugin in 2024.3. So the check I've added is defensive, but it should never happen.

SCWells72 · 2024-11-29T18:30:50Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/JsonTextField.java

+        add(editorTextField, BorderLayout.CENTER);
+    }
+
+    // Proxy some simple accessors to the editor text field


These provide the same API as the previous JBTextField for existing callers.

SCWells72 · 2024-11-29T18:31:53Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/LanguageServerConfigurationWidget.java

-        super.setWrapStyleWord(true);
-        super.setFont(JBFont.regular());
-        super.getEmptyText().setText(LanguageServerBundle.message("language.server.configuration.emptyText"));
+public class LanguageServerConfigurationWidget extends JsonTextField {


Technically these could be removed and JsonTextField could be used directly. However, I was thinking that they might diverge slightly when we start adding support for JSON schema validation and such. Might make sense to keep them distinct until we know whether that still makes sense or not when other features are added.

SCWells72 · 2024-11-29T18:32:30Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/LanguageServerPanel.java

@@ -79,7 +79,7 @@ public LanguageServerPanel(FormBuilder builder, JComponent description, EditionM

    private void createUI(FormBuilder builder, JComponent description, EditionMode mode) {
        JBTabbedPane tabbedPane = new JBTabbedPane();
-        builder.addComponent(tabbedPane);
+        builder.addComponentFillVertically(tabbedPane, 0);


It's important the the entire tabbed pane be allowed to stretch vertically to accommodate the contents of its tabs.

SCWells72 · 2024-11-29T18:32:58Z

src/main/java/com/redhat/devtools/lsp4ij/settings/ui/LanguageServerPanel.java

@@ -180,7 +180,7 @@ private static FormBuilder addTab(JBTabbedPane tabbedPane, String tabTitle, bool
        if (addToTop) {
            tabPanel.addToTop(builder.getPanel());
        } else {
-            tabPanel.add(builder.getPanel());
+            tabPanel.addToCenter(builder.getPanel());


This is actually behaviorally the same, but it made sense to me to be explicit since the panel is definitely for a BorderLayout.

angelozerr · 2024-11-29T18:40:31Z

Your PR looks amazing. Let me try it after the release and I will try to merge it asap in order to you can implement json schéma which will provide a fanatstic feature to customize language server.

For css we could create a json schéma by extracting the json schema which declares the css settings.

For typescript we will need to write that at hand.

Please note that css settings use dot , perhaps we will need to split the configuration with dot before sending to the language server.

…SON schema is determined.

SCWells72 · 2024-11-30T22:18:26Z

gradle.properties

@@ -13,7 +13,7 @@ platformType=IC
 platformVersion=2023.2
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
 # Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22
-platformPlugins=com.redhat.devtools.intellij.telemetry:1.2.1.62, textmate, properties
+platformPlugins=com.redhat.devtools.intellij.telemetry:1.2.1.62, textmate, properties, com.intellij.modules.json


Had to add a dependency on JSON, but it should be available in all JetBrains IDEs as I mentioned to you directly. I have the same type of dependency in my own commercial plugin, and I've already been reassured by JetBrains that it's fine in spite of their recent move to a distinct JSON plugin.

angelozerr · 2024-11-30T22:40:09Z

.../lsp4ij/settings/jsonSchema/TypeScriptLanguageServerConfigurationJsonSchemaFileProvider.java

+/**
+ * JSON schema file provider for the TypeScript language server.
+ */
+class TypeScriptLanguageServerConfigurationJsonSchemaFileProvider extends LSP4IJJsonSchemaFileProvider {


This class should not exists. You should load schema by using the name settings.schema.json because the idea is to provide the capability to define a json schema with ui and export your language server to share it.

This reverts commit bee9597.

…orrect JSON schema is determined." This reverts commit a8cab00.

This reverts commit 6d86d98.

angelozerr · 2024-12-01T18:58:56Z

As it is working like a charm an code was very simple, I merge the PR. Thanks so much @SCWells72 !

SCWells72 added 2 commits November 29, 2024 12:16

Improved the behavior when adding a new row to the language server ma…

9354369

…ppings tables.

The language server configuration and initialization options text fie…

988d56e

…lds are now JSON editor text fields. I also fixed some layout issues that were keeping those text fields from stretching vertically to fill the available space.

SCWells72 commented Nov 29, 2024

View reviewed changes

SCWells72 and others added 4 commits November 30, 2024 08:38

Merge branch 'redhat-developer:main' into config_ux_improvements

560cdd3

First cut at adding JSON schema to the config UI.

6d86d98

This makes everything much more dynamic in terms of how the correct J…

a8cab00

…SON schema is determined.

Added JSON schema for CSS language server configuration.

bee9597

SCWells72 commented Nov 30, 2024

View reviewed changes

angelozerr reviewed Nov 30, 2024

View reviewed changes

SCWells72 added 3 commits December 1, 2024 08:46

Revert "Added JSON schema for CSS language server configuration."

287d8a8

This reverts commit bee9597.

Revert "This makes everything much more dynamic in terms of how the c…

41af819

…orrect JSON schema is determined." This reverts commit a8cab00.

Revert "First cut at adding JSON schema to the config UI."

07b81fe

This reverts commit 6d86d98.

angelozerr changed the title ~~Language server config UX improvements~~ feat: Language server config UX improvements Dec 1, 2024

angelozerr merged commit dfd27f9 into redhat-developer:main Dec 1, 2024
6 of 7 checks passed

angelozerr added the enhancement New feature or request label Dec 1, 2024

angelozerr added this to the 0.8.1 milestone Dec 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Language server config UX improvements #645

feat: Language server config UX improvements #645

SCWells72 commented Nov 29, 2024

SCWells72 Nov 29, 2024

angelozerr Nov 29, 2024

SCWells72 Nov 29, 2024

SCWells72 Nov 29, 2024

SCWells72 Nov 29, 2024

SCWells72 Nov 29, 2024

SCWells72 Nov 29, 2024

angelozerr Nov 29, 2024

SCWells72 Nov 29, 2024

angelozerr Nov 30, 2024

SCWells72 Nov 30, 2024

SCWells72 Nov 29, 2024

SCWells72 Nov 29, 2024

SCWells72 Nov 29, 2024

SCWells72 Nov 29, 2024

angelozerr commented Nov 29, 2024

SCWells72 Nov 30, 2024

angelozerr Nov 30, 2024

angelozerr commented Dec 1, 2024

feat: Language server config UX improvements #645

feat: Language server config UX improvements #645

Conversation

SCWells72 commented Nov 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

angelozerr commented Nov 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

angelozerr commented Dec 1, 2024