mirror of
https://github.com/ThePrimeagen/harpoon.git
synced 2025-07-13 17:40:25 +00:00
feat(updated)
This commit is contained in:
parent
a0817c7271
commit
8d79e5bfb8
59
README.md
59
README.md
@ -23,64 +23,11 @@ Plug 'ThePrimeagen/harpoon'
|
||||
```
|
||||
|
||||
## Harpooning
|
||||
|
||||
### The Basics
|
||||
Harpoon provides up to 4 slots for terminals. Now you don't want to overload
|
||||
terminals with everything. I just tend to think about this as project specific
|
||||
tasks. Such as, `yarn lint`, `yarn test`, or some command based off of current
|
||||
file.
|
||||
|
||||
Personally I only use 1 terminal. I have no use for multiple terminals, but it
|
||||
does provide the hooks for that.
|
||||
|
||||
### Navigation
|
||||
To start navigating with Harpoon you simply `:call GotoBuffer(<bufnu>)`. This
|
||||
will create / navigate to the terminal in current buffer.
|
||||
|
||||
`bufnu`: can be a number from 0 - 3. As stated above, there are up to 4 slots.
|
||||
TO BE DETERMINED
|
||||
|
||||
|
||||
### Sending Commands
|
||||
Where Harpoon shines is in local configs.
|
||||
Check out
|
||||
|
||||
To setup a local config (per project) you must have a `.nvimrc` in the root of
|
||||
your project (where you open up vim) and you must have the following sets in your root vimrc.
|
||||
|
||||
|
||||
```
|
||||
set exrc
|
||||
set secure "optional, but it prevents harmful scripts from editing
|
||||
"I don't have this option on
|
||||
```lua
|
||||
```
|
||||
|
||||
#### Local Configuration example
|
||||
For [VimDeathmatch](https://github.com/VimDeathmatch/server) we have a local
|
||||
config for running commands. Here is an example.
|
||||
|
||||
```
|
||||
nnoremap <leader>ce :call SendTerminalCommand(0, "cd ~/personal/VimDeathmatch/server/server && npm run test" . expand("%") . "\n")<CR>
|
||||
```
|
||||
|
||||
1. I have `c` as the start into my local commands.
|
||||
2. e = middle finger, home row on Dvorak. Power finger.
|
||||
3. Setup your own commands
|
||||
|
||||
|
||||
That means when I am in Deathmatch and I want to test my current file I press
|
||||
`<leader>ce` and it will open a terminal if there isn't one opened and execute
|
||||
the commands. I could of made that command a lot better, I was just in a hurry
|
||||
:) Forgive me.
|
||||
|
||||
#### General Navigation examples
|
||||
Personally I have the following remaps in my root rc.
|
||||
|
||||
```
|
||||
nmap <leader>tu :call GotoBuffer(0)<CR>
|
||||
nmap <leader>te :call GotoBuffer(1)<CR>
|
||||
nmap <leader>to :call GotoBuffer(2)<CR>
|
||||
nmap <leader>ta :call GotoBuffer(3)<CR>
|
||||
```
|
||||
|
||||
Same concept as before. `t` is my entrence into the terminal world and aoeu is
|
||||
my homerow. All power positions.
|
||||
|
||||
|
6
TODO.md
6
TODO.md
@ -1,11 +1,13 @@
|
||||
### Manage A Mark 1.0
|
||||
* Logo
|
||||
* linexcol offset in saved file
|
||||
* (bug) When new files are added, they do start off as absolute paths (their expand("%"))
|
||||
* floating term / split term
|
||||
* TODO: Fill me in, that one really important thing....
|
||||
* README.md
|
||||
|
||||
### Harpoon (upon requests)
|
||||
* Add hooks for vim so that someone can make it for me
|
||||
* ackshual tests.
|
||||
* ackshual tests.
|
||||
* interactive menu
|
||||
* cycle
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user