vbauerster / kamp Goto Github PK

View Code? Open in Web Editor NEW

7.0 6.0 3.0 307 KB

tool to control Kakoune editor from the command line

License: The Unlicense

Rust 87.26% Shell 12.74%

kakoune plugin

kamp's Introduction

Kamp

Kamp is a tool to control Kakoune editor from the command line.

Installation

From source

Requires Rust installed on your system.

Clone the repository and run cargo install --path .

Kakoune integration

Add following definition into your kakrc.

evaluate-commands %sh{
    kamp init -a -e EDITOR='kamp edit'
}

Provided scripts

The scripts need to be added to $PATH in order to use them.

script	function
`kamp-buffers`	pick buffers (fzf)
`kamp-files`	pick files (fzf)
`kamp-nnn`	pick files (nnn)
`kamp-filetypes`	set filetype (fzf)
`kamp-lines`	search lines in buffer (fzf)
`kamp-sessions`	attach session and pick a buffer
`kamp-grep`	grep interactively with fzf
`kamp-fifo`	pipe stdin into fifo buffer

Kakoune mappings example

Following mappings use tmux-terminal-popup as popup implementation.

alias global popup tmux-terminal-popup
map global normal -docstring 'files'          <c-f> ':connect popup kamp-files<ret>'
map global normal -docstring 'git ls-files'   <c-l> ':connect popup kamp-files backend=git<ret>'
map global normal -docstring 'buffers'        <c-b> ':connect popup kamp-buffers<ret>'
map global normal -docstring 'grep selection' <c-g> ':connect popup kamp-grep "query=%val{selection}"<ret>'
map global normal -docstring 'grep limit by filetype' <c-y> ':connect popup kamp-grep -t %opt{filetype}<ret>'

Shell integration

You may want to set the EDITOR variable to kamp edit so that connected programs work as intended:

export EDITOR='kamp edit'

Some useful aliases:

alias k='kamp edit'
alias kval='kamp get val'
alias kopt='kamp get opt'
alias kreg='kamp get reg'
alias kcd-pwd='cd "$(kamp get sh pwd)"'
alias kcd-buf='cd "$(dirname $(kamp get val buffile))"'
alias kft='kamp get opt -b \* -s filetype | sort | uniq' # list file types you're working on

Similar projects

kamp's People

Contributors

Stargazers

Watchers

Forkers

jtrv demostanis zickzackv

kamp's Issues

make `kamp edit` accept stdin like `kak`

it would be great to have kamp edit accept stdin in the same way that kak does

Investigate options for 'Daemonized' sessions

I would like to investigate options for 'daemonizing' kakoune sessions through kampliment in order to improve the startup time of kamp edit.

My current proposal for this functionality would be to add the following in kampliment

An option to behave similar to the functionality of the useGitDirSessions implementation in kks, this would also include a boolean environment variable KAMP_USE_GITDIR_SESSIONS that works in the same way.
An option to behave similar to the functionality of the defaultSessions implementation in kks, this would also include a boolean environment variable KAMP_DEFAULT_SESSION that works in the same way.
Alternatively a kampliment.toml etc might be useful if we intend to add more configuration options to kampliment in the future.

`kamp edit` with no argument should open a scratch buffer

I often use kak or kcr edit without arguments to open a scratch buffer and manipulate text from the system clipboard, however kampliment currently does not allow this.

Weird behavior when implementing kamp-filetypes, kamp-lines

In this commit I tried to implement kamp-filetypes and kamp-lines based on kks-filetypes and kks-lines, however I ran into some weird behavior.

When I try :connect terminal <ret> and then run kamp-lines or kamp-filetypes in the terminal it works as expected, however if I try :connect terminal kamp-lines<ret> or :connect terminal kamp-filetypes<ret> fzf appears in the terminal without a list.

`kamp edit` opens an extra buffer when only one file is provided

When using kamp edit with a single argument, a secondary empty buffer is opened.
i.e. kamp edit tmp/index.html

the empty buffer does not seem to appear if I pass in more files
i.e. kamp edit tmp/index.html tmp/index.js

If I remove kampliment from my configuration this behavior does not persist so I am assuming this is an issue with kampliment.