m-vim_plugins/vim-pencil
1
0
Fork 0
mirror of https://github.com/preservim/vim-pencil.git synced 2025-11-16 22:03:39 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

clarified globals; protect other bufs from ve=onemore; misc improvements

Browse Source
This commit is contained in:
Reed Esau
2014-02-02 18:18:16 -07:00
parent daf4183a42
commit 5b57c3b06c
2 changed files with 55 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.markdown
View File

@@ -14,13 +14,15 @@ The _pencil_ plugin aspires to make Vim as powerful a tool for writers as
it is for coders by focusing narrowly on the handful of tweaks needed to it is for coders by focusing narrowly on the handful of tweaks needed to
smooth the path to writing prose. smooth the path to writing prose.
* For editing files in _text_, _markdown_, _textile_, and other prose-oriented file types * For editing files in _text_, _markdown_, _textile_, and other
prose-oriented file types
* Agnostic on soft line wrap _versus_ hard line breaks, supporting both * Agnostic on soft line wrap _versus_ hard line breaks, supporting both
* Auto-detects wrap mode via modeline and sampling * Auto-detects wrap mode via modeline and sampling
* Adjusts navigation key mappings to suit the wrap mode * Adjusts navigation key mappings to suit the wrap mode
* Creates undo points on common punctuation * Creates undo points on common punctuation
* When using hard line breaks, enables autoformat while inserting text * When using hard line breaks, enables autoformat while inserting text
* Buffer-scoped configuration (leaves your global settings alone) * Buffer-scoped configuration (with a few minor exceptions, _pencil_
preserves your global settings)
* Pure Vimscript with no dependencies * Pure Vimscript with no dependencies
Need spell-check and other features? Vim is about customization. To Need spell-check and other features? Vim is about customization. To
@@ -29,15 +31,15 @@ its rich ecosystem of plugins.
## Why use Vim for writing? ## Why use Vim for writing?
With plenty of word processing apps available, including those that With plenty of word processing applications available, including those
specifically cater to writers, why use a programmer’s editor like Vim for that specifically cater to writers, why use a programmer’s editor like Vim
writing? for writing?
There are good reasons NOT to use Vim for writing: There are good reasons NOT to use Vim for writing:
* Primitive in certain respects (no WYSIWYG or proportionally spaced * Primitive in certain respects (no WYSIWYG or proportionally spaced
characters, e.g.) characters, e.g.)
* A modal editor with a steep learning curve * A modal editor with a relatively steep learning curve
* Time and effort to configure to your needs * Time and effort to configure to your needs
But Vim offers a unique editing environment not matched by other writing But Vim offers a unique editing environment not matched by other writing
@@ -54,9 +56,9 @@ tools:
Install using Pathogen, Vundle, Neobundle, or your favorite Vim package Install using Pathogen, Vundle, Neobundle, or your favorite Vim package
manager. manager.
_For those new to Vim: before installing this plugin, you should first _For those new to Vim: before installing this plugin, consider getting
work through one of the many tutorials available to get comfortable with comfortable with the basics of Vim by working through one of the many
the basics of Vim._ tutorials available._
## Configuration ## Configuration
@@ -161,7 +163,7 @@ reformat paragraphs with standard Vim commands:
* `ggVGgq` or `:g/^/norm gqq` - format all paragraphs in buffer * `ggVGgq` or `:g/^/norm gqq` - format all paragraphs in buffer
* `:%norm vipJ` - unformat all paragraphs in buffer * `:%norm vipJ` - unformat all paragraphs in buffer
Optionally, you can map these sequences to underutilized keys in your Optionally, you can map these operations to underutilized keys in your
`.vimrc`: `.vimrc`:
```vim ```vim
@@ -221,8 +223,8 @@ At the bottom of this document is a odd-looking code:
<!-- vim: set tw=74 :--> <!-- vim: set tw=74 :-->
``` ```
This is an optional ‘modeline’ that tells Vim to run the following command This is an **optional** ‘modeline’ that tells Vim to run the following
upon loading the file into a buffer: command upon loading the file into a buffer:
```vim ```vim
:set textwidth=74 :set textwidth=74

67
autoload/pencil.vim
View File

