Add the ability to manually format Javascript code (#87)

client/src/com/mirth/connect/client/ui/components/rsta/MirthRSyntaxTextArea.java

@@ -62,6 +62,7 @@
 import com.mirth.connect.client.ui.components.rsta.actions.ExpandFoldAction;
 import com.mirth.connect.client.ui.components.rsta.actions.FindNextAction;
 import com.mirth.connect.client.ui.components.rsta.actions.FindReplaceAction;
+import com.mirth.connect.client.ui.components.rsta.actions.FormatCodeAction;
 import com.mirth.connect.client.ui.components.rsta.actions.GoToMatchingBracketAction;
 import com.mirth.connect.client.ui.components.rsta.actions.HorizontalPageAction;
 import com.mirth.connect.client.ui.components.rsta.actions.InsertBreakAction;
@@ -127,6 +128,9 @@ public class MirthRSyntaxTextArea extends RSyntaxTextArea implements MirthTextIn
     private CustomJCheckBoxMenuItem showWhitespaceMenuItem;
     private CustomJCheckBoxMenuItem showLineEndingsMenuItem;
     private CustomJCheckBoxMenuItem wrapLinesMenuItem;
+    private JMenu codeMenu;
+    private CustomMenuItem formatCodeMenuItem;
+    private CustomMenuItem toggleCommentMenuItem;
     private JMenu macroMenu;
     private CustomMenuItem beginMacroMenuItem;
     private CustomMenuItem endMacroMenuItem;
@@ -228,6 +232,9 @@ public void keyPressed(KeyEvent e) {
         showWhitespaceMenuItem = new CustomJCheckBoxMenuItem(this, new ShowWhitespaceAction(this), ActionInfo.DISPLAY_SHOW_WHITESPACE);
         showLineEndingsMenuItem = new CustomJCheckBoxMenuItem(this, new ShowLineEndingsAction(this), ActionInfo.DISPLAY_SHOW_LINE_ENDINGS);
         wrapLinesMenuItem = new CustomJCheckBoxMenuItem(this, new WrapLinesAction(this), ActionInfo.DISPLAY_WRAP_LINES);
+        codeMenu = new JMenu("Code");
+        formatCodeMenuItem = new CustomMenuItem(this, new FormatCodeAction(this), ActionInfo.FORMAT_CODE);
+        toggleCommentMenuItem = new CustomMenuItem(this, new ToggleCommentAction(this), ActionInfo.TOGGLE_COMMENT);
         macroMenu = new JMenu("Macro");
         beginMacroMenuItem = new CustomMenuItem(this, new BeginMacroAction(), ActionInfo.MACRO_BEGIN);
         endMacroMenuItem = new CustomMenuItem(this, new EndMacroAction(), ActionInfo.MACRO_END);
@@ -239,7 +246,8 @@ public void keyPressed(KeyEvent e) {
         getActionMap().put(ActionInfo.DELETE_LINE.getActionMapKey(), new DeleteLineAction());
         getActionMap().put(ActionInfo.JOIN_LINE.getActionMapKey(), new JoinLineAction());
         getActionMap().put(ActionInfo.GO_TO_MATCHING_BRACKET.getActionMapKey(), new GoToMatchingBracketAction());
-        getActionMap().put(ActionInfo.TOGGLE_COMMENT.getActionMapKey(), new ToggleCommentAction());
+        getActionMap().put(ActionInfo.FORMAT_CODE.getActionMapKey(), new FormatCodeAction(this));
+        getActionMap().put(ActionInfo.TOGGLE_COMMENT.getActionMapKey(), new ToggleCommentAction(this));
         getActionMap().put(ActionInfo.DOCUMENT_START.getActionMapKey(), new DocumentStartAction(false));
         getActionMap().put(ActionInfo.DOCUMENT_SELECT_START.getActionMapKey(), new DocumentStartAction(true));
         getActionMap().put(ActionInfo.DOCUMENT_END.getActionMapKey(), new DocumentEndAction(false));
@@ -489,6 +497,11 @@ protected JPopupMenu createPopupMenu() {
         menu.add(displayMenu);
         menu.addSeparator();
 
+        codeMenu.add(formatCodeMenuItem);
+        codeMenu.add(toggleCommentMenuItem);
+        menu.add(codeMenu);
+        menu.addSeparator();
+
         macroMenu.add(beginMacroMenuItem);
         macroMenu.add(endMacroMenuItem);
         macroMenu.add(playbackMacroMenuItem);
@@ -514,6 +527,8 @@ protected void configurePopupMenu(JPopupMenu popupMenu) {
             findNextMenuItem.setEnabled(findNextMenuItem.getAction().isEnabled() && CollectionUtils.isNotEmpty(rstaPreferences.getFindReplaceProperties().getFindHistory()));
             clearMarkedOccurrencesMenuItem.setEnabled(clearMarkedOccurrencesMenuItem.getAction().isEnabled() && canType && ((RSyntaxTextAreaHighlighter) getHighlighter()).getMarkAllHighlightCount() > 0);
             foldingMenu.setEnabled(getFoldManager().isCodeFoldingSupportedAndEnabled());
+            formatCodeMenuItem.setEnabled(formatCodeMenuItem.getAction().isEnabled());
+            toggleCommentMenuItem.setEnabled(toggleCommentMenuItem.getAction().isEnabled());
             beginMacroMenuItem.setEnabled(!isRecordingMacro());
             endMacroMenuItem.setEnabled(isRecordingMacro());
             playbackMacroMenuItem.setEnabled(!isRecordingMacro() && getCurrentMacro() != null);
@@ -533,6 +548,8 @@ protected void configurePopupMenu(JPopupMenu popupMenu) {
             collapseAllFoldsMenuItem.updateAccelerator();
             collapseAllCommentFoldsMenuItem.updateAccelerator();
             expandAllFoldsMenuItem.updateAccelerator();
+            formatCodeMenuItem.updateAccelerator();
+            toggleCommentMenuItem.updateAccelerator();
             beginMacroMenuItem.updateAccelerator();
             endMacroMenuItem.updateAccelerator();
             playbackMacroMenuItem.updateAccelerator();
@@ -550,4 +567,4 @@ public void setSyntaxEditingStyle(String styleKey) {
     public Action[] getActions() {
         return actions != null ? actions : getUI().getEditorKit(this).getActions();
     }
-}
+}

client/src/com/mirth/connect/client/ui/components/rsta/MirthRSyntaxTextArea.properties

@@ -118,6 +118,11 @@ TOGGLE_COMMENT.Name=Toggle Comment
 TOGGLE_COMMENT.Desc=Comments / uncomments the current selected line(s).
 TOGGLE_COMMENT.Toggle=false
 
+FORMAT_CODE.Mnemonic=F
+FORMAT_CODE.Name=Format
+FORMAT_CODE.Desc=Format the current script / selected line(s).
+FORMAT_CODE.Toggle=false
+
 VIEW_USER_API.Mnemonic=V
 VIEW_USER_API.Name=View User API
 VIEW_USER_API.Desc=Opens up the User API Javadoc in a browser.

client/src/com/mirth/connect/client/ui/components/rsta/RSTAPreferences.java

@@ -234,6 +234,7 @@ private void setDefaultKeyStrokeMap() {
         putKeyStroke(ActionInfo.FOLD_EXPAND_ALL, KeyEvent.VK_MULTIPLY, defaultModifier);
         putKeyStroke(ActionInfo.GO_TO_MATCHING_BRACKET, KeyEvent.VK_OPEN_BRACKET, defaultModifier);
         putKeyStroke(ActionInfo.TOGGLE_COMMENT, KeyEvent.VK_SLASH, defaultModifier);
+        putKeyStroke(ActionInfo.FORMAT_CODE, KeyEvent.VK_F, ctrl + shift);
         putKeyStroke(ActionInfo.AUTO_COMPLETE, KeyEvent.VK_SPACE, ctrl);
 
         if (isOSX) {

client/src/com/mirth/connect/client/ui/components/rsta/actions/ActionInfo.java

@@ -40,6 +40,7 @@ public enum ActionInfo {
     DISPLAY_WRAP_LINES          ("mirth-wrap-lines"),
     GO_TO_MATCHING_BRACKET      (RSyntaxTextAreaEditorKit.rstaGoToMatchingBracketAction),
     TOGGLE_COMMENT              (RSyntaxTextAreaEditorKit.rstaToggleCommentAction),
+    FORMAT_CODE                 ("mirth-format-code"),
     VIEW_USER_API               ("mirth-view-user-api"),
     AUTO_COMPLETE               ("AutoComplete"),
     DOCUMENT_START              (DefaultEditorKit.beginAction),

client/src/com/mirth/connect/client/ui/components/rsta/actions/FormatCodeAction.java

@@ -0,0 +1,105 @@
+// SPDX-License-Identifier: MPL-2.0
+// SPDX-FileCopyrightText: 2025 Simon Braconnier <simonbraconnier@gmail.com>
+
+package com.mirth.connect.client.ui.components.rsta.actions;
+
+import java.awt.event.ActionEvent;
+
+import javax.swing.UIManager;
+import javax.swing.text.BadLocationException;
+import javax.swing.text.Caret;
+import javax.swing.text.Element;
+
+import org.fife.ui.rsyntaxtextarea.RSyntaxDocument;
+
+import com.mirth.connect.client.ui.components.rsta.MirthRSyntaxTextArea;
+import com.mirth.connect.util.JavaScriptSharedUtil;
+
+public class FormatCodeAction extends MirthRecordableTextAction {
+
+    public FormatCodeAction(MirthRSyntaxTextArea textArea) {
+        super(textArea, ActionInfo.FORMAT_CODE);
+    }
+
+    @Override
+    public void actionPerformedImpl(ActionEvent evt) {
+
+        if (!textArea.isEditable() || !textArea.isEnabled()) {
+            UIManager.getLookAndFeel().provideErrorFeedback(textArea);
+            return;
+        }
+
+        Caret c = textArea.getCaret();
+        int start = Math.min(c.getDot(), c.getMark());
+        int end = Math.max(c.getDot(), c.getMark());
+        if (start == end) {
+            formatAll();
+        } else {
+            formatRange(start, end);
+        }
+
+    }
+
+    @Override
+    public boolean isEnabled() {
+        return textArea.isEditable() && textArea.isEnabled();
+    }
+
+    private void formatAll() {
+
+        String code = textArea.getText();
+        formatAndReplace(code, 0, code.length());
+    }
+
+    private void formatRange(int start, int end) {
+
+        // We want to format all the lines of the selection (not only the selected text)
+
+        try {
+            RSyntaxDocument doc = (RSyntaxDocument) textArea.getDocument();
+            Element map = doc.getDefaultRootElement();
+
+            // Get the lines indexes from the selected text indexes.
+            int startLine = map.getElementIndex(start);
+            int endLine = map.getElementIndex(end);
+
+            int replaceRangeStart = 0;
+            int replaceRangeEnd = 0;
+
+            // Build a string from the selected lines.
+            StringBuilder sb = new StringBuilder();
+            for (int line = startLine; line <= endLine; line++) {
+                Element elem = map.getElement(line);
+
+                int startOffset = elem.getStartOffset();
+                int endOffset = elem.getEndOffset() - 1;
+
+                // Save the start index of the first line for the final replacement.
+                if (line == startLine) {
+                    replaceRangeStart = startOffset;
+                }
+
+                // Save the end index of the last line for the final replacement.
+                if (line == endLine) {
+                    replaceRangeEnd = endOffset;
+                }
+
+                sb.append(doc.getText(startOffset, endOffset - startOffset + 1));
+            }
+
+            // Format the code and replace the selected lines.
+            formatAndReplace(sb.toString(), replaceRangeStart, replaceRangeEnd);
+
+        } catch (BadLocationException ble) {
+            ble.printStackTrace();
+            UIManager.getLookAndFeel().provideErrorFeedback(textArea);
+        }
+    }
+
+    private void formatAndReplace(String code, int start, int end) {
+
+        String formattedCode = JavaScriptSharedUtil.prettyPrint(code);
+        textArea.replaceRange(formattedCode, start, end);
+        textArea.setCaretPosition(start);
+    }
+}

client/src/com/mirth/connect/client/ui/components/rsta/actions/ToggleCommentAction.java

@@ -13,7 +13,16 @@
 
 public class ToggleCommentAction extends org.fife.ui.rsyntaxtextarea.RSyntaxTextAreaEditorKit.ToggleCommentAction {
 
-    public ToggleCommentAction() {
+    protected MirthRSyntaxTextArea textArea;
+
+    public ToggleCommentAction(MirthRSyntaxTextArea textArea) {
         setProperties(MirthRSyntaxTextArea.getResourceBundle(), ActionInfo.TOGGLE_COMMENT.toString());
+
+        this.textArea = textArea;
+    }
+
+    @Override
+    public boolean isEnabled() {
+        return textArea.isEditable() && textArea.isEnabled();
     }
 }

server/src/com/mirth/connect/util/JavaScriptSharedUtil.java

@@ -198,12 +198,12 @@ private static ScriptableObject getFormatterScope() {
         InputStream is = null;
 
         try {
-            is = JavaScriptSharedUtil.class.getResourceAsStream("beautify-1.6.8.js");
+            is = JavaScriptSharedUtil.class.getResourceAsStream("beautify-1.15.3.js");
             String script = IOUtils.toString(is);
             ScriptableObject scope = context.initStandardObjects();
             context.evaluateString(scope, "var global = {};", UUID.randomUUID().toString(), 1, null);
             context.evaluateString(scope, script, UUID.randomUUID().toString(), 1, null);
-            context.evaluateString(scope, "var opts = { 'e4x': true };", UUID.randomUUID().toString(), 1, null);
+            context.evaluateString(scope, "var opts = { 'e4x': true, 'indent_with_tabs': true };", UUID.randomUUID().toString(), 1, null);
             return scope;
         } catch (Exception e) {
             logger.error("Failed to load beautify library.");