https://github.com/davidbeckingsale/writegood.vim

Vim plugin for Matt Might's '3 shell scripts that can improve your writing'
https://github.com/davidbeckingsale/writegood.vim

Last synced: 28 days ago
JSON representation

Vim plugin for Matt Might's '3 shell scripts that can improve your writing'

• Host: GitHub
• URL: https://github.com/davidbeckingsale/writegood.vim
• Owner: davidbeckingsale
• Created: 2012-04-22T19:41:06.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-05-31T23:16:16.000Z (over 6 years ago)
• Last Synced: 2024-08-02T05:13:24.316Z (3 months ago)
• Language: Vim script
• Size: 110 KB
• Stars: 83
• Watchers: 4
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• writingvim - writegood

README

        
# Writegood.vim

Writegood is a plugin to highlight common writing problems.

The plugin uses the `Error` group to highlight errors, so I assume it will work

on both gvim and terminal vim.

## Features

* Detects duplicate words (even over newlines)

* Highlights use of passive voice

* Highlights common "weasel words" 

## Screenshot

![Writegood mode in action](https://github.com/davidbeckingsale/writegood.vim/raw/master/writegood.png)

## About

After reading Matt Might's blog post about a year ago, I was thrilled when I

came across Benjamin Beckwith's writegood mode for Emacs, my editor of choice at

the time. However, people change, and after jumping on the vim bandwagon about

six months ago I forgot about both the plugin and Matt's post.

Eventually I found myself in the position to be doing some academic writing

again, and was frustrutated when I couldn't find a similar plugin for vim, so

after reading Steve Losh's 'Learn Vimscript the Hard Way' I decided to write one

for myself.

### Installation

*  [Pathogen](https://github.com/tpope/vim-pathogen)

  * `git clone https://github.com/davidbeckingsale/writegood.vim ~/.vim/bundle/writegood.vim`

*  [vim-plug](https://github.com/junegunn/vim-plug)

  * `Plug 'davidbeckingsale/writegood.vim'`

*  [NeoBundle](https://github.com/Shougo/neobundle.vim)

  * `NeoBundle 'davidbeckingsale/writegood.vim'`

*  [Vundle](https://github.com/gmarik/vundle)

  * `Plugin 'davidbeckingsale/writegood.vim'`

*  [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages)

  * `git clone https://github.com/davidbeckingsale/writegood.vim ~/.vim/pack/plugins/start/writegood.vim`

### Usage

Writegood.vim introduces three commands to enable, disable, or toggle its functionality:

* `:WritegoodEnable`

* `:WritegoodDisable`

* `:WritegoodToggle`

### Links

* Matt Might's original [blog post](http://matt.might.net/articles/shell-scripts-for-passive-voice-weasel-words-duplicates/)

* Benjamin Beckwiths [emacs minor-mode](https://github.com/bnbeckwith/writegood-mode)

* Steve Losh's [Learn Vimscript the Hard Way](http://learnvimscriptthehardway.stevelosh.com/)

* Nate Kane's [vim-indent-guides](https://github.com/nathanaelkane/vim-indent-guides)

### Credits

* Matt Might for writing the original scripts.

* Benjamin Beckwith for the emacs mode and catchy title I've borrowed.

* Steve Losh for 'Learn Vimscript the Hard Way'.

* Nathaniel Kane for the vim-indent-guides plugin, which I used as a

    reference for structuring and documentation.

    

### Contact  

* Twitter: @dabeckingsale

If anyone has any suggestions for improving my dodgy match usage, it would be

much appreciated.