mirror of
https://github.com/preservim/vim-wordy.git
synced 2025-11-17 14:23:40 -05:00
Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
590927f572 | ||
|
|
667426a017 | ||
|
|
f0391713fa | ||
|
|
87a77cb293 | ||
|
|
e80520718d | ||
|
|
4e097f5552 | ||
|
|
14b9dbf76a | ||
|
|
aa66dfff91 | ||
|
|
bd37684a04 | ||
|
|
a4dd6fdb05 | ||
|
|
ae7470797b | ||
|
|
6b37d5a8c9 | ||
|
|
5a8a149b3c | ||
|
|
05dd76aeeb | ||
|
|
86ab7f3d5b | ||
|
|
2d840bb5fe | ||
|
|
7d90faf657 | ||
|
|
324e08d11d | ||
|
|
bc6b75ad9a | ||
|
|
03680e115b | ||
|
|
210dd1077d | ||
|
|
71b1365e2a |
112
README.markdown
112
README.markdown
@@ -5,7 +5,7 @@
|
||||
<br/>
|
||||
|
||||
- - -
|
||||

|
||||

|
||||
- - -
|
||||
|
||||
## Features of the _wordy_ plugin
|
||||
@@ -16,6 +16,7 @@
|
||||
* Buffer-scoped configuration (leaves your global settings alone)
|
||||
* Unicode-friendly, including support for ‘typographic quotes’
|
||||
* User-configurable ring of dictionaries
|
||||
* *NEW* adjectives and adverbs, to help you detect overuse
|
||||
|
||||
## What is _wordy_?
|
||||
|
||||
@@ -42,8 +43,8 @@ be missed. To compensate for _wordy_’s bare-bones approach, it’s best used
|
||||
in concert with the [literature on usage][lit] (Strunk and White, e.g.)
|
||||
and websites like the [English Language & Usage Stack Exchange][ese].
|
||||
|
||||
[lit]: http://www.amazon.com/s/ref=nb_sb_noss_2?url=search-alias%3Dstripbooks&field-keywords=English+Usage
|
||||
[ese]: http://english.stackexchange.com
|
||||
[lit]: https://www.amazon.com/s/ref=nb_sb_noss_2?url=search-alias%3Dstripbooks&field-keywords=English+Usage
|
||||
[ese]: https://english.stackexchange.com
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -51,8 +52,15 @@ _wordy_ may require a recent version of Vim.
|
||||
|
||||
## Installation
|
||||
|
||||
Best installed using Pathogen, Vundle, Neobundle, or your favorite Vim
|
||||
package manager.
|
||||
You can install using your favorite Vim package manager. (E.g.,
|
||||
[Pathogen][pathogen], [Vundle][vundle], or [Plug][plug].) If you are using
|
||||
a recent version of vim or neovim, you can also use native package
|
||||
support. (See [:help packages][packages].)
|
||||
|
||||
[pathogen]: https://github.com/tpope/vim-pathogen
|
||||
[vundle]: https://github.com/VundleVim/Vundle.vim
|
||||
[plug]: https://github.com/junegunn/vim-plug
|
||||
[packages]: https://vimhelp.org/repeat.txt.html#packages
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -81,7 +89,7 @@ least until _wordy_ feels the urge to build again.
|
||||
Define your own ring of dictionaries, overriding the default one in your
|
||||
`.vimrc`:
|
||||
|
||||
```
|
||||
```vim
|
||||
let g:wordy#ring = [
|
||||
\ 'weak',
|
||||
\ ['being', 'passive-voice', ],
|
||||
@@ -92,12 +100,14 @@ let g:wordy#ring = [
|
||||
\ ['colloquial', 'idiomatic', 'similies', ],
|
||||
\ 'art-jargon',
|
||||
\ ['contractions', 'opinion', 'vague-time', 'said-synonyms', ],
|
||||
\ 'adjectives',
|
||||
\ 'adverbs',
|
||||
\ ]
|
||||
```
|
||||
|
||||
You can navigate the ring with the following commands:
|
||||
|
||||
```
|
||||
```vim
|
||||
:NextWordy
|
||||
:PrevWordy
|
||||
```
|
||||
@@ -105,23 +115,32 @@ You can navigate the ring with the following commands:
|
||||
Optionally map a key in your `.vimrc` to rapidly cycle through the
|
||||
ring's dictionaries:
|
||||
|
||||
```
|
||||
nnoremap <silent> K :NextWordy<cr>
|
||||
```vim
|
||||
noremap <silent> <F8> :<C-u>NextWordy<cr>
|
||||
xnoremap <silent> <F8> :<C-u>NextWordy<cr>
|
||||
inoremap <silent> <F8> <C-o>:NextWordy<cr>
|
||||
```
|
||||
|
||||
**NEW** - You can browse through a flattened list of dictionaries
|
||||
You can browse through a flattened list of dictionaries
|
||||
specified in your ring with:
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy <tab>
|
||||
```
|
||||
|
||||
and optionally map a key such as `\w` in your `.vimrc` to it by
|
||||
|
||||
```vim
|
||||
if !&wildcharm | set wildcharm=<C-z> | endif
|
||||
execute 'nnoremap <leader>w :Wordy<space>'.nr2char(&wildcharm)
|
||||
```
|
||||
|
||||
## Using _wordy_
|
||||
|
||||
You’ll use the commands that follow to enable _wordy_. To disable it and
|
||||
restore your previous spell environment, enter the command:
|
||||
|
||||
```
|
||||
```vim
|
||||
:NoWordy
|
||||
```
|
||||
|
||||
@@ -133,7 +152,7 @@ go to those words flagged by _wordy_.
|
||||
|
||||
### Weak and lazy usage
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy weak
|
||||
```
|
||||
|
||||
@@ -161,7 +180,7 @@ asking whether it detracts from the point you are trying to make.
|
||||
|
||||
### Redundant and problematic usage
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy redundant
|
||||
:Wordy problematic
|
||||
```
|
||||
@@ -178,7 +197,7 @@ will simply ‘protest’.
|
||||
See [50 Problem Words and Phrases][1] for more detail on those issues
|
||||
targeted by _problematic_.
|
||||
|
||||
[1]: http://www.dailywritingtips.com/50-problem-words-and-phrases/
|
||||
[1]: https://www.dailywritingtips.com/50-problem-words-and-phrases/
|
||||
|
||||
### Puffery and Jargon
|
||||
|
||||
@@ -186,7 +205,7 @@ targeted by _problematic_.
|
||||
> _self-actualization_ reflect his _dynamic_ and _transformative_
|
||||
> personality.” (puffery and jargon)
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy puffery
|
||||
:Wordy business-jargon
|
||||
:Wordy art-jargon
|
||||
@@ -200,7 +219,7 @@ Instead of puffery, demonstrate through details.
|
||||
|
||||
### Manipulative language
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy weasel
|
||||
```
|
||||
|
||||
@@ -217,7 +236,7 @@ will seek to purge such loaded language from your writing.
|
||||
|
||||
### To be and the passive voice
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy being
|
||||
:Wordy passive-voice
|
||||
```
|
||||
@@ -227,7 +246,7 @@ of the verb to be, often found in overly-passive sentences.
|
||||
|
||||
### Colloquialisms, Idioms, and Similies
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy colloquial
|
||||
:Wordy idiomatic
|
||||
:Wordy similies
|
||||
@@ -236,9 +255,18 @@ of the verb to be, often found in overly-passive sentences.
|
||||
Dictionaries for uncovering the tired cliché, including colloquial and
|
||||
idiomatic phrases scraped from Wiktionary and Wikipedia.
|
||||
|
||||
### Adjectives and Adverbs
|
||||
|
||||
```vim
|
||||
:Wordy adjectives
|
||||
:Wordy adverbs
|
||||
```
|
||||
|
||||
Dictionaries to help you detect the overuse of modifiers.
|
||||
|
||||
### Miscellaneous
|
||||
|
||||
```
|
||||
```vim
|
||||
:Wordy said-synonyms
|
||||
:Wordy opinion
|
||||
:Wordy contractions
|
||||
@@ -257,35 +285,45 @@ instances of “’s”, such as “Joe’s not here.”
|
||||
And finally, `vague-time` finds where you are using vague descriptions of
|
||||
time where you could be more specific.
|
||||
|
||||
## Configuration
|
||||
|
||||
Change where `vim-wordy` stores cached spelling files using:
|
||||
|
||||
```
|
||||
let g:wordy_spell_dir = '/home/my-user/wordy'
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
[Words To Avoid in Creative Writing][wa] - a brief guide to usage by writer Cary Morton
|
||||
* [danielbmarques/vim-ditto][vd] - new plugin to highlight repeated words
|
||||
* [Words To Avoid in Creative Writing][wa] - a brief guide to usage by writer Cary Morton
|
||||
|
||||
[wa]: http://darlingmionette.deviantart.com/art/Words-To-Avoid-152886782
|
||||
[vd]: https://github.com/danielbmarques/vim-ditto
|
||||
[wa]: https://darlingmionette.deviantart.com/art/Words-To-Avoid-152886782
|
||||
|
||||
If you find this plugin useful, you may want to check out these others by
|
||||
[@reedes][re]:
|
||||
If you find this plugin useful, you may want to check out these others
|
||||
originally by [@reedes][re]:
|
||||
|
||||
* [vim-colors-pencil][cp] - color scheme for Vim inspired by IA Writer
|
||||
* [vim-lexical][lx] - building on Vim’s spell-check and thesaurus/dictionary completion
|
||||
* [vim-litecorrect][lc] - lightweight auto-correction for Vim
|
||||
* [vim-one][vo] - make use of Vim’s _+clientserver_ capabilities
|
||||
* [vim-pencil][pn] - rethinking Vim as a tool for writers
|
||||
* [vim-textobj-quote][qu] - extends Vim to support typographic (‘curly’) quotes
|
||||
* [vim-textobj-sentence][ts] - improving on Vim's native sentence motion command
|
||||
* [vim-thematic][th] - modify Vim’s appearance to suit your task and environment
|
||||
* [vim-wheel][wh] - screen-anchored cursor movement for Vim
|
||||
* [vim-wordchipper][wc] - power tool for shredding text in Insert mode
|
||||
|
||||
[re]: https://github.com/reedes
|
||||
[cp]: http://github.com/reedes/vim-colors-pencil
|
||||
[lx]: http://github.com/reedes/vim-lexical
|
||||
[lc]: http://github.com/reedes/vim-litecorrect
|
||||
[vo]: http://github.com/reedes/vim-one
|
||||
[pn]: http://github.com/reedes/vim-pencil
|
||||
[ts]: http://github.com/reedes/vim-textobj-sentence
|
||||
[qu]: http://github.com/reedes/vim-textobj-quote
|
||||
[th]: http://github.com/reedes/vim-thematic
|
||||
[wh]: http://github.com/reedes/vim-wheel
|
||||
[cp]: https://github.com/preservim/vim-colors-pencil
|
||||
[lx]: https://github.com/preservim/vim-lexical
|
||||
[lc]: https://github.com/preservim/vim-litecorrect
|
||||
[pn]: https://github.com/preservim/vim-pencil
|
||||
[ts]: https://github.com/preservim/vim-textobj-sentence
|
||||
[qu]: https://github.com/preservim/vim-textobj-quote
|
||||
[th]: https://github.com/preservim/vim-thematic
|
||||
[wh]: https://github.com/preservim/vim-wheel
|
||||
[wc]: https://github.com/preservim/vim-wordchipper
|
||||
|
||||
## Future development
|
||||
|
||||
@@ -294,7 +332,9 @@ Support for other languages will be added if there’s interest. (Hint: pull
|
||||
requests!)
|
||||
|
||||
_wordy_ is a work in progress. If you’ve spotted a problem or have an idea
|
||||
on improving this plugin, please post it to the github project issue page.
|
||||
Contributions are welcome.
|
||||
on improving this plugin, please post it to the [GitHub project issue
|
||||
page][issues]. Contributions are welcome.
|
||||
|
||||
[issues]: https://github.com/preservim/vim-wordy/issues
|
||||
|
||||
<!-- vim: set tw=74 :-->
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
" ============================================================================
|
||||
" File: autoload/wordy.vim
|
||||
" Description: autoload script for vim-wordy plugin
|
||||
" Maintainer: Reed Esau <github.com/reedes>
|
||||
" Maintainer: preservim <https://github.com/preservim>
|
||||
" Last Change: January 14, 2014
|
||||
" License: The MIT License (MIT)
|
||||
" ============================================================================
|
||||
@@ -33,11 +33,24 @@ function! wordy#init(...) abort
|
||||
let l:data_dir = g:wordy_dir . '/data'
|
||||
let l:src_path = l:data_dir . '/' . l:lang . '/' . l:dict . '.dic'
|
||||
if filereadable(l:src_path)
|
||||
let l:spell_dir = g:wordy_dir . '/spell'
|
||||
if has('nvim')
|
||||
let l:rare_path = l:src_path . '.rare'
|
||||
if !filereadable(l:rare_path) ||
|
||||
\ getftime(l:rare_path) < getftime(l:src_path)
|
||||
" Dynamically convert SpellBad words into SpellRare words under NeoVim.
|
||||
" See issue 15 for details: https://github.com/reedes/vim-wordy/pull/15
|
||||
let l:rare_dic = map(readfile(l:src_path), "substitute(v:val, '!$', '?', '')")
|
||||
call writefile(l:rare_dic, l:rare_path)
|
||||
endif
|
||||
let l:src_path = l:rare_path
|
||||
endif
|
||||
|
||||
let l:spell_dir = g:wordy_spell_dir . '/spell'
|
||||
if !isdirectory(l:spell_dir)
|
||||
call mkdir(expand(l:spell_dir), "p")
|
||||
endif
|
||||
let l:dst_path = l:spell_dir . '/' . l:dict . '.' . l:lang . '.' . l:encoding . '.spl'
|
||||
" The dict name is the 'language' part of the filename
|
||||
let l:dst_path = l:spell_dir . '/' . l:dict . '.' . l:encoding . '.spl'
|
||||
if get(l:args, 'force', 0) ||
|
||||
\ !filereadable(l:dst_path) ||
|
||||
\ getftime(l:dst_path) < getftime(l:src_path)
|
||||
@@ -57,7 +70,9 @@ function! wordy#init(...) abort
|
||||
let l:prefix = 'wordy: '
|
||||
if len(l:dst_paths) > 0
|
||||
let b:original_spl = &spelllang
|
||||
exe 'setlocal spelllang=' . l:lang . ',' . join(l:dst_paths, ',')
|
||||
" vim looks up the files in the ./spell/ directory using spell-load (see
|
||||
" the vim docs) so full paths are not allowed.
|
||||
exe 'setlocal spelllang=' . l:lang . ',' . join(l:dicts, ',')
|
||||
setlocal spell
|
||||
|
||||
" the magic numbers derived empirically with MacVim
|
||||
|
||||
3383
data/en/adjectives.dic
Normal file
3383
data/en/adjectives.dic
Normal file
File diff suppressed because it is too large
Load Diff
4090
data/en/adverbs.dic
Normal file
4090
data/en/adverbs.dic
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,7 @@
|
||||
" =============================================================================
|
||||
" File: plugin/wordy.vim
|
||||
" Description: Usage support for the Vim text editor
|
||||
" Maintainer: Reed Esau <github.com/reedes>
|
||||
" Maintainer: preservim <https://github.com/preservim>
|
||||
" Last Change: January 14, 2014
|
||||
" License: The MIT License (MIT)
|
||||
" =============================================================================
|
||||
@@ -16,6 +16,10 @@ set cpo&vim
|
||||
" need directory to manage spell files
|
||||
let g:wordy_dir = fnamemodify(resolve(expand('<sfile>:p')), ':h:h')
|
||||
|
||||
if !exists('g:wordy_spell_dir')
|
||||
let g:wordy_spell_dir = g:wordy_dir
|
||||
endif
|
||||
|
||||
command -nargs=0 NoWordy call wordy#init({})
|
||||
|
||||
command -nargs=0 NextWordy call wordy#jump(1)
|
||||
@@ -35,6 +39,8 @@ if !exists('g:wordy#ring')
|
||||
\ ['colloquial', 'idiomatic', 'similies', ],
|
||||
\ 'art-jargon',
|
||||
\ ['contractions', 'opinion', 'vague-time', 'said-synonyms', ],
|
||||
\ 'adjectives',
|
||||
\ 'adverbs',
|
||||
\ ]
|
||||
endif
|
||||
|
||||
|
||||
Reference in New Issue
Block a user