weyaaron / nvim-training Goto Github PK

Problem statement

This issue is a hub for the planned tasks and their status.

Currently in the pipeline

Deletion

• Delete multiple Words
• Delete with the use of registers
• Delete with marks

Movements

• b
• W
• B
• e (Included in Release 0.2)
• f
• t
• Search (Included in Release 0.2)
• A
• 0
• %
• F,T

Buffer

• Open
• Close
• Switch

Window

• Open
• Close
• Switch

Misc

• Pasting
• x

Solution

Get working on these tasks.

Draft

Open Questions/Concerns

No response

The current documentation is rather sparse. The following are priorities:

• The Task Class and its interface
• How to contribute
• Tags and their use cases
• Some basics of the training session workflow

This has two points:

• Write a short guide on the formation of a pr and best practices
• Adjust the readme to include a freeze of the plugin to a specific commit/tag/version ...

The move to mark task is already implemented, but buggy at the moment. This has to be investigated and fixed.

          > And I am unsure if the movement belongs to the task at all. Maybe its best to stick to the word at the cursor instead of requiring some additional steps.

I see your point. The extension could offer both granular tasks for individual commands and composite tasks for more realistic editing scenarios. I believe navigating to a word and copy it is a fundamental operation in the daily use and lies somewhere in between. We could consider renaming the current task to better reflect its intermediate nature, to address your concerns.

Originally posted by @mertovun in #11 (comment)

I have mixed feelings on this. But I am open to include this example and go from there. One of my concerns is, that the codebase is not designed with composite tasks in mind. Therefore, inclusion of these tasks might prove challenging.

This code is all about improving the habits of beginners. Maybe the vimtutor can inspire some new tasks.

Currently, there is some code that uses tags, but it is not run and probably buggy.
The open tasks include:

• Activate and test the function that selects tasks based on tags
• Include tag config in the config
• Consistently apply the current tags
• Document their existence and how to use the config

Currently, I just link to their profile. This could be improved on, for example by rendering their avatar.

This is placed in the distant future, because it involves a lot of work and I consider it not essential.

This repo already contains some code that allows for audio feedback. However, this should be something users can opt into. Once this can be done by altering the config, the accompanying code may be written.

This function should allow users to configure some aspects of the plugin. In particular, the following has to be done:

• Expose a function to the users
• Create a data-structure that contains the values
• Implement the code that interacts with the config
• Document it