@@ -78,7 +78,7 @@ function! pencil#init(...) abort
let l:wrap_arg = get(l:args, 'wrap', 'detect') let l:wrap_arg = get(l:args, 'wrap', 'detect')
if (b:wrap_mode && l:wrap_arg ==# 'toggle') || if (b:wrap_mode && l:wrap_arg ==# 'toggle') ||
\ l:wrap_arg =~# '^\(off\|disable\|false\)$' \ l:wrap_arg =~# '^\(0\|off\|disable\|false\)$'
let b:wrap_mode = s:WRAP_MODE_OFF let b:wrap_mode = s:WRAP_MODE_OFF
elseif l:wrap_arg ==# 'hard' elseif l:wrap_arg ==# 'hard'
let b:wrap_mode = s:WRAP_MODE_HARD let b:wrap_mode = s:WRAP_MODE_HARD
@@ -93,7 +93,7 @@ function! pencil#init(...) abort
" translate default(-1) to soft(1) or hard(2) or off(0) " translate default(-1) to soft(1) or hard(2) or off(0)
if b:wrap_mode == s:WRAP_MODE_DEFAULT if b:wrap_mode == s:WRAP_MODE_DEFAULT
if g:pencil#wrapModeDefault =~# '^\(off\|disable\|false\)$' if g:pencil#wrapModeDefault =~# '^\(0\|off\|disable\|false\)$'
let b:wrap_mode = s:WRAP_MODE_OFF let b:wrap_mode = s:WRAP_MODE_OFF
elseif g:pencil#wrapModeDefault ==# 'soft' elseif g:pencil#wrapModeDefault ==# 'soft'
let b:wrap_mode = s:WRAP_MODE_SOFT let b:wrap_mode = s:WRAP_MODE_SOFT
@@ -130,45 +130,48 @@ function! pencil#init(...) abort
setlocal colorcolumn< setlocal colorcolumn<
endif endif
" global settings
if b:wrap_mode if b:wrap_mode
setlocal autoindent " needed by fo=n set display+=lastline
setlocal nolist set backspace=indent,eol,start " via tpope/vim-sensible
setlocal wrapmargin=0 if g:pencil#joinspaces
setlocal display+=lastline set joinspaces " two spaces after .!?
setlocal formatoptions+=1 " don't break line before 1 letter word else
setlocal formatoptions+=t set nojoinspaces " only one space after a .!? (default)
setlocal formatoptions+=n " recognize numbered lists endif
if g:pencil#cursorwrap
setlocal whichwrap+=<,>,h,l,[,]
setlocal virtualedit+=onemore " could break other plugins
endif endif
" clean out stuff we likely don't want " because ve=onemore is relatively rare and could break
setlocal formatoptions-=2 " other plugins, restrict its presence to buffer
setlocal formatoptions-=v " Better: restore ve to original setting
if b:wrap_mode && g:pencil#cursorwrap
set whichwrap+=<,>,h,l,[,]
augroup pencil_cursorwrap
autocmd BufEnter <buffer> set virtualedit+=onemore
autocmd BufLeave <buffer> set virtualedit-=onemore
augroup END
else
silent! autocmd! pencil_cursorwrap * <buffer>
endif
" trailing whitespace continues paragraph " window/buffer settings
" makes autoformat behave oddly where spaces aren't present if b:wrap_mode
setlocal formatoptions-=w setlocal nolist
setlocal wrapmargin=0
setlocal autoindent " needed by formatoptions=n
setlocal formatoptions+=n " recognize numbered lists
setlocal formatoptions+=1 " don't break line before 1 letter word
setlocal formatoptions+=t " autoformat of text, but not comments
" clean out stuff we likely don't want
setlocal formatoptions-=2 " use indent of 2nd line for rest of paragraph
setlocal formatoptions-=v " only break line at blank entered during insert
setlocal formatoptions-=w " avoid erratic behavior if mixed spaces
else else
setlocal autoindent< noautoindent< setlocal autoindent< noautoindent<
setlocal list< nolist< setlocal list< nolist<
setlocal wrapmargin< setlocal wrapmargin<
setlocal display<
setlocal formatoptions< setlocal formatoptions<
setlocal whichwrap<
setlocal virtualedit<
endif
if b:wrap_mode
if g:pencil#joinspaces
setlocal joinspaces " two spaces after .!?
else
setlocal nojoinspaces " only one space after a .!? (default)
endif
else
setlocal joinspaces< nojoinspaces<
endif endif
if b:wrap_mode == s:WRAP_MODE_SOFT if b:wrap_mode == s:WRAP_MODE_SOFT