Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/preservim/vim-wordchipper

Power tool for shredding text in Insert mode
https://github.com/preservim/vim-wordchipper

markdown prose vim vim-plugin writing

Last synced: 3 months ago
JSON representation

Power tool for shredding text in Insert mode

Awesome Lists containing this project

README 

        
# vim-wordchipper



> Power tool for shredding text in *Insert* mode



# Features



* Conveniently delete words (and other text objects) while in *Insert* mode

* Automatically forces a format on current paragraph when Vim’s autoformat

  is active

* Useful with writing plugins like [vim-pencil][pn] and when composing

  code comments

* Pure Vimscript with no dependencies



# Introduction



Though Vim’s *Insert* mode is typically used for entering new text, it

nevertheless offers a limited capability to delete existing text with

single keystrokes:



| Key                | Description

| ------------------ | -------------------------------------------------

| ` or `    | Delete the character before the cursor

| ``            | Delete the character under the cursor

| ``            | Delete the word before the cursor

| ``            | Delete all characters before the cursor in the current line



In addition, with `Ctrl-o` you can execute a command, which will then

return to *Insert* mode. For example `dw` can delete the word after

the cursor.



For more details, see:



```vim

:help ins-special-keys

```



This plugin can extend that capability, such as to delete the word _after_

the cursor with a single keystroke.



## Installation



Install this plugin using your favorite Vim package manager.



## Configuration



No keys are mapped by default. You must define the behavior of this plugin

in your `.vimrc`.



For example, to re-map the `Ctrl-E` key to delete to the end of the next

_word_:



```vim

inoremap   wordchipper#chipWith('de')

```



where `de` deletes text forward to the end of the next _word_, preserving

any trailing space. (As an alternative, `dw` would consume the trailing

space.)



By default, `Ctrl-W` will delete the _word_ before the cursor. You can

change this behavior to work with _WORDS_ instead (i.e., including

punctuation):



```vim

inoremap   wordchipper#chipWith('dB')

```



where `dB` deletes backwards to the end of the previous _WORD_.



_wordchipper_ also can work with motions against non-word text objects,

such as remapping `Ctrl-y` to delete to the end of the sentence:



```vim

inoremap   wordchipper#chipWith('d)')

```



This will use Vim’s default sentence text object, or an alternative like

[vim-textobj-sentence][ts] if installed.



### Buffer-local mappings



You can also specify buffer-local mappings, such as initialized only for

the Markdown and text file types...



```vim

augroup wordchipper

  autocmd!

  autocmd FileType markdown,mkd,text

      \   inoremap    wordchipper#chipWith('de')

      \ | inoremap    wordchipper#chipWith('dB')

      \ | inoremap    wordchipper#chipWith('d)')

augroup END

```



### Word motions



Vim’s standard word motions are available:



* `e` - forward to the end of _word_, inclusive

* `E` - forward to the end of _WORD_, inclusive

* `w` - _word_ forward, exclusive

* `W` - _WORD_ forward, exclusive

* `ge` - backward to the end of _word_, inclusive

* `gE` - backward to the end of _WORD_, inclusive

* `b` - _word_ backward, exclusive

* `B` - _WORD_ backward, exclusive



‘_word_’ is defined by `iskeyword` option, and generally consists of

letters, digits, and underscores. ‘_WORD_’ generally consists of non-blank

characters, including punctuation. For more details, consult the

documentation:



```vim

:help word-motions

```



## Recommended settings



In your `.vimrc`, ensure backspace can consume whatever is in its way:



```vim

set backspace=indent,eol,start

```



For more details, see:



```vim

:help 'backspace'

```



## Prevent autoformat



If Vim’s autoformat is active during the *Insert*, such as when using

_HardPencil_ mode in the _pencil_ plugin, _wordchipper_ will force

a format to the end of the paragraph when invoked. (Without _wordchipper_

there would be no force of a format when deleting text, despite autoformat

being active.)



You can disable the forced format in your `.vimrc` with



```vim

let g:wordchipper#autoformat = 0    " default is 1

```



## See also



If you find this plugin useful, check out these others originally by

[@reedes][re]:



* [vim-pencil][pn] - Rethinking Vim as a tool for writers

* [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-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-wordy][wo] - uncovering usage problems in writing

* [vim-wheel][wh] - screen anchored cursor movement



[re]: https://github.com/reedes

[cp]: https://github.com/preservim/vim-colors-pencil

[pn]: https://github.com/preservim/vim-pencil

[lx]: https://github.com/preservim/vim-lexical

[lc]: https://github.com/preservim/vim-litecorrect

[qu]: https://github.com/preservim/vim-textobj-quote

[ts]: https://github.com/preservim/vim-textobj-sentence

[th]: https://github.com/preservim/vim-thematic

[wo]: https://github.com/preservim/vim-wordy

[wh]: https://github.com/preservim/vim-wheel



## Future development



If you’ve spotted a problem or have an idea on improving this plugin,

please post it to the [GitHub project issue page][issues].



[issues]: https://github.com/preservim/vim-wordchipper/issues