wrapped.vim/README.md
Ari Archer 4cf3c7db41
Add a note to readme
Signed-off-by: Ari Archer <ari@ari.lt>
2024-12-23 19:25:59 +02:00

1.6 KiB

Wrapped.vim

Vim in a pod - your year in Vim!

I made this plugin mainly as a novelty being inspired by various [dev tool]-wrapped like Git(Hub)-wrapped. Expect bugs, it's new. Just a google little thing :)

Note that this does not import any old data. It collects its own data in its own database. You can try to make something work with viminfo files, so if you do, feel free to make a PR!

Preview

Expand for a preview

A screenshot of wrapped.vim

Contributing

Contributions are very welcome! Feel free to send patches through email:

  • Arija A. <ari+wrapped.vim@ari.lt>

Or through https://git.ari.lt/ari/wrapped.vim

Requirements

  • Python3-capable Vim
  • WAL-capable SQLite3

Installation

  • VimPlug: Plug 'https://git.ari.lt/ari/wrapped.vim'
  • Vundle: Plugin 'https://git.ari.lt/ari/wrapped.vim'
  • Pathogen: git clone https://git.ari.lt/ari/wrapped.vim ~/.vim/bundle/wrapped
  • Packer: use 'https://git.ari.lt/ari/wrapped.vim'

Configuration

  • let g:wrapped_ignore_globs = []: A list of globs to ignore files. For example, ['/tmp/*', '*.env'].
  • let g:wrapped_ignore_langs = ['wrapped', 'tmp', 'bak', 'log', 'undotree']: A list of filetypes to ignore.
  • let g:wrapped_ignore_cmds = ['w', 'write!', ...]: A list of commands to ignore.

Commands

  • :WrappedDeleteAllData - Deletes all data from the wrapped.vim database.
    • This doesn't remove the database file at ~/.vim/wrapped.db, but rather just runs an SQL query to purge the database.
  • :WrappedVim - Generates your wrapped report.