https://github.com/nagy135/typebreak.nvim

Quick type exercise in floating buffer
https://github.com/nagy135/typebreak.nvim

Last synced: 13 days ago
JSON representation

Quick type exercise in floating buffer

• Host: GitHub
• URL: https://github.com/nagy135/typebreak.nvim
• Owner: nagy135
• Created: 2021-12-09T17:10:34.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-13T14:02:43.000Z (11 months ago)
• Last Synced: 2024-08-01T22:54:09.214Z (3 months ago)
• Language: Lua
• Size: 892 KB
• Stars: 31
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# typebreak.nvim

![](https://tokei.rs/b1/github/nagy135/typebreak.nvim?category=code)

![screen](doc/header_screen.png)

Summary stats



Take a brief break from current work and use it to speed up your typing speed.

# Install

use your favorite plugin manager to install with [plenary](https://github.com/nvim-lua/plenary.nvim) as dependency:

Plug

```viml

Plug 'nagy135/typebreak.nvim'

Plug 'nvim-lua/plenary.nvim'

```

Packer

```lua

use { 'nagy135/typebreak.nvim', requires = 'nvim-lua/plenary.nvim' }

-- with binding

use { 'nagy135/typebreak.nvim',

    requires = 'nvim-lua/plenary.nvim',

    config = function()

        vim.keymap.set('n', 'tb', require('typebreak').start, { desc = "Typebreak" })

    end

}

```

# Usage

Bind it first! (using setup section bellow), doesnt bind to anything by default.

Pressing bind opens new floating window with words and puts you in insert mode.

You can instantly start typing and words are getting highlighted as you type them, then dissapear.

Once you type them all, you see summary prompt with stats and option to play again.

Close the window whenever you want ctrl + w, q

# Setup

Bind start function to some key

``` viml

nnoremap tb :lua require("typebreak").start()

```

```lua

vim.keymap.set('n', 'tb', require('typebreak').start, { desc = "Typebreak" })

```

# Custom dictionary

There is also option to NOT use [herokuapp](https://random-word-api.herokuapp.com/word?number=10) for fetching words.

By default we use it but if you wanna use local dictionary instead, you need to do following:

First you simply pass true to start function

```lua

require("typebreak").start(true)

```

Or better, bind it

```lua

vim.keymap.set('n', 'tb', function() require('typebreak').start(true) end, { desc = "Typebreak (local dictionary)" })

```

```viml

nnoremap tb :lua require("typebreak").start(true)

```

This uses 200 words long dictionary shipped with plugin.

If you want to extend or replace those words you need to call `setup()` any time before calling `start()`

```lua

require('typebreak').setup({

    ["dictionary"] = {"tik", "tak", "toe"},

    -- also boolean flag if you want to replace default ones with your own only

    -- ["replace_dictionary"] = true

})

```