Add the ability to manually format Javascript code

This change allows the user to format code within the code editor areas.
The user can format the currently selected lines or the entire document.
A default hotkey of ctrl+shift+F has been added to run this action, but
it may be changed by the user. Additionally, this action can be
performed in the right-click context menu by selecting "Code->Format"
Signed-off-by: Tony Germano <tony@germano.name>
Original-sign-off: 132de74
Issue: #87

Author: sbraconnier

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

@@ -62,6 +62,7 @@
 importcom.mirth.connect.client.ui.components.rsta.actions.ExpandFoldAction;
 importcom.mirth.connect.client.ui.components.rsta.actions.FindNextAction;
 importcom.mirth.connect.client.ui.components.rsta.actions.FindReplaceAction;
+importcom.mirth.connect.client.ui.components.rsta.actions.FormatCodeAction;
 importcom.mirth.connect.client.ui.components.rsta.actions.GoToMatchingBracketAction;
 importcom.mirth.connect.client.ui.components.rsta.actions.HorizontalPageAction;
 importcom.mirth.connect.client.ui.components.rsta.actions.InsertBreakAction;
@@ -127,6 +128,8 @@ public class MirthRSyntaxTextArea extends RSyntaxTextArea implements MirthTextIn
 privateCustomJCheckBoxMenuItemshowWhitespaceMenuItem;
 privateCustomJCheckBoxMenuItemshowLineEndingsMenuItem;
 privateCustomJCheckBoxMenuItemwrapLinesMenuItem;
+privateJMenucodeMenu;
+privateCustomMenuItemformatCodeMenuItem;
 privateJMenumacroMenu;
 privateCustomMenuItembeginMacroMenuItem;
 privateCustomMenuItemendMacroMenuItem;
