|
1 | | -# booker README |
| 1 | +# Booker |
2 | 2 |
|
3 | | -This is the README for your extension "booker". After writing up a brief description, we recommend including the following sections. |
| 3 | +## WIP |
4 | 4 |
|
5 | | -## TODOS |
6 | | - |
7 | | -- [ ] delete mark |
8 | | -- [ ] ORDER MARKS |
9 | | -- [ ] figure out when to change saved position for the mark |
10 | | -- [ ] figure out how to use vscode datastorge to store information for the extension per workspace |
11 | | -- [ ] search can we make generic commands like for example send index with the command(deal with the command as function) |
| 5 | +extension inspired by [ThePrimeagen/harpoon](https://github.com/ThePrimeagen/harpoon), it gives you the ability to mark files to move between them blazingly fast, so simply move between files with the lsp then return to the important ones -without fuzzy finder- again blazingly fast! |
12 | 6 |
|
13 | 7 | ## Features |
14 | 8 |
|
15 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 9 | +- marks per workspace |
16 | 10 |
|
17 | | -For example if there is an image subfolder under your extension project workspace: |
| 11 | +- mark active file `booker.mark.add` |
18 | 12 |
|
19 | | -\!\[feature X\]\(images/feature-x.png\) |
| 13 | +- remove the mark from active file `booker.mark.remove` |
20 | 14 |
|
21 | | -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. |
| 15 | +- show all marked files through vscode quickPick `booker.mark.show` |
22 | 16 |
|
23 | | -## Requirements |
| 17 | +- hard coded jumps |
24 | 18 |
|
25 | | -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
| 19 | + - jump to file at index 0 `booker.mark.jump1` |
26 | 20 |
|
27 | | -## Extension Settings |
| 21 | + - jump to file at index 0 `booker.mark.jump2` |
| 22 | + |
| 23 | + - jump to file at index 0 `booker.mark.jump3` |
| 24 | + |
| 25 | +## TODOS |
28 | 26 |
|
29 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
| 27 | +- [x] delete mark |
30 | 28 |
|
31 | | -For example: |
| 29 | +- [ ] user should be able to reoreder the marks through some UI |
32 | 30 |
|
33 | | -This extension contributes the following settings: |
| 31 | +- [x] figure out how to use vscode datastorge to store information for the extension per workspace |
| 32 | + |
| 33 | +- [ ] global marks |
| 34 | + |
| 35 | +## Requirements |
| 36 | + |
| 37 | +If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
| 38 | + |
| 39 | +## Extension Settings |
34 | 40 |
|
35 | | -- `myExtension.enable`: Enable/disable this extension. |
36 | | -- `myExtension.thing`: Set to `blah` to do something. |
| 41 | +### vscodevim keybindings example |
| 42 | + |
| 43 | + ```json |
| 44 | + { |
| 45 | + "before": ["<leader>", "a"], |
| 46 | + "commands": ["booker.mark.add"] |
| 47 | + }, |
| 48 | + { |
| 49 | + "before": ["<leader>", "r"], |
| 50 | + "commands": ["booker.mark.remove"] |
| 51 | + }, |
| 52 | + { |
| 53 | + "before": ["<leader>", "1"], |
| 54 | + "commands": ["booker.mark.jump1"] |
| 55 | + }, |
| 56 | + { |
| 57 | + "before": ["<leader>", "2"], |
| 58 | + "commands": ["booker.mark.jump2"] |
| 59 | + }, |
| 60 | + { |
| 61 | + "before": ["<leader>", "3"], |
| 62 | + "commands": ["booker.mark.jump3"] |
| 63 | + } |
| 64 | + ``` |
37 | 65 |
|
38 | 66 | ## Known Issues |
39 | 67 |
|
|
0 commit comments