Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/Weyaaron/nvim-training

A plugin to practice neovim movements, currently in "open beta"
https://github.com/Weyaaron/nvim-training
lua neovim nvim plugin
Last synced: about 1 month ago
JSON representation
A plugin to practice neovim movements, currently in "open beta"
Host: GitHub
URL: https://github.com/Weyaaron/nvim-training
Owner: Weyaaron
License: gpl-3.0
Created: 2023-07-11T12:08:19.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-17T13:47:59.000Z (3 months ago)
Last Synced: 2024-09-17T17:06:42.736Z (3 months ago)
Topics: lua, neovim, nvim, plugin
Language: Lua
Homepage:
Size: 1010 KB
Stars: 34
Watchers: 2
Forks: 3
Open Issues: 4
Metadata Files:
- Readme: Readme.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

awesome-neovim - Nvim-training - A beginner-friendly tool for training your 'muscle memory' using small, repeatable tasks. (Resource / OS-specific)
README

        # nvim-training

[![License: GPL](https://img.shields.io/badge/License-GPL-brightgreen.svg)](https://opensource.org/license/gpl-3-0/)

This code implements a Neovim Plugin for training your muscle memory.

This plugin fills a gap I have noticed during interaction with vim:

Knowing is half the battle, executing another entirely.

This plugin aims to help with the latter.

A training session consists of a series of tasks, each of which is small and easily repeatable.

The plugin will recognize when a task is completed and automatically start the next one.

This helps to work on a lot of tasks in a short amount of time.

The list of tasks is growing all the time, if you miss a particular one you may open a feature request :)

# Some stats of current tasks

- Supported Tasks: 41

- Supported Tasks-Collections: 5

- Supported Schedulers: 3

# In Action

![GIF](media/screencast.gif)

# Installation

Install it using the plugin manager of your choice.

[Lazy](https://github.com/folke/lazy.nvim) is tested,

if any other fails, please open an issue. Pinning your local installation to a fixed version is encouraged.

In Lazy, a possible setup might be:

```lua

local lazy = require("lazy")

local plugin_list = {

    -- Your various other plugins ..

    {"https://github.com/Weyaaron/nvim-training", pin= true, opts = {}} -- Support for configuration with opts is included, see below for the options

}

lazy.setup(plugin_list)

```

# Commands

This plugin uses subcommands of `Training` to activate certain functions.

All of these commands support completion, just use `Tab` and you will be fine.

Currently, these are the available options:

| Name | Syntax | Description |

| --- | -------- | -------- |

| Start | `:Training Start [Scheduler] [Task-Collection A] [Task Collection B] ...`| Starts a session with the choosen scheduler and the choosen task collections. Both arguments are optional. |

| Stop | `:Training Stop`| Stops a session. |

| Analyze | `:Training Analyze`| Prints some statistics about your progress. |

Some care is taken to avoid overwritting your files, but just to be

safe you may start in an empty buffer/directory.

# All tasks

| Name | Description | Tags | Notes

| --- | -------- | -------- | -------- |

|AppendChar | Insert a char next to the cursor. | append, insertion, change |

|BlockCommentLine | Change the current line into a block comment. | change, plugin, programming, comment | This assumes the use of a plugin, it is not tested with the buildin-commenting-feature. |

|ChangeWord | Change text using w,c. | horizontal, w, word, c, change |

|CommentLine | Change the current line into a single line comment. | change, commenting, plugin, programming | Not available in vanilla-vim, needs plugin. |

|DeleteChar | Delete the current char. | change, char, deletion |

|Deletef | Move using f. | f, horizontal, movement |

|DeleteInsideMatch | Delete inside the current match. | change, inside, match, deletion |

|DeleteLine | Delete the current line. | change, line, deletion |

|DeleteWORD | Delete using 'W'. | movement, word, deletion |

|DeleteWord | Delete using 'w'. | movement, word, deletion |

|Increment | Increment the value at the cursor. | change, char, increment |

|InsertChar | Insert a char at the current position. | char, insertion, change |

|JoinLines | Join the current line with the line below. | J, join, line, change |

|MoveAbsoluteLine | Move to the absolute line. | line, vertical, movement |

|MoveCharsLeft | Move left charwise. | char, h, horizontal, movement |

|MoveCharsRight | Move right charwise. | horizontal, l, movement |

|MoveEndOfFile | Move to the end the file. | end, file, vertical, movement |

|MoveEndOfLine | Move to the end of the current line. | end, horizontal, line, movement |

|MoveF | Move using F. | F, horizontal, movement |

|Movef | Move using f. | f, horizontal, movement |

|MoveLinesDown | Move lines down. | horizontal, k, lines, movement |

|MoveLinesUp | Move lines up. | horizontal, k, lines, movement |

|MoveMatch | Move to the current match. | movement, match |

|Moveo | Enter and leave insert mode below the current line. | insert_mode, linewise, movement, o |

|MoveO | Enter and leave insert mode above the current line. | insert_mode, linewise, movement, O |

|MoveStartOfFile | Move to the start of the file. | file, vertical, start |

|MoveStartOfLine | Move to the start of the current line. | line, movement, start |

|MoveT | Move using T. | T, horizontal, movement |

|Movet | Move using t. | horizontal, t, movement |

|MoveWord | Move using w. | horizontal, w, word, movement |

|MoveWORD | Move using W. | W, WORD, movement |

|MoveWordEnd | Move to the end of the current 'word'. | end, vertical, word, movement |

|MoveWORDEnd | Move to the end of the current 'word'. | end, vertical, word, movement |

|MoveWORDStart | Move Back to the start of 'WORDS'. | horizontal, word, movement |

|MoveWordStart | Move back to the start of 'words'. | horizontal, word, movement |

|Paste | Paste from a given register. | register, Paste |

|paste | Paste from a given register. | register, paste |

|SearchBackward | Search backwards for a target-string. | diagonal, movement, search |

|SearchForward | Search forwards. | forward, movement, search |

|SearchWordBackward | Search backwards for the word at the cursor. | backward, movement, search |

|SearchWordForward | Search forwards for the word at the cursor. | forward, movement, search |

|YankEndOfLine | Yank to the end of the current line. | line, yank, end |

|YankInsideMatch | Yank inside the current match. | inside, match, yank |

|YankIntoRegister | Yank a line into a register. | copy, line, vertical, register |

|YankWord | Yank using w. | counter, horizontal, w, word, yank |

|YankWORD | Yank using W. | counter, horizontal, w, word, yank |

# Task-Collections

The following table lists the available collections. They will grow over

time, for support for custom collections see below.

| Name | Description | Link

| ----------- | -------- | -------- |

| All | All supported tasks. Does involve tasks that are designed with plugins in mind!| [All](/docs/collections/All.md)

| Change | Tasks involving some change to the buffer.| [Change](/docs/collections/Change.md)

| Movements | Tasks involving movement.| [Movements](/docs/collections/Movements.md)

| NonMovements | Tasks not involving movement.| [NonMovements](/docs/collections/NonMovements.md)

| Yanking | Tasks involving yanking| [Yanking](/docs/collections/Yanking.md)

# Schedulers

| Name | Description | Supported Arguments |

| ----------- | -------- | ---- |

| RandomScheduler | The next task is chosen at random. | - |

| RepeatUntilNSuccessScheduler | The current task is repeated until n successes are reached. | repetitions|

| RepeatNScheduler | A task is repeated n-times. | repetitions |

# Configuration

A interface for configuration is provided. These are the default values if you do not change

anything yourself.

```lua

local training = require("nvim-training")

training.configure({ -- All of these options work for 'opts' of lazy as well.

	audio_feedback = true, -- Enables/Disables audio feedback, if enabled, requires the 'sox' package providing the 'play' command.

	base_path = vim.fn.stdpath("data") .. "/nvim-training/", -- The path used to store events.

	counter_bounds = { 1, 5 }, --The outer bounds for counters used in some tasks. WARNING: A high value may result in glitchy behaviour.

	custom_collections = {}, -- A table of tables containing names of tasks, for details read on.

	enable_counters = true, -- Enables/Disables counters in tasks that support counters.

	enable_events = true, -- Enables/Disables events.

	enable_highlights = true, --Enables/Disables highlights. Care is taken to ensure that tasks are possible without them.

	possible_marks_list = { "a", "b", "c", "r", "s", "t", "d", "n", "e" }, -- A list of possible marks.

	possible_register_list = { "a", "b", "c", "r", "s", "t", "d", "n", "e" }, -- A list of possible registers.

	scheduler_args = { repetitions = 5 }, --These args are used to configure all the available schedulers

	task_alphabet = "ABCDEFGabddefg,.", -- The alphabet of targets used in tasks like f,t etc.

})

```

## Custom Collections

To add a custom collection, please use its name as a key for a list of task names in the config, for example like this:

```lua

local training = require("nvim-training")

training.configure({

    -- .. your other configs ...

	custom_collections = { MyCollection = { "MoveWord", "MoveWORD"}}

})

```

You may provide as many collections as you wish, they will be available in autocompletion.

# For beginners

Hi, welcome. Since this plugin is aimed at beginners, I will help out with any

issues about getting started. Just message me over on [email protected]

and I will help you out. Depending on the issue, your feedback may be used

to improve the setup for everyone :)

# Goals

- Ease of use. Starting a session should be seamless. The UI should not get in the way.

- Fast and flow-inducing. There should be no waiting time between tasks and as little friction between tasks as possible.

- (Eventually) Community-driven. Adding new tasks is encouraged, both by providing the interfaces and the documentation required.

- Customizable. Task should be switched on and off with ease, and the difficulty should be adjustable.

# Non-Goals

- Implement puzzles. A solution to the current task should be obvious and small, at most a few keystrokes on a vanilla setup.

- Competing with others. Your progress matters to you, not to others.

- Provide help/guides on how to solve a particular task. Basic familiarity with vim is assumed.

- Constrain the user on how to solve a particular task.

- Support for everyones personal setup. Some settings may mess up some tasks, support for these cases is limited. I try to accomodate about 80% of the users.

# How to get started with contributing

Contributions are welcome! Any input is appreciated, be it a bug report, a feature request, or a pull request.

This is my first project in lua, therefore, some junk and bad practices are to be expected. Any feedback/suggestions

are appreciated.

# Best Practices for contributing

- Please open the PR to the branch named 'dev'. This ensures that there will be some buffer between the stable main and the current

development version.

- Opening a issue first is encouraged to discuss any ideas. This helps to avoid duplicate work and to get feedback early on.

- You may have a look at [dev-setup](/docs/dev_setup.md) which describes a setup that increases productivity

in development.

# [License](/LICENSE)

[GPL](LICENSE)