Spell Check about rocket.chat.electron

[rodrigok]

Now we have spell checker 😄

[geekgonecrazy]

@rodrigok is this still osx only or is windows support there? Cause i'm not seeing this in the v1.0.0 release on windows either 😦

[rodrigok]

The spell checker code is working, but I can't compile the dictionary for windows, so, you can use on windows now.
Maybe you can try to compile this module

[crimsoncor]

So the currently implement of spell checking leaves some things to be desired. It seems to be based off the suggestion here electron/electron#942, but that implementation is flawed because it builds the context menu at the time of the word being checked, not at right-click time which leads to weird graphical inconsistencies. For example, try misspelling a word and then right-clicking somewhere outside the current text area: you'll see the list of possible replacements but selecting an option does nothing.

Replacing the current implementation in preload.js with the below code yields much better results for me.

var remote = require('remote');
var spellchecker = require('spellchecker')
var Menu = remote.require('menu');

var template = [
{
  label: "Undo",
  click: function(item, window) {
    remote.getCurrentWebContents().undo();
  }
},
{
  label: "Redo",
  click: function(item, window) {
    remote.getCurrentWebContents().redo();
  }
},
{
  type: 'separator'
},
{
  label: "Cut",
  click: function(item, window) {
    remote.getCurrentWebContents().cut();
  }
},
{
  label: "Copy",
  click: function(item, window) {
    remote.getCurrentWebContents().copy();
  }
},
{
  label: "Paste",
  click: function(item, window) {
    remote.getCurrentWebContents().paste();
  }
},
{
  type: 'separator'
},
{
  label: "Select All",
  click: function(item, window) {
    remote.getCurrentWebContents().selectAll();
  }
}];

require('web-frame').setSpellCheckProvider((localStorage.getItem('userLanguage') || "en-US"),
                                            false, {
  spellCheck: function(text) {
    return !(spellchecker.isMisspelled(text));
  }
});

window.addEventListener('contextmenu', function(event) {
  switch(event.target.nodeName) {
    case 'TEXTAREA':
      var value = event.target.value;
      var cursor = event.target.selectionStart;
      var strLength = value.length;
      event.preventDefault();
      if (cursor == strLength || value.charAt(cursor) == " ") {
        var menu = Menu.buildFromTemplate(template);
        menu.popup(remote.getCurrentWindow());
      }
      else {
        var end = value.indexOf(" ", cursor);
        end = end == -1 ? strLength : end;
        var start = value.lastIndexOf(" ", cursor) + 1;
        var text = value.substring(start, end);
        var bad = spellchecker.isMisspelled(text);
        var newTemplate = template.slice();
        if (bad) {
          var replacements = spellchecker.getCorrectionsForMisspelling(text);
          var num = replacements.length ? replacements.length : 0;
          var maxItems = num > 7 ? 7 : num;
          var items = [];
          for (var i = 0; i < maxItems; i++) {
            var item = replacements[i];
            items.push({
              label: item,
              click : function(menuItem, window) {
                remote.getCurrentWebContents().replaceMisspelling(menuItem.label);
              }
            });
          }
          if (maxItems > 0) {
            newTemplate.push({
              type: 'separator'
            });
            newTemplate.push({
              label: "Spelling suggestions",
              submenu: items
            });
          }
        }
        var menu = Menu.buildFromTemplate(newTemplate);
        menu.popup(remote.getCurrentWindow());
      }
      break;
    default:
      var menu = Menu.buildFromTemplate(template);
      menu.popup(remote.getCurrentWindow());
      break;
  }

}, false);

[rodrigok]

@crimsoncor see #121 and #122

Thanks