Skip to content

derekthecool/plover-tapey-tape.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

plover-tapey-tape.nvim

A neovim plugin to help display your latest output from the plover tapey tape Plover stenography plugin.

Plugin Modes

There are two modes that this plugin can work with:

  1. Status line showing the last line of output
  2. Buffer split showing live updates and more than one line of output

Install

Requires neovim version 0.8.0

Install With Packer

use('derekthecool/plover-tapey-tape.nvim')

install With Vim Plug

Plug 'derekthecool/plover-tapey-tape.nvim'

Setup And Usage

Call the setup function with your desired settings.

require('plover-tapey-tape').setup() -- Use all default settings

require('plover-tapey-tape').setup({ -- Use custom settings (defaults are shown)
    filepath = 'auto',
    open_method = 'vsplit',
    vertical_split_height = 9,
    horizontal_split_width = 54,
    steno_capture = '|(.-)|',
    suggestion_notifications = {
        enabled = true,
    },
    status_line_setup = {
        enabled = true,
        additional_filter = '(|.-|)',
    },
}

Statusline Setup

If the status_line_setup feature is enabled then you can access the global lua variable TapeyTape.

If you use lualine.nvim you can put global variables into your settings easily.

lualine_c = {'TapeyTape'},

TODO: show how to add to status line without lualine.

Suggested Mappings

No mappings are set by the plugin. Here are some suggested mappings for available commands.

vim.keymap.set('n', '<leader>tt', require('plover-tapey-tape').toggle) -- open tape window
vim.keymap.set('n', '<leader>ts', require('plover-tapey-tape').stop) -- stop plugin

Screenshots

Status line and vertical split

This demo shows the following features:

  • Running the toggle command to open the tape window
  • Status line showing the steno keys from the variable TapeyTape
  • Suggestions pop up notifications. When I write good morning 4 suggestions are displayed.

asciicast

Implemented Features

  • Enable auto discovery of tapey-tape log file. Supports Linux, WSL, Windows, Mac.
  • Draw a steno keyboard in realtime that show your keys highlighted
  • Show notifications for suggestions
  • Autocommand to close file watcher when neovim is closing
  • Autocommand to disable autoscrolling when inside tapey-tape log buffer
  • Autocommand to enable autoscrolling when outside tapey-tape log buffer

About

Neovim plugin for plover plugin plover-tapey-tape

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages