Modify code to better fit with style guide recommendations

This makes the changes to the code suggested by coffeelint.

Author: mrmr1993

background_scripts/commands.coffee

@@ -9,8 +9,8 @@ Commands =
   # Registers a command, making it available to be optionally bound to a key.
   # options:
   #  - background: whether this command needs to be run against the background page.
-  #  - passCountToFunction: true if this command should have any digits which were typed prior to the
-  #    command passed to it. This is used to implement e.g. "closing of 3 tabs".
+  #  - passCountToFunction: true if this command should have any digits which were typed prior to the command
+  #      passed to it. This is used to implement e.g. "closing of 3 tabs".
   addCommand: (command, description, options) ->
     if command of @availableCommands
       console.log(command, "is already defined! Check commands.coffee for duplicates.")
@@ -38,12 +38,11 @@ Commands =
 
   # Lower-case the appropriate portions of named keys.
   #
-  # A key name is one of three forms exemplified by <c-a> <left> or <c-f12>
-  # (prefixed normal key, named key, or prefixed named key). Internally, for
-  # simplicity, we would like prefixes and key names to be lowercase, though
-  # humans may prefer other forms <Left> or <C-a>.
-  # On the other hand, <c-a> and <c-A> are different named keys - for one of
-  # them you have to press "shift" as well.
+  # A key name is one of three forms exemplified by <c-a> <left> or <c-f12> (prefixed normal key, named key,
+  # or prefixed named key). Internally, for simplicity, we would like prefixes and key names to be lowercase,
+  # though humans may prefer other forms <Left> or <C-a>.
+  # On the other hand, <c-a> and <c-A> are different named keys - for one of them you have to press "shift"
+  # as well.
   normalizeKey: (key) ->
     key.replace(/<[acm]-/ig, (match) -> match.toLowerCase())
        .replace(/<([acm]-)?([a-zA-Z0-9]{2,5})>/g, (match, optionalPrefix, keyName) ->
@@ -82,19 +81,19 @@ Commands =
     for key of defaultKeyMappings
       @mapKeyToCommand(key, defaultKeyMappings[key])
 
-  # An ordered listing of all available commands, grouped by type. This is the order they will
-  # be shown in the help page.
+  # An ordered listing of all available commands, grouped by type. This is the order they will be shown in
+  # the help page.
   commandGroups:
     pageNavigation:
-      ["scrollDown", "scrollUp", "scrollLeft", "scrollRight", "scrollToTop", "scrollToBottom", "scrollToLeft",
-      "scrollToRight", "scrollPageDown", "scrollPageUp", "scrollFullPageUp", "scrollFullPageDown", "reload",
-      "toggleViewSource", "copyCurrentUrl", "LinkHints.activateModeToCopyLinkUrl",
-      "openCopiedUrlInCurrentTab", "openCopiedUrlInNewTab", "goUp", "goToRoot", "enterInsertMode",
-      "focusInput", "LinkHints.activateMode", "LinkHints.activateModeToOpenInNewTab",
-      "LinkHints.activateModeToOpenInNewForegroundTab", "LinkHints.activateModeWithQueue", "Vomnibar.activate",
-      "Vomnibar.activateInNewTab", "Vomnibar.activateTabSelection", "Vomnibar.activateBookmarks",
-      "Vomnibar.activateBookmarksInNewTab", "goPrevious", "goNext", "nextFrame", "Marks.activateCreateMode",
-      "Marks.activateGotoMode"]
+      ["scrollDown", "scrollUp", "scrollLeft", "scrollRight", "scrollToTop", "scrollToBottom",
+      "scrollToLeft", "scrollToRight", "scrollPageDown", "scrollPageUp", "scrollFullPageUp",
+      "scrollFullPageDown", "reload", "toggleViewSource", "copyCurrentUrl",
+      "LinkHints.activateModeToCopyLinkUrl", "openCopiedUrlInCurrentTab", "openCopiedUrlInNewTab", "goUp",
+      "goToRoot", "enterInsertMode", "focusInput", "LinkHints.activateMode",
+      "LinkHints.activateModeToOpenInNewTab", "LinkHints.activateModeToOpenInNewForegroundTab",
+      "LinkHints.activateModeWithQueue", "Vomnibar.activate", "Vomnibar.activateInNewTab",
+      "Vomnibar.activateTabSelection", "Vomnibar.activateBookmarks", "Vomnibar.activateBookmarksInNewTab",
+      "goPrevious", "goNext", "nextFrame", "Marks.activateCreateMode", "Marks.activateGotoMode"]
     findCommands: ["enterFindMode", "performFind", "performBackwardsFind"]
     historyNavigation:
       ["goBack", "goForward"]
@@ -109,10 +108,9 @@ Commands =
   # a focused, high-signal set of commands to the new and casual user. Only those truly hungry for more power
   # from Vimium will uncover these gems.
   advancedCommands: [
-    "scrollToLeft", "scrollToRight", "moveTabToNewWindow",
-    "goUp", "goToRoot", "focusInput", "LinkHints.activateModeWithQueue",
-    "LinkHints.activateModeToOpenIncognito", "goNext", "goPrevious", "Marks.activateCreateMode",
-    "Marks.activateGotoMode", "moveTabLeft", "moveTabRight",
+    "scrollToLeft", "scrollToRight", "moveTabToNewWindow", "goUp", "goToRoot", "focusInput",
+    "LinkHints.activateModeWithQueue", "LinkHints.activateModeToOpenIncognito", "goNext", "goPrevious",
+    "Marks.activateCreateMode", "Marks.activateGotoMode", "moveTabLeft", "moveTabRight",
     "closeTabsOnLeft","closeTabsOnRight", "closeOtherTabs"]
 
 defaultKeyMappings =
@@ -142,8 +140,8 @@ defaultKeyMappings =
 
   "gi": "focusInput"
 
-  "f":     "LinkHints.activateMode"
-  "F":     "LinkHints.activateModeToOpenInNewTab"
+  "f": "LinkHints.activateMode"
+  "F": "LinkHints.activateModeToOpenInNewTab"
   "<a-f>": "LinkHints.activateModeWithQueue"
 
   "/": "enterFindMode"

background_scripts/completion.coffee

@@ -60,9 +60,9 @@ class Suggestion
     #   - splits = [ "", "A",    "b", "a",    "c", "a",    b" ]
     #                UM   M       UM   M       UM   M      UM      (M=Matched, UM=Unmatched)
     splits = string.split(RegexpCache.get(term, "(", ")"))
-    for index in [0..splits.length-2] by 2
+    for index in [0..splits.length - 2] by 2
       unmatchedText = splits[index]
-      matchedText = splits[index+1]
+      matchedText = splits[index + 1]
       # Add the indices spanning `matchedText` to `ranges`.
       textPosition += unmatchedText.length
       ranges.push([textPosition, textPosition + matchedText.length])
@@ -114,9 +114,11 @@ class BookmarkCompleter
   onBookmarksLoaded: -> @performSearch() if @currentSearch
 
   performSearch: ->
-    # If the folder separator character the first character in any query term, then we'll use the bookmark's full path as its title.
-    # Otherwise, we'll just use the its regular title.
-    usePathAndTitle = @currentSearch.queryTerms.reduce ((prev,term) => prev || term.indexOf(@folderSeparator) == 0), false
+    # If the folder separator character the first character in any query term, then we'll use the bookmark's
+    # full path as its title.  Otherwise, we'll just use the its regular title.
+    usePathAndTitle = @currentSearch.queryTerms.reduce (prev,term) =>
+      prev || term.indexOf(@folderSeparator) == 0
+    , false
     results =
       if @currentSearch.queryTerms.length > 0
         @bookmarks.filter (bookmark) =>
@@ -137,7 +139,8 @@ class BookmarkCompleter
       @bookmarks = @traverseBookmarks(bookmarks).filter((bookmark) -> bookmark.url?)
       @onBookmarksLoaded()
 
-  # If these names occur as top-level bookmark names, then they are not included in the names of bookmark folders.
+  # If these names occur as top-level bookmark names, then they are not included in the names of bookmark
+  # folders.
   ignoreTopLevel:
     'Other Bookmarks': true
     'Mobile Bookmarks': true
@@ -151,14 +154,15 @@ class BookmarkCompleter
     results
 
   # Recursive helper for `traverseBookmarks`.
-  traverseBookmarksRecursive: (bookmark, results, parent={pathAndTitle:""}) ->
+  traverseBookmarksRecursive: (bookmark, results, parent = {pathAndTitle: ""}) ->
     bookmark.pathAndTitle =
       if bookmark.title and not (parent.pathAndTitle == "" and @ignoreTopLevel[bookmark.title])
         parent.pathAndTitle + @folderSeparator + bookmark.title
       else
         parent.pathAndTitle
     results.push bookmark
-    bookmark.children.forEach((child) => @traverseBookmarksRecursive child, results, bookmark) if bookmark.children
+    if bookmark.children
+      bookmark.children.forEach((child) => @traverseBookmarksRecursive child, results, bookmark)
 
   computeRelevancy: (suggestion) ->
     RankingUtils.wordRelevancy(suggestion.queryTerms, suggestion.url, suggestion.title)
@@ -186,8 +190,9 @@ class HistoryCompleter
 
   refresh: ->
 
-# The domain completer is designed to match a single-word query which looks like it is a domain. This supports
-# the user experience where they quickly type a partial domain, hit tab -> enter, and expect to arrive there.
+# The domain completer is designed to match a single-word query which looks like it is a domain. This
+# supports the user experience where they quickly type a partial domain, hit tab -> enter, and expect to
+# arrive there.
 class DomainCompleter
   # A map of domain -> { entry: <historyEntry>, referenceCount: <count> }
   #  - `entry` is the most recently accessed page in the History within this domain.
@@ -275,8 +280,10 @@ class SearchEngineCompleter
     searchEngineMatch = this.getSearchEngineMatches(queryTerms[0])
     suggestions = []
     if searchEngineMatch
-      searchEngineMatch = searchEngineMatch.replace(/%s/g, queryTerms[1..].join(" "))
-      suggestion = new Suggestion(queryTerms, "search", searchEngineMatch, queryTerms[0] + ": " + queryTerms[1..].join(" "), @computeRelevancy)
+      searchUrl = searchEngineMatch.replace(/%s/g, queryTerms[1..].join(" "))
+      queryTerms[0] += ":"
+      queryStr = queryTerms.join(" ")
+      suggestion = new Suggestion(queryTerms, "search", searchUrl, queryStr, @computeRelevancy)
       suggestions.push(suggestion)
     onComplete(suggestions)
 
@@ -288,8 +295,8 @@ class SearchEngineCompleter
   getSearchEngineMatches: (queryTerm) ->
     this.searchEngines[queryTerm]
 
-# A completer which calls filter() on many completers, aggregates the results, ranks them, and returns the top
-# 10. Queries from the vomnibar frontend script come through a multi completer.
+# A completer which calls filter() on many completers, aggregates the results, ranks them, and returns the
+# top 10. Queries from the vomnibar frontend script come through a multi completer.
 class MultiCompleter
   constructor: (@completers) -> @maxResults = 10
 
@@ -325,7 +332,7 @@ class MultiCompleter
 # Utilities which help us compute a relevancy score for a given item.
 RankingUtils =
   # Whether the given things (usually URLs or titles) match any one of the query terms.
-  # This is used to prune out irrelevant suggestions before we try to rank them, and for calculating word relevancy.
+  # This is used to prune out irrelevant suggestions before ranking them, and for calculating word relevancy.
   # Every term must match at least one thing.
   matches: (queryTerms, things...) ->
     for term in queryTerms
@@ -338,17 +345,19 @@ RankingUtils =
 
   # Weights used for scoring matches.
   matchWeights:
-    matchAnywhere:     1
-    matchStartOfWord:  1
-    matchWholeWord:    1
+    matchAnywhere: 1
+    matchStartOfWord: 1
+    matchWholeWord: 1
     # The following must be the sum of the three weights above; it is used for normalization.
-    maximumScore:      3
+    maximumScore: 3
     #
     # Calibration factor for balancing word relevancy and recency.
-    recencyCalibrator: 2.0/3.0
+    recencyCalibrator: 2.0 / 3.0
     # The current value of 2.0/3.0 has the effect of:
-    #   - favoring the contribution of recency when matches are not on word boundaries ( because 2.0/3.0 > (1)/3     )
-    #   - favoring the contribution of word relevance when matches are on whole words  ( because 2.0/3.0 < (1+1+1)/3 )
+    #   - favoring the contribution of recency when matches are not on word boundaries
+    #   ( because 2.0/3.0 > (1)/3 )
+    #   - favoring the contribution of word relevance when matches are on whole words
+    #   ( because 2.0/3.0 < (1+1+1)/3 )
 
   # Calculate a score for matching term against string.
   # The score is in the range [0, matchWeights.maximumScore], see above.
@@ -448,13 +457,14 @@ RegexpCache =
   #   - string="go", prefix="\b", suffix=""
   #   - this returns regexp matching "google", but not "agog" (the "go" must occur at the start of a word)
   # TODO: `prefix` and `suffix` might be useful in richer word-relevancy scoring.
-  get: (string, prefix="", suffix="") ->
+  get: (string, prefix = "", suffix = "") ->
     @init() unless @initialized
     regexpString = string.replace(@escapeRegExp, "\\$&")
-    # Avoid cost of constructing new strings if prefix/suffix are empty (which is expected to be a common case).
+    # Avoid cost of constructing new strings if prefix/suffix are empty (which is expected to be common).
     regexpString = prefix + regexpString if prefix
     regexpString = regexpString + suffix if suffix
-    # Smartcase: Regexp is case insensitive, unless `string` contains a capital letter (testing `string`, not `regexpString`).
+    # Smartcase: Regexp is case insensitive, unless `string` contains a capital letter (testing `string`, not
+    # `regexpString`).
     @cache[regexpString] ||= new RegExp regexpString, (if Utils.hasUpperCase(string) then "" else "i")
 
 # Provides cached access to Chrome's history. As the user browses to new pages, we add those pages to this
@@ -503,7 +513,7 @@ HistoryCache =
       @history = []
     else
       toRemove.urls.forEach (url) =>
-        i = HistoryCache.binarySearch({url:url}, @history, @compareHistoryByUrl)
+        i = HistoryCache.binarySearch({url: url}, @history, @compareHistoryByUrl)
         if i < @history.length and @history[i].url == url
           @history.splice(i, 1)
 

background_scripts/main.coffee

@@ -258,9 +258,9 @@ BackgroundCommands =
         # Clean out the tabQueue so we don't have unused windows laying about.
         delete tabQueue[window.id] if (tabQueue[window.id].length == 0)
 
-        # We have to chain a few callbacks to set the appropriate scroll position. We can't just wait until the
-        # tab is created because the content script is not available during the "loading" state. We need to
-        # wait until that's over before we can call setScrollPosition.
+        # We have to chain a few callbacks to set the appropriate scroll position. We can't just wait until
+        # the tab is created because the content script is not available during the "loading" state. We need
+        # to wait until that's over before we can call setScrollPosition.
         chrome.tabs.create({ url: tabQueueEntry.url, index: tabQueueEntry.positionIndex }, (tab) ->
           tabLoadedHandlers[tab.id] = ->
             chrome.tabs.sendRequest(tab.id,
@@ -276,7 +276,7 @@ BackgroundCommands =
   showHelp: (callback, frameId) ->
     chrome.tabs.getSelected(null, (tab) ->
       chrome.tabs.sendMessage(tab.id,
-        { name: "toggleHelpDialog", dialogHtml: helpDialogHtml(), frameId:frameId }))
+        { name: "toggleHelpDialog", dialogHtml: helpDialogHtml(), frameId: frameId }))
   moveTabLeft: (count) -> moveTab(null, -count)
   moveTabRight: (count) -> moveTab(null, count)
   nextFrame: (count) ->
@@ -416,8 +416,8 @@ chrome.tabs.onRemoved.addListener (tabId) ->
   else
     tabQueue[openTabInfo.windowId] = [openTabInfo]
 
-  # keep the reference around for a while to wait for the last messages from the closed tab (e.g. for updating
-  # scroll position)
+  # keep the reference around for a while to wait for the last messages from the closed tab (e.g. for
+  # updating scroll position)
   tabInfoMap.deletor = -> delete tabInfoMap[tabId]
   setTimeout tabInfoMap.deletor, 1000
   delete framesForTab[tabId]

background_scripts/settings.coffee

@@ -47,7 +47,7 @@ root.Settings = Settings =
   parseSearchEngines: (searchEnginesText) ->
     @searchEnginesMap = {}
     # find the split pairs by first splitting by line then splitting on the first `: `
-    split_pairs = ( pair.split( /: (.+)/, 2) for pair in searchEnginesText.split( /\n/ ) when pair[0] != "#" )
+    split_pairs = (pair.split( /: (.+)/, 2) for pair in searchEnginesText.split( /\n/ ) when pair[0] != "#")
     @searchEnginesMap[a[0]] = a[1] for a in split_pairs
     @searchEnginesMap
   getSearchEngines: ->

background_scripts/sync.coffee

@@ -78,7 +78,7 @@ root.Sync = Sync =
       @log "set scheduled: #{key}=#{value}"
       key_value = {}
       key_value[key] = value
-      @storage.set key_value, =>
+      @storage.set key_value, ->
         # Chrome sets chrome.runtime.lastError if there is an error.
         if chrome.runtime.lastError
           console.log "callback for Sync.set() indicates error: #{key} <- #{value}"
@@ -88,7 +88,7 @@ root.Sync = Sync =
   clear: (key) ->
     if @shouldSyncKey key
       @log "clear scheduled: #{key}"
-      @storage.remove key, =>
+      @storage.remove key, ->
         # Chrome sets chrome.runtime.lastError if there is an error.
         if chrome.runtime.lastError
           console.log "for Sync.clear() indicates error: #{key}"

content_scripts/link_hints.coffee

@@ -1,6 +1,7 @@
 #
 # This implements link hinting. Typing "F" will enter link-hinting mode, where all clickable items on the
-# page have a hint marker displayed containing a sequence of letters. Typing those letters will select a link.
+# page have a hint marker displayed containing a sequence of letters. Typing those letters will select a
+# link.
 #
 # In our 'default' mode, the characters we use to show link hints are a user-configurable option. By default
 # they're the home row.  The CSS which is used on the link hints is also a configurable option.
@@ -346,8 +347,8 @@ filterHints =
       if (forElement)
         labelText = label.textContent.trim()
         # remove trailing : commonly found in labels
-        if (labelText[labelText.length-1] == ":")
-          labelText = labelText.substr(0, labelText.length-1)
+        if (labelText[labelText.length - 1] == ":")
+          labelText = labelText.substr(0, labelText.length - 1)
         @labelMap[forElement] = labelText
 
   generateHintString: (linkHintNumber) ->