duereg / sublime-write-gooder

Simple grammar checker for your documentation.

#WriteGooder for Sublime Text

Simple grammar checking for your documentation.

Prerequisites: write-gooder and Sublime Package Control

Mac OS X: Installing node with homebrew or macports is assumed. The path to write-gooder is hardcoded in this plugin as /usr/local/share/npm/bin:/usr/local/bin:/opt/local/bin. You can change the path to the executable in settings.

Linux: Make sure write-gooder is in your environment path.

Windows: Installing node with the Windows Installer from nodejs.org is assumed.

##Install write-gooder with npm

npm install -g duereg/write-gooder

##Install WriteGooder with Package Control in Sublime Text

1. command-shift-P or control-shift-P in Linux/Windows*
2. type install p, select Package Control: Install Package
3. type WriteGooder, select WriteGooder

Note: Without Sublime Package Control, you could manually copy this project to your Packages directory as 'WriteGooder'.

##Run WriteGooder on an active Markdown file in Sublime Text

• control-shift-W or Tools/Contextual menus or the Command Palette
• F4 jump to next error row/column
• shift-F4 jump to previous error row-column

##Settings

• Navigate to Preferences > Package Settings > WriteGooder > Settings - Default.
• To preserve custom settings:
  • copy default settings to Preferences > Package Settings > WriteGooder > Settings - User
  • change them to your requirements

##Run WriteGooder on save

By default, WriteGooder does not run on save. To change, update the setting run_on_save for the project to true.

sublime-write-gooder's Issues

Error,

It gives me the error

[Errno 2] No such file or directory: 'write-gooder'
[cmd: ['write-gooder', '/Users/me/Dropbox/adir/a second dir with spaces/translations.txt']]
[dir: /Users/me/dropbox/adir/a second dir with spaces]
[path: /usr/local/share/npm/bin:/usr/local/bin:/opt/local/bin:/opt/boxen/nodenv/shims:/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin]

every time.

Feature request: Ability to analyze only the selected portion of the file

I'm working with a large file (~1300 lines), and don't want the whole thing analyzed every time I'm revising a paragraph.

How to specify command line options?

I'd like to do the following: ,"write-gooder" : "write-gooder --no-readable"

Integratino with write-good?

write-gooder is listed as deprecated on npm and the suggestion is to use write-good. Is there a plan to revise this plugin accordingly?