Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/wakatime/vim-wakatime

Vim plugin for automatic time tracking and metrics generated from your programming activity.
https://github.com/wakatime/vim-wakatime

time-tracking vim vim-plugins vundle

Last synced: 4 days ago
JSON representation

Vim plugin for automatic time tracking and metrics generated from your programming activity.

Host: GitHub
URL: https://github.com/wakatime/vim-wakatime
Owner: wakatime
License: bsd-3-clause
Created: 2013-06-25T07:55:27.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2024-04-11T07:43:48.000Z (7 months ago)
Last Synced: 2024-04-13T20:58:00.527Z (7 months ago)
Topics: time-tracking, vim, vim-plugins, vundle
Language: Vim Script
Homepage: https://wakatime.com/vim
Size: 6.12 MB
Stars: 990
Watchers: 12
Forks: 70
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.rst
- License: LICENSE.txt
- Authors: AUTHORS

Awesome Lists containing this project

README

        # vim-wakatime

[![Vim](https://wakatime.com/static/img/Vim-supported-brightgreen.svg)](https://github.com/wakatime/vim-wakatime#installation)

[![Neovim](https://wakatime.com/static/img/Neovim-supported-brightgreen.svg)](https://github.com/wakatime/vim-wakatime#installation)

[![MacVim](https://wakatime.com/static/img/MacVim-supported-brightgreen.svg)](https://github.com/wakatime/vim-wakatime#installation)

[![gVim](https://wakatime.com/static/img/gVim-supported-brightgreen.svg)](https://github.com/wakatime/vim-wakatime#installation)

[![Coding time tracker](https://wakatime.com/badge/github/wakatime/vim-wakatime.svg)](https://wakatime.com/badge/github/wakatime/vim-wakatime)

[WakaTime][wakatime] is an open source Vim plugin for metrics, insights, and time tracking automatically generated from your programming activity.

## Installation

1. With [Vundle](https://github.com/gmarik/vundle): `echo "Plugin 'wakatime/vim-wakatime'" >> ~/.vimrc && vim +PluginInstall`

   Or with [Pathogen](https://github.com/tpope/vim-pathogen): `cd ~/.vim/bundle && git clone https://github.com/wakatime/vim-wakatime.git`

   Or with [Vim-plug](https://github.com/junegunn/vim-plug):  add `Plug 'wakatime/vim-wakatime'` to .vimrc file. While in vim reload .vimrc with `:so ~/.vimrc` or restart vim, enter

    `:PlugInstall`

   Or with [Packer](https://github.com/wbthomason/packer.nvim): add `use 'wakatime/vim-wakatime'` to your plugins file.

   Or with [Vim 8+](https://www.vim.org/): `mkdir -p ~/.vim/pack/plugins/start && cd ~/.vim/pack/plugins/start && git clone https://github.com/wakatime/vim-wakatime.git`

   Or with [Lazy.nvim](https://github.com/folke/lazy.nvim.git): add to your plugins file.

   ```lua

   { 'wakatime/vim-wakatime', lazy = false }

   ```

3. Restart Vim.

4. If this is the first WakaTime plugin on your machine, type `:WakaTimeApiKey` inside Vim.

5. Enter your [API Key](https://wakatime.com/api-key), then press `enter`.

6. Use Vim and your coding activity will be displayed on your [WakaTime dashboard](https://wakatime.com).

## Screen Shots

![Project Overview](https://wakatime.com/static/img/ScreenShots/Screen-Shot-2016-03-21.png)

## Commands

* `:WakaTimeApiKey` - set or change the api key saved in your `~/.wakatime.cfg`

* `:WakaTimeDebugEnable` - enable debug mode (may slow down Vim so disable when finished debugging)

* `:WakaTimeDebugDisable` - disable debug mode

* `:WakaTimeScreenRedrawEnable` - enable screen redraw to prevent artifacts (only for Vim < 8.0)

* `:WakaTimeScreenRedrawEnableAuto` - redraw screen when plugin takes too long (only for Vim < 8.0)

* `:WakaTimeScreenRedrawDisable` - disable screen redraw

* `:WakaTimeToday` - echo your total coding activity for Today

The vim-wakatime plugin automatically downloads and updates [wakatime-cli][wakatime-cli] in your `$WAKATIME_HOME/.wakatime/` folder.

WakaTime plugins also share a common [$WAKATIME_HOME/.wakatime.cfg config file][wakatime-cli-config].

`$WAKATIME_HOME` defaults to your `$HOME` folder.

## Troubleshooting

Run `:WakaTimeDebugEnable` in Vim then run this Terminal command:

`tail -f ~/.wakatime/wakatime.log`

Enabling Debug Mode writes Vim Script errors to your Vim Status Bar and tells [wakatime-cli][wakatime-cli] to write verbose logs to `$WAKATIME_HOME/.wakatime/wakatime.log`.

Debug mode can make it hard to find the real error because of all the extra logging, so also try disabling Debug Mode while tailing `~/.wakatime/wakatime.log` and editing files in Vim.

With Debug Mode enabled, the plugin sends data synchronously so disable it when finished debugging with `:WakaTimeDebugDisable`.

The [How to Debug Plugins][how to debug] guide shows how to check when coding activity was last received from Vim use the [User Agents API][user agents api].

For more general troubleshooting info, see the [wakatime-cli Troubleshooting Section][wakatime-cli-help].

## Uninstalling

1. Remove `Plugin 'wakatime/vim-wakatime'` from your `.vimrc` file.

2. Run in terminal: `rm ~/.wakatime.*`.

3. Run in terminal: `vim +PluginClean`.

**_If using vim-plug_**

_While in vim_

1. Delete or comment out `Plug` command from .vimrc file.

2. Reload vimrc (`:so ~/.vimrc`) or restart vim

3. Run `:PlugClean`, it will detect and remove undeclared plugins.

[wakatime]: https://wakatime.com/vim

[wakatime-cli]: https://github.com/wakatime/wakatime-cli

[wakatime-cli-config]: https://github.com/wakatime/wakatime-cli/blob/develop/USAGE.md#ini-config-file

[wakatime-cli-help]: https://github.com/wakatime/wakatime#troubleshooting

[how to debug]: https://wakatime.com/faq#debug-plugins

[user agents api]: https://wakatime.com/developers#user_agents