feat: add fix all problems button for eslint/other problems

Author: abose

src/editor/Editor.js

@@ -1474,6 +1474,18 @@ define(function (require, exports, module) {
         this._codeMirror.replaceSelection(replacement, select);
     };
 
+    /**
+     * Replaces the content of multiple selections with the strings in the array. The length of the given
+     * array should be the same as the number of active selections.
+     * @param {Array<string>} replacement the text array to replace the current selections with
+     * @param {string} [select] The optional select argument can be used to change selection. Passing "around"
+     * will cause the new text to be selected, passing "start" will collapse the selection to the start
+     * of the inserted text.
+     */
+    Editor.prototype.replaceSelections = function (replacement, select) {
+        this._codeMirror.replaceSelections(replacement, select);
+    };
+
     /**
      * Replace the part of the document between from and to with the given string.
      * @param {string} replacement the text to replace the current selection
@@ -1488,6 +1500,40 @@ define(function (require, exports, module) {
         this._codeMirror.replaceRange(replacement, from, to, origin);
     };
 
+
+    /**
+     * Replaces multiple ranges in the editor with the specified texts.
+     *
+     * @method
+     * @param {Array} ranges - An array of range objects, each containing `from`, `to`, and `text` properties.
+     * @param {Object} ranges[].from - The start position of the range to be replaced. It should have `line` and `ch` properties.
+     * @param {Object} ranges[].to - The end position of the range to be replaced. It should have `line` and `ch` properties.
+     * @param {string} ranges[].text - The text to replace the specified range.
+     * @param {string} [origin] - An optional origin identifier to be associated with the changes.
+     * @example
+     * editor.replaceMultipleRanges([
+     *   { from: { line: 0, ch: 0 }, to: { line: 0, ch: 5 }, text: 'Hello' },
+     *   { from: { line: 1, ch: 0 }, to: { line: 1, ch: 4 }, text: 'World' }
+     * ], 'exampleOrigin');
+     */
+    Editor.prototype.replaceMultipleRanges = function (ranges, origin) {
+        // Sort ranges in descending order by start position so that they dont step over each other
+        let self = this;
+        self.operation(()=>{
+            ranges.sort((a, b) => {
+                if (a.from.line === b.from.line) {
+                    return b.from.ch - a.from.ch;
+                }
+                return b.from.line - a.from.line;
+            });
+
+            // Replace each range with its corresponding replacement text
+            ranges.forEach(range => {
+                self.replaceRange(range.text, range.from, range.to, origin);
+            });
+        });
+    };
+
     /**
      * Clears any active selection if present.
      */

src/htmlContent/problems-panel.html

@@ -1,5 +1,6 @@
 <div id="problems-panel" class="bottom-panel vert-resizable top-resizer">
     <div class="toolbar simple-toolbar-layout">
+        <button class="btn btn-mini primary problems-fix-all-btn forced-hidden" style="margin-right: 10px;">Fix All</button>
         <div class="title"><!-- filled in programmatically --></div>
         <a href="#" class="close">&times;</a>
     </div>

src/language/CodeInspection.js

@@ -119,6 +119,8 @@ define(function (require, exports, module) {
      */
     var $problemsPanel;
 
+    let $fixAllBtn;
+
     /**
      * @private the panelView
      * @type {Panel}
@@ -350,6 +352,7 @@ define(function (require, exports, module) {
      * @param fileName
      */
     function updatePanelTitleAndStatusBar(numProblems, providersReportingProblems, aborted, fileName) {
+        $fixAllBtn.addClass("forced-hidden");
         var message, tooltip;
 
         if (providersReportingProblems.length === 1) {
@@ -358,14 +361,20 @@ define(function (require, exports, module) {
             $problemsPanelTable.find("tr").removeClass("forced-hidden");
 
             if (numProblems === 1 && !aborted) {
-                message = StringUtils.format(Strings.SINGLE_ERROR, providersReportingProblems[0].name, fileName);
+                message = documentFixes.size ?
+                    StringUtils.format(Strings.SINGLE_ERROR_FIXABLE, providersReportingProblems[0].name,
+                        documentFixes.size, fileName):
+                    StringUtils.format(Strings.SINGLE_ERROR, providersReportingProblems[0].name, fileName);
             } else {
                 if (aborted) {
                     numProblems += "+";
                 }
 
-                message = StringUtils.format(Strings.MULTIPLE_ERRORS, providersReportingProblems[0].name, numProblems,
-                    fileName);
+                message = documentFixes.size ?
+                    StringUtils.format(Strings.MULTIPLE_ERRORS_FIXABLE, numProblems,
+                        providersReportingProblems[0].name, documentFixes.size, fileName):
+                    StringUtils.format(Strings.MULTIPLE_ERRORS, numProblems,
+                        providersReportingProblems[0].name, fileName);
             }
         } else if (providersReportingProblems.length > 1) {
             $problemsPanelTable.find(".inspector-section").show();
@@ -374,7 +383,10 @@ define(function (require, exports, module) {
                 numProblems += "+";
             }
 
-            message = StringUtils.format(Strings.ERRORS_PANEL_TITLE_MULTIPLE, numProblems, fileName);
+            message = documentFixes.size ?
+                StringUtils.format(Strings.ERRORS_PANEL_TITLE_MULTIPLE_FIXABLE, numProblems,
+                    documentFixes.size, fileName):
+                StringUtils.format(Strings.ERRORS_PANEL_TITLE_MULTIPLE, numProblems, fileName);
         } else {
             return;
         }
@@ -386,6 +398,7 @@ define(function (require, exports, module) {
             tooltip = StringUtils.format(Strings.STATUSBAR_CODE_INSPECTION_TOOLTIP_WITH_FIX,
                 documentFixes.size, message);
             iconType =  "inspection-repair";
+            $fixAllBtn.removeClass("forced-hidden");
         }
 
         StatusBar.updateIndicator(INDICATOR_ID, true, iconType, tooltip);
@@ -1006,14 +1019,40 @@ define(function (require, exports, module) {
         MainViewManager.focusActivePane();
         run();
     }
-    
+
+    function _fixAllProblems() {
+        const editor = EditorManager.getCurrentFullEditor();
+        if(!editor || editor.document.lastChangeTimestamp !== lastDocumentScanTimeStamp) {
+            Dialogs.showErrorDialog(Strings.CANNOT_FIX_TITLE, Strings.CANNOT_FIX_MESSAGE);
+            return;
+        }
+        if(!documentFixes.size){
+            return;
+        }
+        const replacements = [];
+        for(let fixDetails of documentFixes.values()){
+            replacements.push({
+                from: editor.posFromIndex(fixDetails.rangeOffset.start),
+                to: editor.posFromIndex(fixDetails.rangeOffset.end),
+                text: fixDetails.replaceText
+            });
+        }
+        editor.replaceMultipleRanges(replacements, EDIT_ORIGIN_LINT_FIX);
+        const finalCursor = replacements[replacements.length - 1].from;
+        editor.setCursorPos(finalCursor.line, finalCursor.ch);
+        MainViewManager.focusActivePane();
+        run();
+    }
+
     // Initialize items dependent on HTML DOM
     AppInit.htmlReady(function () {
         Editor.registerGutter(CODE_INSPECTION_GUTTER, CODE_INSPECTION_GUTTER_PRIORITY);
         // Create bottom panel to list error details
         var panelHtml = Mustache.render(PanelTemplate, Strings);
         problemsPanel = WorkspaceManager.createBottomPanel("errors", $(panelHtml), 100);
         $problemsPanel = $("#problems-panel");
+        $fixAllBtn = $problemsPanel.find(".problems-fix-all-btn");
+        $fixAllBtn.click(_fixAllProblems);
 
         function checkSelectionInsideElement(range, element) {
             if(!range || range.endOffset === range.startOffset) {

src/nls/root/strings.js

@@ -412,8 +412,11 @@ define({
     // CodeInspection: errors/warnings
     "ERRORS_NO_FILE": "No File Open",
     "ERRORS_PANEL_TITLE_MULTIPLE": "{0} Problems - {1}",
+    "ERRORS_PANEL_TITLE_MULTIPLE_FIXABLE": "{0} Problems, {1} Fixable - {2}",
     "SINGLE_ERROR": "1 {0} Problem - {1}",
-    "MULTIPLE_ERRORS": "{1} {0} Problems - {2}",
+    "SINGLE_ERROR_FIXABLE": "1 {0} Problem, {1} Fixable - {2}",
+    "MULTIPLE_ERRORS": "{0} {1} Problems - {2}",
+    "MULTIPLE_ERRORS_FIXABLE": "{0} {1} Problems, {2} Fixable - {3}",
     "NO_ERRORS": "No {0} problems found - good job!",
     "NO_ERRORS_MULTIPLE_PROVIDER": "No problems found - good job!",
     "LINT_DISABLED": "Linting is disabled",