move to electron spellchecker
Audric Ackermann
5 years ago
parent
dbd17b6532
commit
9ff16d7e60
@ -0,0 +1,88 @@
|
||||
/* global exports, require */
|
||||
/* eslint-disable strict */
|
||||
|
||||
const { Menu } = require('electron');
|
||||
const osLocale = require('os-locale');
|
||||
|
||||
exports.setup = (browserWindow, messages) => {
|
||||
const { session } = browserWindow.webContents;
|
||||
const userLocale = osLocale.sync().replace(/_/g, '-');
|
||||
const userLocales = [userLocale, userLocale.split('-')[0]];
|
||||
|
||||
const available = session.availableSpellCheckerLanguages;
|
||||
const languages = userLocales.filter(l => available.includes(l));
|
||||
console.log(`spellcheck: user locale: ${userLocale}`);
|
||||
console.log('spellcheck: available spellchecker languages: ', available);
|
||||
console.log('spellcheck: setting languages to: ', languages);
|
||||
session.setSpellCheckerLanguages(languages);
|
||||
|
||||
browserWindow.webContents.on('context-menu', (_event, params) => {
|
||||
const { editFlags } = params;
|
||||
const isMisspelled = Boolean(params.misspelledWord);
|
||||
const showMenu = params.isEditable || editFlags.canCopy;
|
||||
|
||||
// Popup editor menu
|
||||
if (showMenu) {
|
||||
const template = [];
|
||||
|
||||
if (isMisspelled) {
|
||||
if (params.dictionarySuggestions.length > 0) {
|
||||
template.push(
|
||||
...params.dictionarySuggestions.map(label => ({
|
||||
label,
|
||||
click: () => {
|
||||
browserWindow.webContents.replaceMisspelling(label);
|
||||
},
|
||||
}))
|
||||
);
|
||||
} else {
|
||||
template.push({
|
||||
label: messages.contextMenuNoSuggestions.message,
|
||||
enabled: false,
|
||||
});
|
||||
}
|
||||
template.push({ type: 'separator' });
|
||||
}
|
||||
|
||||
if (params.isEditable) {
|
||||
if (editFlags.canUndo) {
|
||||
template.push({ label: messages.editMenuUndo.message, role: 'undo' });
|
||||
}
|
||||
// This is only ever `true` if undo was triggered via the context menu
|
||||
// (not ctrl/cmd+z)
|
||||
if (editFlags.canRedo) {
|
||||
template.push({ label: messages.editMenuRedo.message, role: 'redo' });
|
||||
}
|
||||
if (editFlags.canUndo || editFlags.canRedo) {
|
||||
template.push({ type: 'separator' });
|
||||
}
|
||||
if (editFlags.canCut) {
|
||||
template.push({ label: messages.editMenuCut.message, role: 'cut' });
|
||||
}
|
||||
}
|
||||
|
||||
if (editFlags.canPaste) {
|
||||
template.push({ label: messages.editMenuPaste.message, role: 'paste' });
|
||||
}
|
||||
|
||||
if (editFlags.canPaste) {
|
||||
template.push({
|
||||
label: messages.editMenuPasteAndMatchStyle.message,
|
||||
role: 'pasteAndMatchStyle',
|
||||
});
|
||||
}
|
||||
|
||||
// Only enable select all in editors because select all in non-editors
|
||||
// results in all the UI being selected
|
||||
if (editFlags.canSelectAll && params.isEditable) {
|
||||
template.push({
|
||||
label: messages.editMenuSelectAll.message,
|
||||
role: 'selectall',
|
||||
});
|
||||
}
|
||||
|
||||
const menu = Menu.buildFromTemplate(template);
|
||||
menu.popup(browserWindow);
|
||||
}
|
||||
});
|
||||
};
|
||||
@ -1,185 +0,0 @@
|
||||
/* global require, process, _ */
|
||||
|
||||
/* eslint-disable strict */
|
||||
|
||||
const electron = require('electron');
|
||||
|
||||
const Typo = require('typo-js');
|
||||
const fs = require('fs');
|
||||
const osLocale = require('os-locale');
|
||||
const path = require('path');
|
||||
|
||||
const { remote, webFrame } = electron;
|
||||
|
||||
// `remote.require` since `Menu` is a main-process module.
|
||||
const buildEditorContextMenu = remote.require('electron-editor-context-menu');
|
||||
|
||||
const EN_VARIANT = /^en/;
|
||||
|
||||
// Prevent the spellchecker from showing contractions as errors.
|
||||
const ENGLISH_SKIP_WORDS = [
|
||||
'ain',
|
||||
'couldn',
|
||||
'didn',
|
||||
'doesn',
|
||||
'hadn',
|
||||
'hasn',
|
||||
'mightn',
|
||||
'mustn',
|
||||
'needn',
|
||||
'oughtn',
|
||||
'shan',
|
||||
'shouldn',
|
||||
'wasn',
|
||||
'weren',
|
||||
'wouldn',
|
||||
];
|
||||
|
||||
function setupLinux(locale) {
|
||||
if (process.env.HUNSPELL_DICTIONARIES || locale !== 'en_US') {
|
||||
// apt-get install hunspell-<locale> can be run for easy access
|
||||
// to other dictionaries
|
||||
const location = process.env.HUNSPELL_DICTIONARIES || '/usr/share/hunspell';
|
||||
const affDataPath = path.join(location, `${locale}.aff`);
|
||||
const dicDataPath = path.join(location, `${locale}.dic`);
|
||||
|
||||
window.log.info(
|
||||
'Detected Linux. Setting up spell check with locale',
|
||||
locale,
|
||||
'and dictionary location',
|
||||
location
|
||||
);
|
||||
|
||||
if (fs.existsSync(affDataPath) && fs.existsSync(dicDataPath)) {
|
||||
const affData = fs.readFileSync(affDataPath, 'utf-8');
|
||||
const dicData = fs.readFileSync(dicDataPath, 'utf-8');
|
||||
|
||||
return new Typo(locale, affData, dicData);
|
||||
}
|
||||
|
||||
window.log.error(
|
||||
`Could not find one of ${affDataPath} or ${dicDataPath} on filesystem`
|
||||
);
|
||||
}
|
||||
|
||||
window.log.info('Detected Linux. Using default en_US spell check dictionary');
|
||||
|
||||
return new Typo(locale);
|
||||
}
|
||||
|
||||
// We load locale this way and not via app.getLocale() because this call returns
|
||||
// 'es_ES' and not just 'es.' And hunspell requires the fully-qualified locale.
|
||||
const locale = osLocale.sync().replace('-', '_');
|
||||
|
||||
// The LANG environment variable is how node spellchecker finds its default language:
|
||||
// https://github.com/atom/node-spellchecker/blob/59d2d5eee5785c4b34e9669cd5d987181d17c098/lib/spellchecker.js#L29
|
||||
if (!process.env.LANG) {
|
||||
process.env.LANG = locale;
|
||||
}
|
||||
|
||||
let spellchecker = null;
|
||||
|
||||
if (process.platform === 'linux') {
|
||||
spellchecker = setupLinux(locale);
|
||||
} else {
|
||||
spellchecker = new Typo(locale);
|
||||
// OSX and Windows 8+ have OS-level spellcheck APIs
|
||||
window.log.info(
|
||||
'Using OS-level spell check API with locale',
|
||||
process.env.LANG
|
||||
);
|
||||
}
|
||||
|
||||
const simpleChecker = {
|
||||
spellCheck(words, callback) {
|
||||
let mispelled;
|
||||
if (Array.isArray(words)) {
|
||||
mispelled = words.filter(word => this.isMisspelled(word));
|
||||
} else {
|
||||
mispelled = this.isMisspelled(words);
|
||||
}
|
||||
|
||||
callback(mispelled);
|
||||
},
|
||||
isMisspelled(word) {
|
||||
const misspelled = !spellchecker.check(word);
|
||||
|
||||
// The idea is to make this as fast as possible. For the many, many calls which
|
||||
// don't result in the red squiggly, we minimize the number of checks.
|
||||
if (!misspelled) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Only if we think we've found an error do we check the locale and skip list.
|
||||
if (locale.match(EN_VARIANT) && _.contains(ENGLISH_SKIP_WORDS, word)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
},
|
||||
getSuggestions(text) {
|
||||
return spellchecker.suggest(text);
|
||||
},
|
||||
add() {},
|
||||
};
|
||||
|
||||
const dummyChecker = {
|
||||
spellCheck(words, callback) {
|
||||
callback([]);
|
||||
},
|
||||
isMisspelled() {
|
||||
return false;
|
||||
},
|
||||
getSuggestions() {
|
||||
return [];
|
||||
},
|
||||
add() {
|
||||
// nothing
|
||||
},
|
||||
};
|
||||
|
||||
window.spellChecker = simpleChecker;
|
||||
window.disableSpellCheck = () => {
|
||||
window.removeEventListener('contextmenu', spellCheckHandler);
|
||||
window.addEventListener('contextmenu', defaultContextMenuHandler);
|
||||
webFrame.setSpellCheckProvider('en-US', dummyChecker);
|
||||
};
|
||||
|
||||
window.enableSpellCheck = () => {
|
||||
webFrame.setSpellCheckProvider('en-US', simpleChecker);
|
||||
window.addEventListener('contextmenu', spellCheckHandler);
|
||||
window.removeEventListener('contextmenu', defaultContextMenuHandler);
|
||||
};
|
||||
|
||||
const defaultContextMenuHandler = () => {
|
||||
const menu = buildEditorContextMenu({});
|
||||
|
||||
// @see js/spell_check.js:183
|
||||
setTimeout(() => {
|
||||
menu.popup(remote.getCurrentWindow());
|
||||
}, 30);
|
||||
};
|
||||
|
||||
const spellCheckHandler = e => {
|
||||
// Only show the context menu in text editors.
|
||||
if (!e.target.closest('textarea, input, [contenteditable="true"]')) {
|
||||
return;
|
||||
}
|
||||
|
||||
const selectedText = window.getSelection().toString();
|
||||
const isMisspelled = selectedText && simpleChecker.isMisspelled(selectedText);
|
||||
const spellingSuggestions =
|
||||
isMisspelled && simpleChecker.getSuggestions(selectedText).slice(0, 5);
|
||||
const menu = buildEditorContextMenu({
|
||||
isMisspelled,
|
||||
spellingSuggestions,
|
||||
});
|
||||
|
||||
// The 'contextmenu' event is emitted after 'selectionchange' has fired
|
||||
// but possibly before the visible selection has changed. Try to wait
|
||||
// to show the menu until after that, otherwise the visible selection
|
||||
// will update after the menu dismisses and look weird.
|
||||
setTimeout(() => {
|
||||
menu.popup(remote.getCurrentWindow());
|
||||
}, 30);
|
||||
};
|
||||
@ -1,15 +0,0 @@
|
||||
describe('spellChecker', () => {
|
||||
it('should work', () => {
|
||||
let result = null;
|
||||
|
||||
window.spellChecker.spellCheck(['correct'], answer => {
|
||||
result = answer;
|
||||
});
|
||||
assert.deepEqual(result, []);
|
||||
|
||||
window.spellChecker.spellCheck(['fhqwgads'], answer => {
|
||||
result = answer;
|
||||
});
|
||||
assert.deepEqual(result, ['fhqwgads']);
|
||||
});
|
||||
});
|
||||
Loading…
Reference in New Issue