Proof-reading and grammar checker for English, French, German, Polish and 20+ other languages
Python
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
Default (Linux).sublime-keymap
Default (OSX).sublime-keymap
Default (Windows).sublime-keymap
LTServer.py
LanguageList.py
LanguageTool.py
LanguageTool.sublime-commands
LanguageTool.sublime-settings
README.md
demo.gif

README.md

Brief Summary

This is a simple adapter to integrate LanguageTool (an open source proof-reading program) into Sublime Text 2/3.

From https://www.languagetool.org/:

LanguageTool is an Open Source proof­reading program for English, French, German, Polish, and more than 20 other languages. It finds many errors that a simple spell checker cannot detect and several grammar problems.

Installation

If you're using Package Control then open up the command palette (ctrl+shift+p), type install, press Enter then type languagetool and press Enter again.

To get the latest updates before they get released, install via Package Control: Add Repository. This will update your plugin with new commits as they are being pushed to the repo.

Usage

Open the file you want to proof-read then:

  1. Run a language check (ctrl+shift+c). Any problems identified by LanguageTool will be highlighted.
  2. Move between the problems using alt+down (next) and alt+up (previous).
  3. A panel at the bottom will display a brief description of the highlighted problem and suggest corrections if available.
  4. Begin typing to correct the selected problem or press alt+shift+f to apply the suggested correction.
  5. To ignore a problem, press alt+d.
  6. Auto-correcting a problem or ignoring it will move focus to the next problem.

All commands and their keyboard shortcuts are in the command palette with the prefix LanguageTool:.

Server Configuration

The adapter POSTs the text to be checked to a LanguageTool server via https. There are two server settings (local and remote) that can be configured and one must be selected as default (although command palette variants of Check Text can be used to check text via a specific server).

The remote server is initially configured (in the file LanguageTool.sublime- settings) as https://languagetool.org:8081/. There are few limitations on checking texts using this public server including:

  1. Maximum text size of 50Kb
  2. Access limited to 20 requests/minute per IP

(See http://wiki.languagetool.org/public-http-api for full details.)

For better performance and to check texts without the above limitations you can download LanguageTool then run and configure the adapter to use your own LanguageTool server.

License

This plugin is freely available under GPLv2 or later.

Contributing

Feel free to fork and improve. All contributions are welcome.