Skip to content

Breaking changes v1.0

Jump to bottom
MarcusZ edited this page May 13, 2021 · 2 revisions

After using this plugin for a week in my day-to-day life as a software developer, I have decided to add some new features and also some form of customization support.

Feature added

  1. I have decided to add a git-specific workbench. The reason being that in actual work, there are quite a number of back-and-forths making the project-specific workbench super cluttered. It contains high-level notes and also tasks that I am working on in different branches simultaneously. Therefore, a git branch specific workbench is added so that all the notes and tasks stay at where it belongs to :) To enable branch-specific workbench simply add the key mapping below.
nmap <leader>bb <Plug>ToggleBranchWorkbench
  1. Note that, for existing users, I have renamed the previous key binding (the old one is still in the code, so you shouldn't have any problems even if you don't change to the new one)
nmap <leader>bp <Plug>ToggleProjectWorkbench
  1. Added support to set your own path to store all the markdown files (Look at README on how to set a custom path)
  2. Added support to set the border for the workbench (Look at README on what's the available option)
  3. Combined the function to add or toggle checkbox.
" No longer need another mapping to add a checkbox on a line
" The mapping below does the job for you by adding or toggling the checkbox
nmap <leader><CR> <Plug>WorkbenchToggleCheckbox

Breaking changes

  1. I decided to have a higher-level folder to store all the nvim-workbench related folders.
  2. You can now specify your own path as well, check out README to see how to set your own path
  3. Previously, all nvim-workbench related folders are stored inside ~/.cache directory
    • If you have 2 projects using nvim-workbench, then you will see the file structure as follow
    • ~/.cache/project1/ and ~/.cache/project2/
  4. Now, the default path will be ~/.cache/workbench/. (I personally feel that it is easier to maintain everything inside one directory)
    • So you will see the new file structure as follow
    • ~/.cache/workbench/project1/ and ~/.cache/workbench/project2/
  5. Unfortunately, you have to manually move all your existing projects' workbench directories accordingly to your custom path or the default ~/.cache/workbench/
Clone this wiki locally