@@ -228,6 +231,8 @@ public void keyPressed(KeyEvent e) {
 showWhitespaceMenuItem = newCustomJCheckBoxMenuItem(this, newShowWhitespaceAction(this), ActionInfo.DISPLAY_SHOW_WHITESPACE);
 showLineEndingsMenuItem = newCustomJCheckBoxMenuItem(this, newShowLineEndingsAction(this), ActionInfo.DISPLAY_SHOW_LINE_ENDINGS);
 wrapLinesMenuItem = newCustomJCheckBoxMenuItem(this, newWrapLinesAction(this), ActionInfo.DISPLAY_WRAP_LINES);
+codeMenu = newJMenu("Code");
+formatCodeMenuItem = newCustomMenuItem(this, newFormatCodeAction(this), ActionInfo.FORMAT_CODE);
 macroMenu = newJMenu("Macro");
 beginMacroMenuItem = newCustomMenuItem(this, newBeginMacroAction(), ActionInfo.MACRO_BEGIN);
 endMacroMenuItem = newCustomMenuItem(this, newEndMacroAction(), ActionInfo.MACRO_END);
@@ -239,6 +244,7 @@ public void keyPressed(KeyEvent e) {
 getActionMap().put(ActionInfo.DELETE_LINE.getActionMapKey(), newDeleteLineAction());
 getActionMap().put(ActionInfo.JOIN_LINE.getActionMapKey(), newJoinLineAction());
 getActionMap().put(ActionInfo.GO_TO_MATCHING_BRACKET.getActionMapKey(), newGoToMatchingBracketAction());
+getActionMap().put(ActionInfo.FORMAT_CODE.getActionMapKey(), newFormatCodeAction(this));
 getActionMap().put(ActionInfo.TOGGLE_COMMENT.getActionMapKey(), newToggleCommentAction());
 getActionMap().put(ActionInfo.DOCUMENT_START.getActionMapKey(), newDocumentStartAction(false));
 getActionMap().put(ActionInfo.DOCUMENT_SELECT_START.getActionMapKey(), newDocumentStartAction(true));
@@ -489,6 +495,10 @@ protected JPopupMenu createPopupMenu() {
 menu.add(displayMenu);
 menu.addSeparator();
 
+codeMenu.add(formatCodeMenuItem);
+menu.add(codeMenu);
+menu.addSeparator();
+
 macroMenu.add(beginMacroMenuItem);
 macroMenu.add(endMacroMenuItem);
 macroMenu.add(playbackMacroMenuItem);
@@ -514,6 +524,7 @@ 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());
 beginMacroMenuItem.setEnabled(!isRecordingMacro());
 endMacroMenuItem.setEnabled(isRecordingMacro());
 playbackMacroMenuItem.setEnabled(!isRecordingMacro() && getCurrentMacro() != null);
@@ -533,6 +544,7 @@ protected void configurePopupMenu(JPopupMenu popupMenu) {
 collapseAllFoldsMenuItem.updateAccelerator();
 collapseAllCommentFoldsMenuItem.updateAccelerator();
 expandAllFoldsMenuItem.updateAccelerator();
+formatCodeMenuItem.updateAccelerator();
 beginMacroMenuItem.updateAccelerator();
 endMacroMenuItem.updateAccelerator();
 playbackMacroMenuItem.updateAccelerator();
@@ -550,4 +562,4 @@ public void setSyntaxEditingStyle(String styleKey) {
 publicAction[] getActions() {
 returnactions != 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>
+
+packagecom.mirth.connect.client.ui.components.rsta.actions;
+
+importjava.awt.event.ActionEvent;
+
+importjavax.swing.UIManager;
+importjavax.swing.text.BadLocationException;
+importjavax.swing.text.Caret;
+importjavax.swing.text.Element;
+
+importorg.fife.ui.rsyntaxtextarea.RSyntaxDocument;
+
+importcom.mirth.connect.client.ui.components.rsta.MirthRSyntaxTextArea;
+importcom.mirth.connect.util.JavaScriptSharedUtil;
+
+publicclassFormatCodeActionextendsMirthRecordableTextAction {
+
+publicFormatCodeAction(MirthRSyntaxTextAreatextArea) {
+super(textArea, ActionInfo.FORMAT_CODE);
+ }
+
+@Override
+publicvoidactionPerformedImpl(ActionEventevt) {
+
+if (!textArea.isEditable() || !textArea.isEnabled()) {
+UIManager.getLookAndFeel().provideErrorFeedback(textArea);
+return;
+ }
+
+Caretc = textArea.getCaret();
+intstart = Math.min(c.getDot(), c.getMark());
+intend = Math.max(c.getDot(), c.getMark());
+if (start == end) {
+formatAll();
+ } else {
+formatRange(start, end);
+ }
+
+ }
+
+@Override
+publicbooleanisEnabled() {
+returntextArea.isEditable() && textArea.isEnabled();
+ }
+
+privatevoidformatAll() {
+
+Stringcode = textArea.getText();
+formatAndReplace(code, 0, code.length());
+ }
+
+privatevoidformatRange(intstart, intend) {
+
+// We want to format all the lines of the selection (not only the selected text)
+
+try {
+RSyntaxDocumentdoc = (RSyntaxDocument) textArea.getDocument();
+Elementmap = doc.getDefaultRootElement();
+
+// Get the lines indexes from the selected text indexes.
+intstartLine = map.getElementIndex(start);
+intendLine = map.getElementIndex(end);
+
+intreplaceRangeStart = 0;
+intreplaceRangeEnd = 0;
+
+// Build a string from the selected lines.
+StringBuildersb = newStringBuilder();
+for (intline = startLine; line <= endLine; line++) {
+Elementelem = map.getElement(line);
+
+intstartOffset = elem.getStartOffset();
+intendOffset = 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 (BadLocationExceptionble) {
+ble.printStackTrace();
+UIManager.getLookAndFeel().provideErrorFeedback(textArea);
+ }
+ }
+
+privatevoidformatAndReplace(Stringcode, intstart, intend) {
+
+StringformattedCode = JavaScriptSharedUtil.prettyPrint(code);
+textArea.replaceRange(formattedCode, start, end);
+textArea.setCaretPosition(start);
+ }
+}

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

@@ -198,12 +198,12 @@ private static ScriptableObject getFormatterScope() {
 InputStreamis = null;
 
 try {
-is = JavaScriptSharedUtil.class.getResourceAsStream("beautify-1.6.8.js");
+is = JavaScriptSharedUtil.class.getResourceAsStream("beautify-1.15.3.js");
 Stringscript = IOUtils.toString(is);
 ScriptableObjectscope = 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);
 returnscope;
  } catch (Exceptione) {
 logger.error("Failed to load beautify library.");