Merge pull request #11949 from adobe/swmitra/TypeInferenceInHintlist

abose · abose · commit 60eaca48e18f · 2015-12-10T17:41:38.000+05:30
[WIP]Type Inference in hint list.
diff --git a/src/extensions/default/JavaScriptCodeHints/Session.js b/src/extensions/default/JavaScriptCodeHints/Session.js
@@ -570,6 +570,14 @@ define(function (require, exports, module) {
                     if (hint.depth !== undefined) {
                         searchResult.depth = hint.depth;
                     }
+                    
+                    if (hint.doc) {
+                        searchResult.doc = hint.doc;
+                    }
+                    
+                    if (hint.url) {
+                        searchResult.url = hint.url;
+                    }
 
                     if (!type.property && !type.showFunctionType && hint.origin &&
                             isBuiltin(hint.origin)) {
diff --git a/src/extensions/default/JavaScriptCodeHints/main.js b/src/extensions/default/JavaScriptCodeHints/main.js
@@ -149,6 +149,63 @@ define(function (require, exports, module) {
             console.debug("Hints", _.pluck(hints, "label"));
         }
         
+        var _infered = true;
+        
+        function getInferHelper(type) {
+            return function (element, index, array) {
+                if (element === type && _infered) {
+                    _infered = true;
+                } else {
+                    _infered = false;
+                }
+            };
+        }
+        
+        function inferArrayTypeClass(typeExpr) {
+            var type = "type-array";
+            var types = typeExpr.split('[')[1].split(']')[0].split(',');
+           
+            _infered = true;
+            
+            types.every(getInferHelper('string'));
+            if (_infered) {
+                type = 'type-string-array';
+            } else {
+                _infered = true;
+                types.every(getInferHelper('number'));
+                if (_infered) {
+                    type = 'type-num-array';
+                } else {
+                    _infered = true;
+                    types.every(getInferHelper('Object'));
+                    if (_infered) {
+                        type = 'type-object-array';
+                    }
+                }
+            }
+            return type;
+        }
+        
+        function getRenderTypeClass(type) {
+            var typeClass = 'type-undetermined';
+            if (type) {
+                if (type.indexOf('Object') === 0) {
+                    typeClass = 'type-object';
+                } else if (type.indexOf('[') === 0) {
+                    typeClass = inferArrayTypeClass(type);
+                } else if (type.indexOf('fn') === 0) {
+                    typeClass = 'type-function';
+                } else if (type.indexOf('string') === 0) {
+                    typeClass = "type-string";
+                } else if (type.indexOf('number') === 0) {
+                    typeClass = 'type-number';
+                } else if (type.indexOf('bool') === 0) {
+                    typeClass = 'type-boolean';
+                }
+            }
+            return typeClass;
+        }
+        
         /*
          * Returns a formatted list of hints with the query substring
          * highlighted.
@@ -165,7 +222,8 @@ define(function (require, exports, module) {
         function formatHints(hints, query) {
             return hints.map(function (token) {
                 var $hintObj    = $("<span>").addClass("brackets-js-hints");
-
+                ($hintObj).addClass(getRenderTypeClass(token.type));
+                //$('<span>' + getRenderType(token.type) + '</span>').appendTo($hintObj).addClass("brackets-js-hints-type");
                 // level indicates either variable scope or property confidence
                 if (!type.property && !token.builtin && token.depth !== undefined) {
                     switch (token.depth) {
@@ -211,9 +269,37 @@ define(function (require, exports, module) {
                 } else {
                     $hintObj.text(token.value);
                 }
-
+    
                 $hintObj.data("token", token);
                 
+                function _appendLink() {
+                    if (token.url) {
+                        $('<a></a>').appendTo($hintObj).addClass("jshint-link").attr('href', token.url).on("click", function (event) {
+                            event.stopImmediatePropagation();
+                            event.stopPropagation();
+                        });
+                    }
+                }
+                
+                if (token.type) {
+                    if (token.type.length > 40) {
+                        _appendLink();
+                        $('<span>' + token.type.split('->').join(':').toString().trim() + '</span>').appendTo($hintObj).addClass("jshint-description");
+                    } else {
+                        $('<span>' + token.type.split('->').join(':').toString().trim() + '</span>').appendTo($hintObj).addClass("brackets-js-hints-type-details");
+                        _appendLink();
+                    }
+                } else {
+                    if (token.keyword) {
+                        $('<span>keyword</span>').appendTo($hintObj).addClass("brackets-js-hints-type-details").addClass("keyword");
+                    }
+                }
+                
+                if (token.doc) {
+                    $hintObj.attr('title', token.doc);
+                    $('<span></span>').text(token.doc.trim()).appendTo($hintObj).addClass("jshint-jsdoc");
+                }
+                
                 return $hintObj;
             });
         }
@@ -234,7 +320,7 @@ define(function (require, exports, module) {
             handleWideResults: hints.handleWideResults
         };
     }
-
+    
     /**
      * @constructor
      */
diff --git a/src/extensions/default/JavaScriptCodeHints/styles/brackets-js-hints.css b/src/extensions/default/JavaScriptCodeHints/styles/brackets-js-hints.css
@@ -21,6 +21,207 @@
  * 
  */
 
+
+span.brackets-js-hints {
+    width: 400px;
+    display: inline-block;
+}
+
+.brackets-js-hints.type-undetermined:before {
+    color: cornflowerblue;
+    content: '12';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    visibility: hidden;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-number:before {
+    color: cornflowerblue;
+    content: '12';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-string:before {
+    color: cornflowerblue;
+    content: 'ab';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-function:before {
+    color: cornflowerblue;
+    content: 'fn( )';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-array:before {
+    color: cornflowerblue;
+    content: '[  ]';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-object:before {
+    color: cornflowerblue;
+    content: '{ :}';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-num-array:before {
+    color: cornflowerblue;
+    content: '[12]';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-string-array:before {
+    color: cornflowerblue;
+    content: '[ab]';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints.type-boolean:before {
+    color: cornflowerblue;
+    content: 'bool';
+    border: 1px cornflowerblue solid;
+    float:left;
+    width:25px;
+    text-align: center;
+    margin-left:-5px;
+    margin-right:5px;
+    line-height: 1.2em;
+}
+
+.brackets-js-hints-type-details {
+    color: #d3d3d3 !important;
+    font-weight: 100;
+    font-style: italic !important;
+    margin-right: 5px;
+    float:right;
+}
+
+.jshint-description {
+    display: none;
+    padding-left: 28px !important;
+    padding-right:10px !important;
+    color: #d4d4d4;
+    word-wrap: break-word;	
+    white-space: normal;
+    width:400px;
+    box-sizing: border-box;
+}
+
+.dark .jshint-description {
+    color: #ccc;
+}
+
+.jshint-jsdoc {
+    display: none;
+    padding-left: 28px !important;
+    padding-right: 10px !important;
+    color: grey;
+    word-wrap: break-word;
+    white-space: normal;
+    width: 400px;
+    box-sizing: border-box;
+    float: left;
+    clear: left;
+    max-height: 3em;
+    overflow: hidden;
+}
+
+.dark .jshint-jsdoc {
+    color: #ccc;
+}
+
+.jshint-link {
+    float:right;
+    display:none;
+    margin-right: 10px !important;
+}
+
+.jshint-link:before {
+    float: right;
+    color: orangered !important;
+    content: '?' !important;
+    border: 1px orangered solid;
+    width: 10px;
+    text-align: center;
+    line-height: 1em;
+    visibility: visible !important;
+}
+
+.highlight .jshint-link {
+    display:block;
+}
+
+.highlight .jshint-description {
+    display: block;
+    color: #6495ed !important;
+}
+
+.highlight .jshint-jsdoc {
+    display: block;
+}
+
+.dark .brackets-js-hints-type-details {
+    color: #696969 !important;
+} 
+
+.highlight .brackets-js-hints-type-details {
+    color: #6495ed !important;
+    display: inline-block;
+}
+
+.brackets-js-hints-type-details.keyword {
+    color: #6495ed !important;
+}
+
+
 .brackets-js-hints.priority-high {
     color: #486c00; /* green */
 }
diff --git a/src/extensions/default/JavaScriptCodeHints/tern-worker.js b/src/extensions/default/JavaScriptCodeHints/tern-worker.js
@@ -168,6 +168,8 @@ var config = {};
                 query.types = true;
                 query.expandWordForward = false;
                 query.lineCharPositions = true;
+                query.docs = true;
+                query.urls = true;
 
                 var request = {query: query, files: [], offset: offset, timeout: inferenceTimeout};
                 if (fileInfo.type !== MessageIds.TERN_FILE_INFO_TYPE_EMPTY) {
@@ -294,7 +296,7 @@ var config = {};
                             for (i = 0; i < data.completions.length; ++i) {
                                 var completion = data.completions[i];
                                 completions.push({value: completion.name, type: completion.type, depth: completion.depth,
-                                    guess: completion.guess, origin: completion.origin});
+                                    guess: completion.guess, origin: completion.origin, doc: completion.doc, url: completion.url});
                             }
                         }
 
