feat: jsx support in eslint

abose · abose · commit b5275d864106 · 2024-06-12T20:14:50.000+05:30
diff --git a/src/extensions/default/JSLint/ESLint.js b/src/extensions/default/JSLint/ESLint.js
@@ -142,6 +142,8 @@ define(function (require, exports, module) {
                 } else if(esLintResult.isError) {
                     esLintServiceFailed = true;
                     resolve({ errors: _getLintError(esLintResult.errorCode, esLintResult.errorMessage) });
+                } else if(esLintResult.isPathIgnored) {
+                    resolve({isIgnored: true});
                 } else {
                     esLintServiceFailed = false;
                     if(!esLintResult.result){
@@ -234,15 +236,18 @@ define(function (require, exports, module) {
         _reloadOptions();
     });
 
-    // Register for JS files
-    CodeInspection.register("javascript", {
+    const esLintProvider = {
         name: Strings.ESLINT_NAME,
         scanFileAsync: lintOneFile,
         canInspect: function (fullPath) {
             return !prefs.get(PREFS_ESLINT_DISABLED) && fullPath && !fullPath.endsWith(".min.js")
                 && useESLintFromProject;
         }
-    });
+    };
+
+    // Register for JS files
+    CodeInspection.register("javascript", esLintProvider);
+    CodeInspection.register("jsx", esLintProvider);
 
     function isESLintActive() {
         return useESLintFromProject && Phoenix.isNativeApp && !esLintServiceFailed;
diff --git a/src/language/CodeInspection.js b/src/language/CodeInspection.js
@@ -643,6 +643,25 @@ define(function (require, exports, module) {
 
     const scrollPositionMap = new Map();
 
+    function _noProviderReturnedResults(currentDoc, fullFilePath) {
+        // No provider for current file
+        _hasErrors = false;
+        _currentPromise = null;
+        updatePanelTitleAndStatusBar(0, [], false,
+            fullFilePath ? path.basename(fullFilePath) : Strings.ERRORS_NO_FILE);
+        if(problemsPanel){
+            problemsPanel.hide();
+        }
+        const language = currentDoc && LanguageManager.getLanguageForPath(currentDoc.file.fullPath);
+        if (language) {
+            StatusBar.updateIndicator(INDICATOR_ID, true, "inspection-disabled",
+                StringUtils.format(Strings.NO_LINT_AVAILABLE, language.getName()));
+        } else {
+            StatusBar.updateIndicator(INDICATOR_ID, true, "inspection-disabled", Strings.NOTHING_TO_LINT);
+        }
+        setGotoEnabled(false);
+    }
+
     /**
      * Run inspector applicable to current document. Updates status bar indicator and refreshes error list in
      * bottom panel. Does not run if inspection is disabled or if a providerName is given and does not
@@ -687,6 +706,14 @@ define(function (require, exports, module) {
 
             // run all the providers registered for this file type
             (_currentPromise = inspectFile(currentDoc.file, providerList)).then(function (results) {
+                // filter out any ignored results
+                results = results.filter(function (providerResult) {
+                    return !providerResult.result || !providerResult.result.isIgnored;
+                });
+                if(!results.length) {
+                    _noProviderReturnedResults(currentDoc, fullFilePath);
+                    return;
+                }
                 editor.clearAllMarks(CODE_MARK_TYPE_INSPECTOR);
                 editor.clearGutter(CODE_INSPECTION_GUTTER);
                 _updateEditorMarksAndFixResults(results);
@@ -780,56 +807,73 @@ define(function (require, exports, module) {
             });
 
         } else {
-            // No provider for current file
-            _hasErrors = false;
-            _currentPromise = null;
-            updatePanelTitleAndStatusBar(0, [], false,
-                fullFilePath ? path.basename(fullFilePath) : Strings.ERRORS_NO_FILE);
-            if(problemsPanel){
-                problemsPanel.hide();
-            }
-            var language = currentDoc && LanguageManager.getLanguageForPath(currentDoc.file.fullPath);
-            if (language) {
-                StatusBar.updateIndicator(INDICATOR_ID, true, "inspection-disabled", StringUtils.format(Strings.NO_LINT_AVAILABLE, language.getName()));
-            } else {
-                StatusBar.updateIndicator(INDICATOR_ID, true, "inspection-disabled", Strings.NOTHING_TO_LINT);
-            }
-            setGotoEnabled(false);
+            _noProviderReturnedResults(currentDoc, fullFilePath);
         }
     }
 
     let gutterRegistrationInProgress = false;
 
     /**
-     * The provider is passed the text of the file and its fullPath. Providers should not assume
-     * that the file is open (i.e. DocumentManager.getOpenDocumentForPath() may return null) or
-     * that the file on disk matches the text given (file may have unsaved changes).
+     * Registers a provider for a specific language to inspect files and provide linting results.
+     *
+     * The provider is passed the text of the file and its full path. Providers should not assume that
+     * the file is open (i.e., `DocumentManager.getOpenDocumentForPath()` may return `null`) or that the
+     * file on disk matches the text given (the file may have unsaved changes).
      *
      * Registering any provider for the "javascript" language automatically unregisters the built-in
-     * Brackets JSLint provider. This is a temporary convenience until UI exists for disabling
+     * Brackets JSLint provider. This is a temporary convenience until a UI exists for disabling
      * registered providers.
      *
-     * Providers implement scanFile() if results are available synchronously, or scanFileAsync() if results
-     * may require an async wait (if both are implemented, scanFile() is ignored). scanFileAsync() returns
-     * a {$.Promise} object resolved with the same type of value as scanFile() is expected to return.
-     * Rejecting the promise is treated as an internal error in the provider.
+     * Providers must implement `canInspect()`, `scanFile()`, or `scanFileAsync()`. If both `scanFile()`
+     * and `scanFileAsync()` are implemented, `scanFile()` is ignored.
      *
-     * @param {string} languageId
-     * @param {{name:string, scanFileAsync:?function(string, string):!{$.Promise},
-     *         scanFile:?function(string, string):?{errors:!Array, aborted:boolean}}} provider
+     * - `canInspect(fullPath)`: A synchronous call to determine if the file can be scanned by this provider.
+     * - `scanFile(text, fullPath)`: A synchronous function returning linting results or `null`.
+     * - `scanFileAsync(text, fullPath)`: An asynchronous function returning a jQuery Promise resolved with
+     *   the same type of value as `scanFile()`. Rejecting the promise is treated as an internal error in the provider.
      *
-     * Each error is: { pos:{line,ch}, endPos:?{line,ch}, message:string, htmlMessage:string, type:?Type ,
-     *                     fix: { // an optional fix, if present will show the fix button
+     * Each error object in the results should have the following structure:
+     *              { pos:{line,ch},
+     *                endPos:?{line,ch},
+     *                message:string,
+     *                htmlMessage:string,
+     *                type:?Type ,
+     *                fix: { // an optional fix, if present will show the fix button
      *                     replace: "text to replace the offset given below",
      *                     rangeOffset: {
      *                         start: number,
      *                         end: number
-     *                     }}}
-     * If type is unspecified, Type.WARNING is assumed.
-     * If no errors found, return either null or an object with a zero-length `errors` array.
-     * `message` will be printed as text as is. This is needed when the error text contains HTML that may be
-     * mis interpreted as html to display. If you want to display html, pass in `htmlMessage`. Both can be used
-     * at the same time, in which case both will be displayed.
+     *                }}}
+     * @typedef {Object} Error
+     * @property {Object} pos - The start position of the error.
+     * @property {number} pos.line - The line number (0-based).
+     * @property {number} pos.ch - The character position within the line (0-based).
+     * @property {?Object} endPos - The end position of the error.
+     * @property {number} endPos.line - The end line number (0-based).
+     * @property {number} endPos.ch - The end character position within the line (0-based).
+     * @property {string} message - The error message to be displayed as text.
+     * @property {string} htmlMessage - The error message to be displayed as HTML.
+     * @property {?Type} type - The type of the error. Defaults to `Type.WARNING` if unspecified.
+     * @property {?Object} fix - An optional fix object.
+     * @property {string} fix.replace - The text to replace the error with.
+     * @property {Object} fix.rangeOffset - The range within the text to replace.
+     * @property {number} fix.rangeOffset.start - The start offset of the range.
+     * @property {number} fix.rangeOffset.end - The end offset of the range.
+     *
+     * If no errors are found, return either `null`(treated as file is problem free) or an object with a
+     * zero-length `errors` array. Always use `message` to safely display the error as text. If you want to display HTML
+     * error message, then explicitly use `htmlMessage` to display it. Both `message` and `htmlMessage` can
+     * be used simultaneously.
+     *
+     * After scanning the file, if you need to omit the lint result, return or resolve with `{isIgnored: true}`.
+     * This prevents the file from being marked with a no errors tick mark in the status bar and excludes the linter
+     * from the problems panel.
+     *
+     * @param {string} languageId - The language ID for which the provider is registered.
+     * @param {Object} provider - The provider object.
+     * @param {string} provider.name - The name of the provider.
+     * @param {?function(string, string): { errors: Array<Error>, aborted: boolean }} provider.scanFile - Synchronous scan function.
+     * @param {?function(string, string): jQuery.Promise} provider.scanFileAsync - Asynchronous scan function returning a Promise.
      */
     function register(languageId, provider) {
         if (!_providers[languageId]) {
diff --git a/src/styles/brackets.less b/src/styles/brackets.less
@@ -164,7 +164,7 @@ html, body {
     text-decoration-line: underline;
     text-decoration-skip-ink: none;
     text-decoration-thickness: 1px;
-    text-underline-offset: 2px;
+    text-underline-offset: 1px;
     text-decoration-color: @error-underline-text;
 }
 
@@ -173,7 +173,7 @@ html, body {
     text-decoration-line: underline;
     text-decoration-skip-ink: none;
     text-decoration-thickness: 1px;
-    text-underline-offset: 2px;
+    text-underline-offset: 1px;
     text-decoration-color: @warn-underline-text;
     .dark &{
         text-decoration-color: @dark-warn-underline-text;
@@ -185,7 +185,7 @@ html, body {
     text-decoration-line: underline;
     text-decoration-skip-ink: none;
     text-decoration-thickness: 1px;
-    text-underline-offset: 2px;
+    text-underline-offset: 1px;
     text-decoration-color: @spell-underline-text;
 }
 
@@ -194,7 +194,7 @@ html, body {
     text-decoration-line: underline;
     text-decoration-skip-ink: none;
     text-decoration-thickness: 1px;
-    text-underline-offset: 2px;
+    text-underline-offset: 1px;
     text-decoration-color: @info-underline-text;
 }
 
