Merge pull request #4509 from adobe/pflynn/jslint-tooltip

Fix #4486 (No JSLint icon tooltip in some states) & small cleanups

Author: jasonsanjose

src/extensions/default/JSLint/jslint.css

@@ -1,12 +1,11 @@
 #status-indicators #jslint-status {
     border: none;
-    cursor: default;	
+    cursor: default;
     width: 13px;
 }
 
 .jslint-disabled {
     background: url(images/topcoat-inactive-15.svg) 9px 5px no-repeat;
-    pointer-events: none;
 }
 
 .jslint-errors {
@@ -23,7 +22,6 @@
 
 .jslint-valid {
     background: url(images/topcoat-okay-15.svg) 9px 5px no-repeat;
-    pointer-events: none;
 }
 
 #jslint-results .line { /* To make the line number line up with editor line numbers */

src/extensions/default/JSLint/main.js

@@ -97,6 +97,13 @@ define(function (require, exports, module) {
      */
     var _gotoEnabled = false;
 
+    /**
+     * @private
+     * @type {boolean}
+     */
+    var _hasErrors = false;
+    
+    
     /**
      * Enable or disable the "Go to First JSLint Error" command
      * @param {boolean} gotoEnabled Whether it is enabled.
@@ -139,8 +146,10 @@ define(function (require, exports, module) {
             perfTimerDOM = PerfUtils.markStart("JSLint DOM:\t" + (!currentDoc || currentDoc.file.fullPath));
 
             if (!result) {
-                // Remove the null errors for the template
+                // Remove any null error (early-abort indicator) before rendering results
                 var errors = JSLINT.errors.filter(function (err) { return err !== null; });
+                
+                // Update results table
                 var html   = Mustache.render(ResultsTemplate, {reportList: errors});
                 var $selectedRow;
 
@@ -164,16 +173,16 @@ define(function (require, exports, module) {
                         EditorManager.focusEditor();
                     });
 
+                _hasErrors = true;
                 if (!_collapsed) {
                     Resizer.show($lintResults);
                 }
                 if (JSLINT.errors.length === 1) {
                     StatusBar.updateIndicator(INDICATOR_ID, true, "jslint-errors", Strings.JSLINT_ERROR_INFORMATION);
                 } else {
-                    // Return the number of non-null errors
+                    // Error count string: if we filtered out a null above, there was a stop error so the
+                    // total number of errors is indeterminate. Append a '+' to indicate that.
                     var numberOfErrors = errors.length;
-                    // If there was a null value it means there was a stop notice and an indeterminate
-                    // upper bound on the number of JSLint errors, which we'll represent by appending a '+'
                     if (numberOfErrors !== JSLINT.errors.length) {
                         // First discard the stop notice
                         numberOfErrors -= 1;
@@ -185,6 +194,7 @@ define(function (require, exports, module) {
                 setGotoEnabled(true);
 
             } else {
+                _hasErrors = false;
                 Resizer.hide($lintResults);
                 StatusBar.updateIndicator(INDICATOR_ID, true, "jslint-valid", Strings.JSLINT_NO_ERRORS);
                 setGotoEnabled(false);
@@ -194,6 +204,7 @@ define(function (require, exports, module) {
 
         } else {
             // JSLint is disabled or does not apply to the current file, hide the results
+            _hasErrors = false;
             Resizer.hide($lintResults);
             StatusBar.updateIndicator(INDICATOR_ID, true, "jslint-disabled", Strings.JSLINT_DISABLED);
             setGotoEnabled(false);
@@ -291,29 +302,34 @@ define(function (require, exports, module) {
     AppInit.htmlReady(function () {
         ExtensionUtils.loadStyleSheet(module, "jslint.css");
 
+        // Create bottom panel to list error details
         var jsLintHtml = Mustache.render(JSLintTemplate, Strings);
         var resultsPanel = PanelManager.createBottomPanel("jslint.results", $(jsLintHtml), 100);
         $lintResults = $("#jslint-results");
 
         var lintStatusHtml = Mustache.render("<div id=\"lint-status\" title=\"{{JSLINT_NO_ERRORS}}\">&nbsp;</div>", Strings);
         $(lintStatusHtml).insertBefore("#status-language");
-        StatusBar.addIndicator(INDICATOR_ID, $("#lint-status"));
         $("#jslint-results .close").click(function () {
             toggleCollapsed(true);
         });
+        
+        // Create status bar indicator
+        StatusBar.addIndicator(INDICATOR_ID, $("#lint-status"));
 
-        $("#jslint-status").click(function () {
-            toggleCollapsed();
+        $("#jslint-status").click(function (event) {
+            // Clicking indicator toggles error panel, if any errors in current file
+            if (_hasErrors) {
+                toggleCollapsed();
+            }
         });
-                                                                
-                                
-        // Called on HTML ready to trigger the initial UI state
+        
+        // Set initial UI state
         setEnabled(_prefs.getValue("enabled"));
 
         toggleCollapsed(_prefs.getValue("collapsed"));
-                
     });
 
+    
     // for unit tests
     exports.setEnabled = setEnabled;
 });

src/nls/root/strings.js

@@ -195,7 +195,7 @@ define({
     "CMD_FILE_DELETE"                     : "Delete",
     "CMD_INSTALL_EXTENSION"               : "Install Extension\u2026",
     "CMD_EXTENSION_MANAGER"               : "Extension Manager\u2026",
-    "CMD_FILE_REFRESH"                    : "Refresh",
+    "CMD_FILE_REFRESH"                    : "Refresh File Tree",
     "CMD_QUIT"                            : "Quit",
     // Used in native File menu on Windows
     "CMD_EXIT"                            : "Exit",

src/widgets/StatusBar.js

@@ -94,14 +94,12 @@ define(function (require, exports, module) {
     /**
      * Registers a new status indicator
      * @param {string} id Registration id of the indicator to be updated.
-     * @param {DOMNode} indicator Optional DOMNode for the indicator
-     * @param {boolean} visible Shows or hides the indicator over the statusbar.
-     * @param {string} style Sets the attribute "class" of the indicator.
-     * @param {string} tooltip Sets the attribute "title" of the indicator.
-     * @param {string} command Optional command name to execute on the indicator click.
-     * TODO Unused command parameter. Include command functionality for statusbar indicators.
+     * @param {(DOMNode|jQueryObject)=} indicator Optional DOMNode for the indicator
+     * @param {boolean=} visible Shows or hides the indicator over the statusbar.
+     * @param {string=} style Sets the attribute "class" of the indicator.
+     * @param {string=} tooltip Sets the attribute "title" of the indicator.
      */
-    function addIndicator(id, indicator, visible, style, tooltip, command) {
+    function addIndicator(id, indicator, visible, style, tooltip) {
         if (!_init) {
             console.error("StatusBar API invoked before status bar created");
             return;
@@ -117,7 +115,7 @@ define(function (require, exports, module) {
         $indicator.attr("id", id);
         $indicator.attr("title", tooltip);
         $indicator.addClass("indicator");
-        $indicator.addClass("style");
+        $indicator.addClass(style);
 
         if (!visible) {
             $indicator.hide();
@@ -129,11 +127,10 @@ define(function (require, exports, module) {
      * Updates a status indicator
      * @param {string} id Registration id of the indicator to be updated.
      * @param {boolean} visible Shows or hides the indicator over the statusbar.
-     * @param {string} style Sets the attribute "class" of the indicator.
-     * @param {string} tooltip Sets the attribute "title" of the indicator.
-     * @param {string} command Optional command name to execute on the indicator click.
+     * @param {string=} style Sets the attribute "class" of the indicator.
+     * @param {string=} tooltip Sets the attribute "title" of the indicator.
      */
-    function updateIndicator(id, visible, style, tooltip, command) {
+    function updateIndicator(id, visible, style, tooltip) {
         if (!_init) {
             console.error("StatusBar API invoked before status bar created");
             return;