diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a89676e..b48540d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ from the final changelog of the release. Release date: TBD ### Improvements +- Added spell checker for English, French, German, Spanish, and Dutch. - Removed "Display secure content only" option it's no longer necessary. #### Windows diff --git a/NOTICE.txt b/NOTICE.txt index d9f4c12a..4d52366e 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -489,6 +489,393 @@ THE SOFTWARE. --- +## simple-spellchecker + +This product contains a modified portion of 'simple-spellchecker', a simple and fast spellchecker with spelling suggestions and Electron's integration, by jfmdev. + +Access to the source code of Simple Spellchecker ©jfmdev can be found at https://github.com/jfmdev/simple-spellchecker. + +* HOMEPAGE: + * https://github.com/jfmdev/simple-spellchecker + +* LICENSE: + +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. + +--- + ## underscore This product contains a modified portion of 'underscore', a utility-belt library for JavaScript that provides support for usual functional suspects diff --git a/electron-builder.json b/electron-builder.json index 64ad5278..882601e9 100644 --- a/electron-builder.json +++ b/electron-builder.json @@ -9,7 +9,8 @@ "main_bundle.js", "browser/**/*{.html,.css,_bundle.js}", "assets/**/*", - "node_modules/bootstrap/dist/**" + "node_modules/bootstrap/dist/**", + "node_modules/simple-spellchecker/dict/*.dic" ], "extraFiles": [ { diff --git a/package.json b/package.json index 4e3e4211..a6baf4d1 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,8 @@ "url": "git://github.com/mattermost/desktop.git" }, "scripts": { - "postinstall": "install-app-deps", + "postinstall": "install-app-deps && npm run extract-dict", + "extract-dict": "cd src/node_modules/simple-spellchecker/dict && node ../../../../scripts/7zip-cli.js e -y '*.zip'", "build": "npm-run-all build:*", "build:main": "cross-env NODE_ENV=production webpack --bail --config webpack.config.main.js", "build:renderer": "cross-env NODE_ENV=production webpack --bail --config webpack.config.renderer.js", diff --git a/scripts/7zip-cli.js b/scripts/7zip-cli.js new file mode 100644 index 00000000..40d734d2 --- /dev/null +++ b/scripts/7zip-cli.js @@ -0,0 +1,13 @@ +/* eslint-disable no-process-exit */ + +const {spawn} = require('child_process'); +const {path7za} = require('7zip-bin'); + +spawn(path7za, process.argv.slice(2), { + stdio: 'inherit' +}).on('error', (err) => { + console.error(err); + process.exit(1); +}).on('close', (code) => { + process.exit(code); +}); diff --git a/src/browser/components/MainPage.jsx b/src/browser/components/MainPage.jsx index d0322dd8..a1d6bcf0 100644 --- a/src/browser/components/MainPage.jsx +++ b/src/browser/components/MainPage.jsx @@ -39,7 +39,9 @@ const MainPage = React.createClass({ onUnreadCountChange: React.PropTypes.func.isRequired, teams: React.PropTypes.array.isRequired, onTeamConfigChange: React.PropTypes.func.isRequired, - initialIndex: React.PropTypes.number.isRequired + initialIndex: React.PropTypes.number.isRequired, + useSpellChecker: React.PropTypes.bool.isRequired, + onSelectSpellCheckerLocale: React.PropTypes.func.isRequired }, getInitialState() { @@ -264,6 +266,8 @@ const MainPage = React.createClass({ key={id} id={id} withTab={this.props.teams.length > 1} + useSpellChecker={this.props.useSpellChecker} + onSelectSpellCheckerLocale={this.props.onSelectSpellCheckerLocale} src={team.url} name={team.name} onTargetURLChange={self.handleTargetURLChange} diff --git a/src/browser/components/MattermostView.jsx b/src/browser/components/MattermostView.jsx index 85c43424..667ac6d3 100644 --- a/src/browser/components/MattermostView.jsx +++ b/src/browser/components/MattermostView.jsx @@ -2,7 +2,7 @@ const React = require('react'); const {findDOMNode} = require('react-dom'); const {ipcRenderer, remote, shell} = require('electron'); const url = require('url'); -const electronContextMenu = require('electron-context-menu'); +const contextMenu = require('../js/contextMenu'); const ErrorView = require('./ErrorView.jsx'); @@ -16,7 +16,9 @@ const MattermostView = React.createClass({ onUnreadCountChange: React.PropTypes.func, src: React.PropTypes.string, active: React.PropTypes.bool, - withTab: React.PropTypes.bool + withTab: React.PropTypes.bool, + useSpellChecker: React.PropTypes.bool, + onSelectSpellCheckerLocale: React.PropTypes.func }, getInitialState() { @@ -79,8 +81,14 @@ const MattermostView = React.createClass({ // webview.openDevTools(); if (!this.state.isContextMenuAdded) { - electronContextMenu({ - window: webview + contextMenu.setup(webview, { + useSpellChecker: this.props.useSpellChecker, + onSelectSpellCheckerLocale: (locale) => { + if (this.props.onSelectSpellCheckerLocale) { + this.props.onSelectSpellCheckerLocale(locale); + } + webview.send('set-spellcheker'); + } }); this.setState({isContextMenuAdded: true}); } diff --git a/src/browser/components/SettingsPage.jsx b/src/browser/components/SettingsPage.jsx index 895c9a1f..f9307a97 100644 --- a/src/browser/components/SettingsPage.jsx +++ b/src/browser/components/SettingsPage.jsx @@ -112,7 +112,9 @@ const SettingsPage = React.createClass({ notifications: { flashWindow: this.state.notifications.flashWindow }, - showUnreadBadge: this.state.showUnreadBadge + showUnreadBadge: this.state.showUnreadBadge, + useSpellChecker: this.state.useSpellChecker, + spellCheckerLocale: this.state.spellCheckerLocale }; settings.writeFile(this.props.configFile, config, (err) => { @@ -209,6 +211,13 @@ const SettingsPage = React.createClass({ setImmediate(this.startSaveConfig); }, + handleChangeUseSpellChecker() { + this.setState({ + useSpellChecker: !this.refs.useSpellChecker.props.checked + }); + setImmediate(this.startSaveConfig); + }, + updateTeam(index, newData) { var teams = this.state.teams; teams[index] = newData; @@ -265,6 +274,21 @@ const SettingsPage = React.createClass({ ); } + options.push( + + {'Check spelling'} + + {'Highlight misspelled words in your messages.'} + {' Available for English, French, German, Spanish, and Dutch.'} + + ); + if (process.platform === 'darwin' || process.platform === 'win32') { const TASKBAR = process.platform === 'win32' ? 'taskbar' : 'Dock'; options.push( diff --git a/src/browser/index.jsx b/src/browser/index.jsx index 43e7aab1..c702f2ec 100644 --- a/src/browser/index.jsx +++ b/src/browser/index.jsx @@ -90,6 +90,13 @@ function teamConfigChange(teams) { ipcRenderer.send('update-config'); } +function handleSelectSpellCheckerLocale(locale) { + console.log(locale); + AppConfig.set('spellCheckerLocale', locale); + ipcRenderer.send('update-config'); + ipcRenderer.send('update-dict'); +} + const parsedURL = url.parse(window.location.href, true); const initialIndex = parsedURL.query.index ? parseInt(parsedURL.query.index, 10) : 0; @@ -99,6 +106,8 @@ ReactDOM.render( initialIndex={initialIndex} onUnreadCountChange={showUnreadBadge} onTeamConfigChange={teamConfigChange} + useSpellChecker={AppConfig.data.useSpellChecker} + onSelectSpellCheckerLocale={handleSelectSpellCheckerLocale} />, document.getElementById('content') ); diff --git a/src/browser/js/contextMenu.js b/src/browser/js/contextMenu.js new file mode 100644 index 00000000..bbdf78ac --- /dev/null +++ b/src/browser/js/contextMenu.js @@ -0,0 +1,67 @@ +const {ipcRenderer} = require('electron'); +const electronContextMenu = require('electron-context-menu'); + +function getSuggestionsMenus(win, suggestions) { + if (suggestions.length === 0) { + return [{ + label: 'No Suggestions', + enabled: false + }]; + } + return suggestions.map((s) => ({ + label: s, + click() { + (win.webContents || win.getWebContents()).replaceMisspelling(s); + } + })); +} + +function getSpellCheckerLocaleMenus(onSelectSpellCheckerLocale) { + const currentLocale = ipcRenderer.sendSync('get-spellchecker-locale'); + const locales = [ + {language: 'English', locale: 'en-US'}, + {language: 'French', locale: 'fr-FR'}, + {language: 'German', locale: 'de-DE'}, + {language: 'Spanish', locale: 'es-ES'}, + {language: 'Dutch', locale: 'nl-NL'} + ]; + return locales.map((l) => ({ + label: l.language, + type: 'checkbox', + checked: l.locale === currentLocale, + click() { + if (onSelectSpellCheckerLocale) { + onSelectSpellCheckerLocale(l.locale); + } + } + })); +} + +module.exports = { + setup(win, options) { + const defaultOptions = { + useSpellChecker: false, + onSelectSpellCheckerLocale: null + }; + const actualOptions = Object.assign({}, defaultOptions, options); + electronContextMenu({ + window: win, + prepend(params) { + if (actualOptions.useSpellChecker) { + const prependMenuItems = []; + if (params.isEditable && params.misspelledWord !== '') { + const suggestions = ipcRenderer.sendSync('get-spelling-suggestions', params.misspelledWord); + prependMenuItems.push(...getSuggestionsMenus(win, suggestions)); + } + if (params.isEditable) { + prependMenuItems.push( + {type: 'separator'}, + {label: 'Spelling Languages', submenu: getSpellCheckerLocaleMenus(actualOptions.onSelectSpellCheckerLocale)}); + } + return prependMenuItems; + } + return []; + } + }); + } +}; diff --git a/src/browser/settings.jsx b/src/browser/settings.jsx index 2fc71e63..ec1a9867 100644 --- a/src/browser/settings.jsx +++ b/src/browser/settings.jsx @@ -9,12 +9,11 @@ const {remote} = require('electron'); const React = require('react'); const ReactDOM = require('react-dom'); const SettingsPage = require('./components/SettingsPage.jsx'); +const contextMenu = require('./js/contextMenu'); const configFile = remote.app.getPath('userData') + '/config.json'; -require('electron-context-menu')({ - window: remote.getCurrentWindow() -}); +contextMenu.setup(remote.getCurrentWindow()); ReactDOM.render( , diff --git a/src/browser/webview/mattermost.js b/src/browser/webview/mattermost.js index 8eb0266c..24e7c4a0 100644 --- a/src/browser/webview/mattermost.js +++ b/src/browser/webview/mattermost.js @@ -2,6 +2,7 @@ const electron = require('electron'); const ipc = electron.ipcRenderer; +const webFrame = electron.webFrame; const notification = require('../js/notification'); Reflect.deleteProperty(global.Buffer); // http://electron.atom.io/docs/tutorial/security/#buffer-global @@ -146,3 +147,15 @@ notification.override({ ipc.sendToHost('onNotificationClick'); } }); + +function setSpellChecker() { + const spellCheckerLocale = ipc.sendSync('get-spellchecker-locale'); + webFrame.setSpellCheckProvider(spellCheckerLocale, false, { + spellCheck(text) { + const res = ipc.sendSync('checkspell', text); + return res === null ? true : res; + } + }); +} +setSpellChecker(); +ipc.on('set-spellcheker', setSpellChecker); diff --git a/src/common/settings.js b/src/common/settings.js index f19cfcae..18c47f8b 100644 --- a/src/common/settings.js +++ b/src/common/settings.js @@ -7,7 +7,7 @@ function merge(base, target) { return Object.assign({}, base, target); } -function loadDefault(version) { +function loadDefault(version, spellCheckerLocale) { var ver = version; if (version == null) { ver = settingsVersion; @@ -23,7 +23,9 @@ function loadDefault(version) { notifications: { flashWindow: 0 // 0 = flash never, 1 = only when idle (after 10 seconds), 2 = always }, - showUnreadBadge: true + showUnreadBadge: true, + useSpellChecker: false, + spellCheckerLocale: spellCheckerLocale || 'en-US' }; default: return {}; diff --git a/src/main.js b/src/main.js index d0f4a644..8defdd14 100644 --- a/src/main.js +++ b/src/main.js @@ -63,11 +63,14 @@ const appMenu = require('./main/menus/app'); const trayMenu = require('./main/menus/tray'); const allowProtocolDialog = require('./main/allowProtocolDialog'); +const SpellChecker = require('./main/SpellChecker'); + const assetsDir = path.resolve(app.getAppPath(), 'assets'); // Keep a global reference of the window object, if you don't, the window will // be closed automatically when the JavaScript object is garbage collected. var mainWindow = null; +let spellChecker = null; var argv = require('yargs').parse(process.argv.slice(1)); @@ -99,6 +102,7 @@ try { ipcMain.on('update-config', () => { const configFile = app.getPath('userData') + '/config.json'; config = settings.readFileSync(configFile); + ipcMain.emit('update-dict', true, config.spellCheckerLocale); }); // Only for OS X @@ -496,6 +500,37 @@ app.on('ready', () => { }); ipcMain.emit('update-menu', true, config); + ipcMain.on('update-dict', () => { + if (config.useSpellChecker) { + spellChecker = new SpellChecker( + config.spellCheckerLocale, + path.resolve(app.getAppPath(), 'node_modules/simple-spellchecker/dict'), + (err) => { + if (err) { + console.error(err); + } + }); + } + }); + ipcMain.on('checkspell', (event, word) => { + let res = null; + if (config.useSpellChecker && spellChecker.isReady() && word !== null) { + res = spellChecker.spellCheck(word); + } + event.returnValue = res; + }); + ipcMain.on('get-spelling-suggestions', (event, word) => { + if (config.useSpellChecker && spellChecker.isReady() && word !== null) { + event.returnValue = spellChecker.getSuggestions(word, 10); + } else { + event.returnValue = []; + } + }); + ipcMain.on('get-spellchecker-locale', (event) => { + event.returnValue = config.spellCheckerLocale; + }); + ipcMain.emit('update-dict'); + // Open the DevTools. // mainWindow.openDevTools(); }); diff --git a/src/main/SpellChecker.js b/src/main/SpellChecker.js new file mode 100644 index 00000000..cea93d4b --- /dev/null +++ b/src/main/SpellChecker.js @@ -0,0 +1,88 @@ +'use strict'; + +const simpleSpellChecker = require('simple-spellchecker'); + +/// Following approach for contractions is derived from electron-spellchecker. + +// NB: This is to work around electron/electron#1005, where contractions +// are incorrectly marked as spelling errors. This lets people get away with +// incorrectly spelled contracted words, but it's the best we can do for now. +const contractions = [ + "ain't", "aren't", "can't", "could've", "couldn't", "couldn't've", "didn't", "doesn't", "don't", "hadn't", + "hadn't've", "hasn't", "haven't", "he'd", "he'd've", "he'll", "he's", "how'd", "how'll", "how's", "I'd", + "I'd've", "I'll", "I'm", "I've", "isn't", "it'd", "it'd've", "it'll", "it's", "let's", "ma'am", "mightn't", + "mightn't've", "might've", "mustn't", "must've", "needn't", "not've", "o'clock", "shan't", "she'd", "she'd've", + "she'll", "she's", "should've", "shouldn't", "shouldn't've", "that'll", "that's", "there'd", "there'd've", + "there're", "there's", "they'd", "they'd've", "they'll", "they're", "they've", "wasn't", "we'd", "we'd've", + "we'll", "we're", "we've", "weren't", "what'll", "what're", "what's", "what've", "when's", "where'd", + "where's", "where've", "who'd", "who'll", "who're", "who's", "who've", "why'll", "why're", "why's", "won't", + "would've", "wouldn't", "wouldn't've", "y'all", "y'all'd've", "you'd", "you'd've", "you'll", "you're", "you've" +]; + +const contractionMap = contractions.reduce((acc, word) => { + acc[word.replace(/'.*/, '')] = true; + return acc; +}, {}); + +/// End: derived from electron-spellchecker. + +class SpellChecker { + constructor(locale, dictDir, callback) { + this.dict = null; + this.locale = locale; + simpleSpellChecker.getDictionary(locale, dictDir, (err, dict) => { + if (err) { + if (callback) { + callback(err); + } + } else { + this.dict = dict; + if (callback) { + callback(null, this); + } + } + }); + } + + isReady() { + return this.dict !== null; + } + + spellCheck(word) { + if (word.toLowerCase() === 'mattermost') { + return true; + } + if (isFinite(word)) { // Numerals are not included in the dictionary + return true; + } + if (this.locale.match(/^en-?/) && contractionMap[word]) { + return true; + } + return this.dict.spellCheck(word); + } + + getSuggestions(word, maxSuggestions) { + return this.dict.getSuggestions(word, maxSuggestions); + } +} + +SpellChecker.getSpellCheckerLocale = (electronLocale) => { + if (electronLocale.match(/^en-?/)) { + return 'en-US'; + } + if (electronLocale.match(/^fr-?/)) { + return 'fr-FR'; + } + if (electronLocale.match(/^de-?/)) { + return 'de-DE'; + } + if (electronLocale.match(/^es-?/)) { + return 'es-ES'; + } + if (electronLocale.match(/^nl-?/)) { + return 'nl-NL'; + } + return 'en-US'; +}; + +module.exports = SpellChecker; diff --git a/src/package.json b/src/package.json index 9682da18..0b2e3c0c 100644 --- a/src/package.json +++ b/src/package.json @@ -22,6 +22,7 @@ "react-addons-css-transition-group": "^15.4.2", "react-bootstrap": "~0.30.7", "react-dom": "^15.4.2", + "simple-spellchecker": "git://github.com/jfmdev/simple-spellchecker.git#723062952a0290c6285aeaf02f14d9c74c41cadb", "underscore": "^1.8.3", "yargs": "^3.32.0" } diff --git a/test/.eslintrc.json b/test/.eslintrc.json index 836966a6..72980a57 100644 --- a/test/.eslintrc.json +++ b/test/.eslintrc.json @@ -6,9 +6,11 @@ "open_window": true }, "rules": { + "func-names": 0, "global-require": 0, "max-nested-callbacks": 0, "no-eval": 0, - "no-magic-numbers": 0 + "no-magic-numbers": 0, + "prefer-arrow-callback": 0 } } diff --git a/test/specs/browser/settings_test.js b/test/specs/browser/settings_test.js index 10278373..ddbba9bb 100644 --- a/test/specs/browser/settings_test.js +++ b/test/specs/browser/settings_test.js @@ -200,6 +200,22 @@ describe('browser/settings.html', function desc() { isExisting('#inputShowUnreadBadge').then((existing) => existing.should.equal(expected)); }); }); + + describe('Check spelling', () => { + it('should appear and be selectable', () => { + env.addClientCommands(this.app.client); + return this.app.client. + loadSettingsPage(). + isExisting('#inputSpellChecker').then((existing) => existing.should.equal(true)). + scroll('#inputSpellChecker'). + click('#inputSpellChecker'). + pause(700). + then(() => { + const config1 = JSON.parse(fs.readFileSync(env.configFilePath, 'utf-8')); + config1.useSpellChecker.should.equal(true); + }); + }); + }); }); describe('RemoveServerModal', () => { diff --git a/test/specs/spellchecker_test.js b/test/specs/spellchecker_test.js new file mode 100644 index 00000000..e653e88b --- /dev/null +++ b/test/specs/spellchecker_test.js @@ -0,0 +1,82 @@ +const SpellChecker = require('../../src/main/SpellChecker'); +const path = require('path'); + +describe('main/Spellchecker.js', function() { + describe('en-US', function() { + let spellchecker = null; + + before(function(done) { + spellchecker = new SpellChecker( + 'en-US', + path.resolve(__dirname, '../../src/node_modules/simple-spellchecker/dict'), + done + ); + }); + + it('should spellcheck', function() { + // https://github.com/jfmdev/simple-spellchecker/issues/3 + spellchecker.spellCheck('spell').should.equal(true); + spellchecker.spellCheck('spel').should.equal(false); + spellchecker.spellCheck('December').should.equal(true); + spellchecker.spellCheck('december').should.equal(true); + spellchecker.spellCheck('English').should.equal(true); + spellchecker.spellCheck('Japan').should.equal(true); + }); + + it('should allow contractions', function() { + spellchecker.spellCheck("shouldn't").should.equal(true); + spellchecker.spellCheck('shouldn').should.equal(true); + }); + + it('should allow numerals', function() { + spellchecker.spellCheck('1').should.equal(true); + spellchecker.spellCheck('-100').should.equal(true); + spellchecker.spellCheck('3.14').should.equal(true); + }); + + it('should allow "Mattermost"', function() { + spellchecker.spellCheck('Mattermost').should.equal(true); + spellchecker.spellCheck('mattermost').should.equal(true); + }); + }); + + describe('en-GB', function() { + let spellchecker = null; + + before(function(done) { + spellchecker = new SpellChecker( + 'en-GB', + path.resolve(__dirname, '../../src/node_modules/simple-spellchecker/dict'), + done + ); + }); + + it('should allow contractions', function() { + spellchecker.spellCheck("shouldn't").should.equal(true); + spellchecker.spellCheck('shouldn').should.equal(true); + }); + }); + + describe('de-DE', function() { + let spellchecker = null; + + before(function(done) { + spellchecker = new SpellChecker( + 'de-DE', + path.resolve(__dirname, '../../src/node_modules/simple-spellchecker/dict'), + done + ); + }); + + it('should spellcheck', function() { + spellchecker.spellCheck('Guten').should.equal(true); + spellchecker.spellCheck('tag').should.equal(true); + }); + + it('should allow numerals', function() { + spellchecker.spellCheck('1').should.equal(true); + spellchecker.spellCheck('-100').should.equal(true); + spellchecker.spellCheck('3.14').should.equal(true); + }); + }); +});