🚀 typing-metrics.nvim

🚨 heavily WIP !! 🚨

typing-metrics.nvim is a lightweight, efficient plugin for Neovim that helps you track your typing speed in real-time. Designed to be unobtrusive, customizable, and user-friendly, it's an ideal tool for developers looking to monitor and improve their typing efficiency.

🛣️ Feature Roadmap

• Statusbar widget
• Realtime display options (Popup, virtual text/hover (virtual is maybe unfeasable?))
• Buffer Statistics (track stats for each file)
• Session Statistics (track stats for a 'session'/instance of nvim)
• Setup Language/file-type based segregation of stats
• Save stats to a database

📖 Overview

Neovim Typing-Speed Tracker offers a seamless experience for monitoring your typing speed and accuracy, empowering you to enhance your typing skills right within your favorite editor.

🛠️ Installation

Install the Typing-Speed Tracker using your preferred Neovim package manager:

Using Packer

use {'JakobSachs/typing-metrics.nvim'}

Using Vim-Plug

Plug 'JakobSachs/typing-metrics.nvim'

📚 Usage

After installation, the plugin will automatically begin tracking your typing speed when you open a buffer. Explore these commands for additional functionality:

• :Example - To be determined...

⚙️ Configuration

Tailor the plugin's behavior to your liking with these settings in your init.vim or init.lua:

-- Example configuration in Lua
require('typing-metrics').setup({
    -- Default config values
    word_length = 5, -- average word length
    update_interval = 500, -- sample time in milliseconds
    average_size = 3, -- number of samples to keep for average calculation
    target_wpm = 60, -- speed to show full bar
    bar_direction = "vertical", -- or horizontal
})

✨ Contributing

Your contributions are welcome! Whether it's fixing bugs, improving documentation, or suggesting new features, we value your input.

📄 License

This project is licensed under the AGPL-3.0 license - see the LICENSE file for details.