vim-rana/README.md

89 lines
3.2 KiB
Markdown
Raw Normal View History

2013-07-10 07:05:24 +00:00
vim-wakatime
============
2013-06-25 07:57:15 +00:00
2015-09-26 18:44:19 +00:00
Quantify your coding inside Vim.
2013-06-25 07:57:15 +00:00
2013-06-25 07:57:15 +00:00
Installation
------------
2014-11-07 23:59:24 +00:00
1. Install [Vundle](https://github.com/gmarik/vundle), the Vim plugin manager.
2013-06-25 07:57:15 +00:00
2014-11-07 23:59:24 +00:00
2. Using [Vundle](https://github.com/gmarik/vundle):<br />
`echo "Bundle 'wakatime/vim-wakatime'" >> ~/.vimrc && vim +BundleInstall`
2013-06-26 00:54:01 +00:00
2014-07-20 19:07:04 +00:00
or using [Pathogen](https://github.com/tpope/vim-pathogen):<br />
`cd ~/.vim/bundle && git clone git://github.com/wakatime/vim-wakatime.git`
2015-04-10 02:08:56 +00:00
3. Enter your [api key](https://wakatime.com/settings#apikey), then press `enter`.
2013-06-25 07:57:15 +00:00
4. Use Vim and your coding activity will be displayed on your [WakaTime dashboard](https://wakatime.com).
2013-06-26 23:35:25 +00:00
2015-09-26 18:44:19 +00:00
Note: WakaTime depends on [Python](http://www.python.org/getit/) being installed to work correctly.
2013-06-26 23:35:25 +00:00
Screen Shots
------------
2016-03-21 00:48:11 +00:00
![Project Overview](https://wakatime.com/static/img/ScreenShots/Screen-Shot-2016-03-21.png)
2015-02-13 03:19:40 +00:00
Configuring
-----------
2017-05-24 13:39:56 +00:00
#### Custom Commands:
* `:WakaTimeApiKey` - 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
* `:WakaTimeScreenRedrawEnableAuto` - redraw screen when plugin takes too long
2017-05-24 13:39:56 +00:00
* `:WakaTimeScreenRedrawDisable` - disable screen redraw for performance
#### Vimrc Settings:
2015-02-13 03:19:40 +00:00
let g:wakatime_PythonBinary = '/usr/bin/python'
2017-05-24 13:39:56 +00:00
Tells the plugin to use a custom python binary.
2015-02-13 03:19:40 +00:00
The default is to use `python` from your system PATH.
#### WakaTime Settings:
2017-05-24 13:39:56 +00:00
Add this line to your `~/.wakatime.cfg` file to modify your screen redraw setting:
vi_redraw = enabled
2017-05-24 13:39:56 +00:00
Enables redrawing the screen after sending heartbeats, to prevent screen artifacts in case a key was pressed while the plugin executed.
Valid values for `vi_redraw` are `enabled`, `auto`, and `disabled`.
2017-05-24 13:39:56 +00:00
Other WakaTime plugins also share this `~/.wakatime.cfg` file. [See all configs...][wakatime-cli-config]
2017-04-22 20:58:32 +00:00
Troubleshooting
---------------
2017-04-22 21:00:33 +00:00
Run `:WakaTimeDebugEnable` in Vim then run this Terminal command:
`tail -f ~/.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.log`.
2017-04-22 21:04:34 +00:00
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.log` and editing files in Vim.
With Debug Mode enabled, the plugin sends data synchronously so disable it when finished debugging with `:WakaTimeDebugDisable`.
2017-04-22 20:58:32 +00:00
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].
2015-04-08 22:42:14 +00:00
Uninstalling
------------
Remove `Bundle 'wakatime/vim-wakatime'` from your `.vimrc` file, then delete your `~/.wakatime.cfg` config file.
2017-04-22 20:58:32 +00:00
[wakatime-cli]: https://github.com/wakatime/wakatime
[wakatime-cli-config]: https://github.com/wakatime/wakatime#configuring
[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