joeDespres / perma

RStudio addin to create and manipulate github perma-links

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

perma

An Rstudio addin to create shareable github perma links.

For instance this perma link: https://github.com/joeDespres/perma/blob/9b62543054ab4e1c9e6ea60da69458c3cdcb973e/tests/testthat/test-link-creation.R#L3-L5. Will take you directly to line 3-5 of a test file. I find it to be a great way to refer a collaborator to specific code snippets in a repo.

Inspired by gitlinker

Getting Started

devtools::install_github("joeDespres/perma")

Demos

Open Perma Link In Browser

demo_open_in_browser

Move to Perma Link

demo_move_to_link

Send Link to Console

demo_send_to_console

✅ Create github perma link at cursor: perma_link_to_console
✅ Open github at cursor or selection: perma_open_perma_link
✅ Move cursor to perma link: perma_move_to_link

Recommended key bindings

~/.config/rstudio/keybindings/addins.json
{
    "perma::perma_link_to_console": "Ctrl+`",
    "perma::perma_move_to_link": "Ctrl+T",
    "perma::perma_open_perma_link": "Ctrl+G"
}

Note this is a work in progress so this is lacking quite a bit of polish.

About

RStudio addin to create and manipulate github perma-links

License:MIT License


Languages

Language:R 100.0%