Skip to main content

No project description provided

Project description

Tests PyPI Codecov

kak_plugins

Zach's plugins for the Kakoune text editor.

Installation

I recommend using pipx for installation. It allows you to install python packages on your machine in separate virtual environments without having to manage the virtual environments yourself. pip also works if you prefer that.

pipx install kak_plugins

Dependencies

  • Kakoune of course
  • kakoune.cr
    • enables us to retrieve info from Kakoune
    • provides an interface to control Kakoune
  • A clipboard command-line utility. I use these:
    • pbcopy for OSX
    • xclip for Linux
    • wl-clipboard for Wayland (if you don't know what this is and you use Linux, you'll probably use xclip)

Setup

There are some environment varibles you will need to define in order to use these plugins. You would probably define these in your ~/.bashrc, zshrc, or ~/.profile. I define mine [here](https://github.com/abstractlyZach/dotfiles/blob/master/common/.profile]

# program that reads stdin and writes to your system clipboard
export CLIPBOARD="pbcopy"

Logging

Logs are a good way of getting an idea of what's going on in the code. Logs will be written in a temporary directory in a file that has the name of the plugin. See here for rules on where you can find logs on your system

Plugins

github-permalink

Create a permalink to a line or range of lines in a GitHub repo that matches your current selection in Kakoune. Then copy that permalink to your clipboard program.

  1. open a file in Kakoune
  2. make a selection
  3. in normal mode, type :$ github-permalink
  4. you now have a permalink to your kakoune selection. it should look something like this https://github.com/abstractlyZach/kak_plugins/blob/write-readme/README.md#L40

I like binding this command to hotkeys so I can hit 2 buttons and then paste the link into Slack or something.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kak_plugins-0.4.0.tar.gz (5.5 kB view hashes)

Uploaded Source

Built Distribution

kak_plugins-0.4.0-py3-none-any.whl (6.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page